@quesmed/types 1.5.9 → 2.0.0

package/dist/mjs/gql_input_output_types/index.d.ts

@@ -0,0 +1,75 @@
+import { IChapter, Id, IVideo } from '../models';
+import { RegisterUserInput } from '../resolvers/mutation/users';
+export interface TokenI {
+    firstName: string;
+    lastName: string;
+    username: string;
+    iat: number;
+    exp: number;
+}
+export interface UserTopicQuestionsInfo {
+    question: number;
+    correctQuestions: number;
+    incorrectQuestions: number;
+}
+export interface UserTopicCardsInfo {
+    cardCount: number;
+    ConfidentCards: number;
+    ReviewCards: number;
+    LearnCards: number;
+}
+export interface TodoInfo {
+    id: Id;
+    todoId: Id;
+    cardId: Id;
+    question: string;
+    explanation: string;
+    score: number;
+    timeTaken: number;
+    dailyTask: boolean;
+    source: string;
+}
+export interface ISearchConcepts {
+    id: number;
+    name: string;
+    chapter: IChapter;
+    topicId: number;
+    videos: IVideo[];
+}
+export interface IQuesBook {
+    id: number;
+    name: string;
+    concepts: ISearchConcepts[];
+}
+export interface LineItemI {
+    price: string;
+    quantity: number;
+}
+export interface CheckoutSessionArgsI {
+    priceId: string;
+    data: RegisterUserInput;
+}
+export interface IUniversityCalculation {
+    universityId: number;
+    specialityTopicId: number;
+    specialityTopicCorrect: number;
+    totalCorrect: number;
+    totalIncorrect: number;
+    totalCount: number;
+    rank: number;
+}
+export interface IUniversityCalculationMap {
+    [key: number]: IUniversityCalculation;
+}
+export interface IQuestionLike {
+    like: number;
+    dislike: number;
+}
+export interface ICheckoutSessionRes {
+    sessionId: string;
+    tempUserId: number;
+}
+export interface WithError {
+    error: string;
+    isError: boolean;
+}

package/dist/mjs/index.d.ts

@@ -0,0 +1,22 @@
+export * as Models from './models';
+export * from './resolvers';
+export * as utils from './utils';
+export declare const ERRORS: {
+    TOKEN_INVALID: string;
+    TOKEN_MISSING: string;
+    TOKEN_EXPIRED: string;
+    SUBSCRIPTION_EXPIRED: string;
+    PERMISSION_INVALID: string;
+};
+export declare const FCM_TOPICS: {
+    GLOBAL: string;
+    QBANK: string;
+    OSCE: string;
+};
+export declare enum EPlatformId {
+    QBANK = 0,
+    OSCE = 1
+}
+export declare const termsAndConditions = "# Group Study Conduct Policy\n\nAs future clinicians, we expect that you treat your colleagues fairly and with respect.\nAs a result, we will not tolerate the following actions during use of the Quesmed platform:\n\n- Violent threats\n- Wishing, hoping or calling for serious harm on a person or group of people\n- Incitement against individuals or groups\n- Slurs, racist and sexist tropes\n- Degrading others\n- Unwanted sexual advances\n\nWhen determining the penalty for violating our conduct policy, we consider a number of factors including the severity of the violation and the individual's record of violations. We reserve the right to immediately de-activate any account that violates our conduct policy. We may also consider raising concerns to the individual's licensing body (e.g. GMC) on a case-by-case basis.\n\nBy using the platform, you agree to be bound by our conduct policy as described above.";
+export declare const medicalWords: string[][];
+export declare function generateDisplayName(firstName: string, lastName: string): string;

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

@@ -0,0 +1,14 @@
+import { Id } from './Type';
+export interface IAuthor {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    name: string;
+    qualifications: string | null;
+    title: string;
+    description: string;
+    avatar: string;
+    linkedIn: string;
+    twitter: string;
+    facebook: string;
+}

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

@@ -0,0 +1,15 @@
+import { Id } from './Type';
+export interface IBlogTag {
+    id: Id;
+    createdAt: number | Date;
+    name: string;
+}
+export interface IBlogPost {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    title: string;
+    body: string;
+    tags?: IBlogTag[];
+    relatedBlogPosts?: IBlogPost[];
+}

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

@@ -0,0 +1,22 @@
+import { IAuthor } from './Author';
+import { Id } from './Type';
+export interface IBook {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    name: string;
+    publisher: string;
+    publishDate: number | Date;
+    pages: number;
+    format: string;
+    language: string;
+    type: string;
+    ISBN: number;
+    price: number;
+    avatar: string;
+    heroImg: string;
+    description: string;
+    chapters: string | string[];
+    stripePriceId: string;
+    authors: IAuthor[];
+}

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

@@ -0,0 +1,16 @@
+import { IConcept } from './Concept';
+import { IPicture } from './Picture';
+import { ITopic } from './Topic';
+import { Id } from './Type';
+export interface ICard {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    topic: ITopic;
+    conceptId: Id;
+    concept: IConcept;
+    question: string;
+    explanation: string;
+    public: boolean;
+    pictures: IPicture[];
+}

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

@@ -0,0 +1,15 @@
+import { IFile } from './File';
+import { IPicture } from './Picture';
+import { ETopicType } from './Topic';
+import { Id } from './Type';
+import { IVideo } from './Video';
+export interface IChapter {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    explanation: string | null;
+    typeId: ETopicType | null;
+    pictures?: IPicture[];
+    videos?: IVideo[];
+    files?: IFile[];
+}

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

@@ -0,0 +1,15 @@
+import { IChapter } from './Chapter';
+import { ITopic } from './Topic';
+import { Id } from './Type';
+import { IVideo } from './Video';
+export interface IConcept {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    name: string;
+    topicId: Id;
+    topic?: ITopic;
+    chapterId: Id;
+    chapter?: IChapter;
+    videos?: IVideo[];
+}

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

@@ -0,0 +1,6 @@
+export declare enum EDifficultyType {
+    ALL = 0,
+    CORE = 1,
+    CHALLENGING = 2,
+    DIFFICULT = 3
+}

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

@@ -0,0 +1,8 @@
+import { Id } from './Type';
+export interface IFeedback {
+    id: Id;
+    createdAt: number | Date;
+    name: string;
+    feedback: string;
+    university: string;
+}

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

@@ -0,0 +1,10 @@
+import { Id } from './Type';
+export interface IFile {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    title: string;
+    url: string;
+    videoId: Id | null;
+    chapterId: Id | null;
+}

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

@@ -0,0 +1,36 @@
+import { IPrescribeAnswer, IPrescribeMark, IQuestion, IQuestionChoice, IQuestionQAAnswer } from './Question';
+import { Id } from './Type';
+import { IUser } from './User';
+export interface IMarksheet {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    startedAt: number | Date;
+    endedAt: number | Date;
+    topicIds: number[];
+    topicNames?: string[];
+    source: string;
+    userId: Id;
+    user?: IUser;
+    marks: IMarksheetMark[];
+    mockTestId: number | null;
+    correct?: number;
+    incorrect?: number;
+    totalQuestions?: number;
+    isTestMarksheet?: boolean;
+}
+export declare type IMarksheetMarkJSONB = string | [string] | [IQuestionQAAnswer] | [string[], string[]] | [IPrescribeMark] | IPrescribeAnswer | null;
+export interface IMarksheetMark {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    index: number;
+    marksheetId: Id;
+    questionChoiceId: Id | null;
+    questionChoices?: IQuestionChoice;
+    timeTaken: number;
+    flagged: boolean;
+    questionId: Id;
+    question: IQuestion;
+    mark: IMarksheetMarkJSONB;
+}

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

@@ -0,0 +1,22 @@
+import { IQuestion } from './Question';
+import { ETopicType } from './Topic';
+import { Id } from './Type';
+export interface IMockTest {
+    id: Id;
+    createdAt: number | Date;
+    title: string;
+    typeId: ETopicType | null;
+    passingMark: number;
+    public: boolean;
+    questions: IQuestion[];
+}
+export interface IUserMockTest {
+    id: Id;
+    title: string;
+    correct: number;
+    incorrect: number;
+    totalQuestions: number;
+    lastMarksheetId?: Id;
+    lastMarksheetStartedAt?: number | Date;
+    lastMarksheetEndedAt?: number | Date;
+}

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

@@ -0,0 +1,105 @@
+import { IOsceStation, IOsceStationMark, IOsceType } from './OsceStation';
+import { Id } from './Type';
+import { IUser } from './User';
+export interface IOsceMarksheetUser {
+    id: Id | null;
+    createdAt: number | Date | null;
+    osceMarksheetId: Id;
+    userId: Id | null;
+    user: IUser | null;
+    role: EOsceRoles | null;
+}
+export interface IOsceMarksheetMark {
+    id: Id;
+    index: number;
+    mark: boolean;
+    osceMarksheetId: Id;
+    osceMarksheet?: IOsceMarksheet;
+    osceStationMarkId: Id;
+    osceStationMark?: IOsceStationMark;
+}
+export declare enum EOsceRoles {
+    ALL = 0,
+    CANDIDATE = 1,
+    ACTOR = 2,
+    EXAMINER = 3,
+    OBSERVER = 4
+}
+export declare enum EOsceMarksheetAction {
+    PRESTART = 0,
+    START = 1,
+    END = 2,
+    PAUSE = 3,
+    CONTINUE = 4,
+    CONNECT = 5,
+    DISCONNECT = 6,
+    SELECT = 7,
+    LEFT = 8,
+    KICK = 9
+}
+export declare enum EOsceMarksheetState {
+    LOBBY = 0,
+    PRESTART = 1,
+    STATION = 2
+}
+export interface IOsceMarksheet {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    timeTaken: number;
+    osceStationId: Id;
+    osceStation?: IOsceStation;
+    userId?: Id;
+    role?: EOsceRoles;
+    solo: boolean;
+    score: number;
+    globalScore: number;
+    feedback: string;
+    agoraId: string;
+    readingTime: number;
+    stationTime: number;
+    feedbackTime: number;
+    startedAt: number | Date;
+    endedAt: number | Date;
+    pausedAt: number | Date;
+    timeRemaining: string;
+    totalStationTime: string;
+    stageTime: string;
+    stage: EOsceStage;
+    marks: IOsceMarksheetMark[];
+    users: IOsceMarksheetUser[];
+    members: IUser[];
+    state: EOsceMarksheetState;
+    completed: boolean;
+}
+export interface IDashboardOsce {
+    lastAgoraId: string;
+    types: IOsceType[];
+    avgScore: number;
+    completed: number;
+    total: number;
+}
+export interface IOsceTypeDashboard extends IOsceType {
+    completed: number;
+    total: number;
+    avgScore: number;
+}
+export declare enum EOsceTimerState {
+    START = 0,
+    PAUSE = 1,
+    COMPLETED = 2
+}
+export declare enum EOsceStage {
+    READING = 0,
+    STATION = 1,
+    FEEDBACK = 2
+}
+export interface IOsceMarksheetTimer {
+    osceMarksheetId: number;
+    timeRemaining: string;
+    totalStationTime: string;
+    stageTime: string;
+    stage: EOsceStage;
+    state: EOsceTimerState;
+}
+export declare function createTimerPayload(osceMarksheet: Partial<Omit<IOsceMarksheet, 'marks'>>): IOsceMarksheetTimer;

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

@@ -0,0 +1,54 @@
+import { EDifficultyType } from './Difficulty';
+import { IPicture } from './Picture';
+import { ITopic } from './Topic';
+import { Id } from './Type';
+import { IVideo } from './Video';
+export interface IOsceType {
+    id: Id;
+    name: string;
+    completed: number;
+    total: number;
+    avgScore: number;
+}
+export interface IOsceStationMark {
+    id: Id;
+    updatedAt: number | Date;
+    index: number;
+    osceStationId: Id;
+    header: string;
+    name: string;
+}
+export declare enum EOsceType {
+    ALL = 0,
+    HISTORY_TAKING = 1,
+    COMMUNICATION_SKILLS = 2,
+    EXAMINATION = 3,
+    PROCEDURE = 4,
+    INTERPRETATION = 5,
+    ABCDE = 6
+}
+export interface IOsceStation {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    name: string;
+    osceTypeId: Id;
+    osceType?: IOsceType;
+    difficulty: EDifficultyType;
+    candidateBrief: string;
+    examinerBrief: string;
+    actorBrief: string;
+    explanation: string;
+    marks: IOsceStationMark[];
+    topics?: ITopic[];
+    candidatePictures?: IPicture[];
+    actorPictures?: IPicture[];
+    examinerPictures?: IPicture[];
+    walkthroughPictures?: IPicture[];
+    videos?: IVideo[];
+    lastOsceMarksheetId?: Id;
+    score?: number;
+}
+export declare const OSCE_GLOBAL_RATING: {
+    [key: number]: string;
+};

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

@@ -0,0 +1,14 @@
+import { ITopic } from './Topic';
+import { Id } from './Type';
+export interface IPicture {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    name: string;
+    caption: string;
+    path: string;
+    path512: string;
+    path256: string;
+    topicId: Id;
+    topic: ITopic;
+}

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

@@ -0,0 +1,14 @@
+import { Id } from './Type';
+export interface ICoupon {
+    id: Id;
+    createdAt: number | Date;
+    name: string;
+    affiliateId: Id;
+}
+export interface IPromoReport {
+    id: Id;
+    date: number | Date;
+    couponId: Id;
+    userId: Id;
+    subscriptionId: Id;
+}

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

@@ -0,0 +1,115 @@
+import { IConcept } from './Concept';
+import { EDifficultyType } from './Difficulty';
+import { IPicture } from './Picture';
+import { Id } from './Type';
+import { IUser } from './User';
+export declare enum EPsaSectionType {
+    PRESCRIBING = 1,
+    PRESCRIPTION_REVIEW = 2,
+    PLANNING_MANAGEMENT = 3,
+    PROVIDING_INFORMATION = 4,
+    CALCULATION_SKILLS = 5,
+    ADVERSE_DRUG_REACTION = 6,
+    DRUG_MONITORING = 7,
+    DATA_INTERPRETATION = 8
+}
+export declare enum EQuestionType {
+    SINGLE_BEST_ANSWER = 1,
+    QUESTION_ANSWER = 2,
+    MULTIPLE_ANSWERS = 3,
+    PRESCRIPTION_ANSWER = 4
+}
+export declare enum EQuestionLike {
+    NONE = 0,
+    LIKE = 1,
+    DISLIKE = 2
+}
+export interface IQuestionComment {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    userId: Id;
+    user?: IUser;
+    username?: string | null;
+    questionId: number;
+    comment: string;
+    replies?: IQuestionComment[];
+    likes?: number;
+    dislikes?: number;
+    isLikedByMe?: EQuestionLike;
+}
+export declare type IQuestionAnswer = string | [string] | [IQuestionQAAnswer] | [string[], string[]] | IPrescribeAnswer[];
+export declare type IQuestionAll = IQuestion | IQuestionSBA | IQuestionQA | IQuestionMultiQ | IQuestionPrescribe;
+export interface IQuestion {
+    id: Id;
+    typeId: Id;
+    conceptId: Id;
+    public: boolean;
+    concept?: IConcept;
+    question: string;
+    explanation?: string;
+    answer: IQuestionAnswer;
+    totalVotes: number;
+    choices: IQuestionChoice[];
+    pictures?: IPicture[];
+    difficulty: EDifficultyType;
+    elo: number;
+    psaSectionId: EPsaSectionType;
+    likes?: number;
+    dislikes?: number;
+    isLikedByMe?: EQuestionLike;
+    comments?: IQuestionComment[];
+}
+export interface IQuestionChoice {
+    id: Id;
+    name: string;
+    explanation: string | null;
+    label: string;
+    answer: boolean;
+    votes: number;
+    picture?: IPicture | null;
+}
+export declare function isQuestionSBA(data: IQuestionAll): data is IQuestionSBA;
+export interface IQuestionSBA extends IQuestion {
+    answer: [string];
+    sbaAnswer: [string];
+}
+export interface IQuestionQAAnswer {
+    dose: string;
+    units: string;
+}
+export declare function isQuestionQA(data: IQuestionAll): data is IQuestionQA;
+export interface IQuestionQA extends IQuestion {
+    answer: [IQuestionQAAnswer];
+    qaAnswer: [IQuestionQAAnswer];
+}
+export declare function isQuestionMultiQ(data: IQuestionAll): data is IQuestionMultiQ;
+export interface IQuestionMultiQ extends IQuestion {
+    answer: [string[], string[]];
+    multiAnswer: [string[], string[]];
+}
+export declare function isQuestionPrescribe(data: IQuestionAll): data is IQuestionPrescribe;
+export interface IQuestionPrescribe extends IQuestion {
+    answer: IPrescribeAnswer[];
+    prescribeAnswer: IPrescribeAnswer[];
+}
+export declare type IPrescribeAnswerData<T> = {
+    value: T;
+    display: boolean;
+};
+export interface IPrescribeAnswer {
+    drug: IPrescribeAnswerData<string>;
+    dose: IPrescribeAnswerData<number>;
+    units: IPrescribeAnswerData<string>;
+    route: IPrescribeAnswerData<string>;
+    frequency: IPrescribeAnswerData<string>;
+    duration: IPrescribeAnswerData<string>;
+}
+export interface IPrescribeMark {
+    drug: string;
+    dose: number | string;
+    units: string;
+    route: string;
+    frequency: string;
+    duration: string;
+}

package/{models/Question.mjs → dist/mjs/models/Question.js}

@@ -16,6 +16,12 @@ export var EQuestionType;
     EQuestionType[EQuestionType["MULTIPLE_ANSWERS"] = 3] = "MULTIPLE_ANSWERS";
     EQuestionType[EQuestionType["PRESCRIPTION_ANSWER"] = 4] = "PRESCRIPTION_ANSWER";
 })(EQuestionType || (EQuestionType = {}));
+export var EQuestionLike;
+(function (EQuestionLike) {
+    EQuestionLike[EQuestionLike["NONE"] = 0] = "NONE";
+    EQuestionLike[EQuestionLike["LIKE"] = 1] = "LIKE";
+    EQuestionLike[EQuestionLike["DISLIKE"] = 2] = "DISLIKE";
+})(EQuestionLike || (EQuestionLike = {}));
 export function isQuestionSBA(data) {
     return data.typeId === EQuestionType.SINGLE_BEST_ANSWER;
 }

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

@@ -0,0 +1,17 @@
+import { Id } from './Type';
+export interface ISubscription {
+    id: Id;
+    createdAt: number | Date;
+    name: string;
+    description: string | null;
+    price: number;
+    stripePriceId: string;
+    duration: number;
+    public: boolean;
+    typeId: Id;
+}
+export declare enum ESubscriptionType {
+    QBANK = 1,
+    OSCE = 2,
+    BUNDLE = 3
+}