@quesmed/types 1.5.6 → 1.6.0

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

@@ -0,0 +1,21 @@
+import { IQuestion } from './Question';
+import { ETopicType } from './Topic';
+import { Id } from './Type';
+export interface IMockTest {
+    id: Id;
+    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;
+}
+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: IOsceTypeDashboard[];
+    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,52 @@
+import { EDifficultyType } from './Difficulty';
+import { IOsceActorPicture, IOsceCandidatePicture, IOsceExaminerPicture, IOsceWalkthroughPicture } from './Picture';
+import { ITopic } from './Topic';
+import { Id } from './Type';
+import { IVideo } from './Video';
+export interface IOsceType {
+    id: Id;
+    name: string;
+}
+export interface IOsceStationMark {
+    id: Id;
+    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?: IOsceCandidatePicture[];
+    actorPictures?: IOsceActorPicture[];
+    examinerPictures?: IOsceExaminerPicture[];
+    walkthroughPictures?: IOsceWalkthroughPicture[];
+    videos?: IVideo[];
+}
+export interface IOsceStationItem extends IOsceStation {
+    lastOsceMarksheetId: Id;
+    score: number;
+}
+export declare const OSCE_GLOBAL_RATING: {
+    [key: number]: string;
+};

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

@@ -0,0 +1,47 @@
+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;
+}
+export interface IQuestionPicture {
+    id: Id;
+    pictureId: Id;
+    questionId: Id;
+    choiceId: Id | null;
+    picture: IPicture;
+}
+export interface ICardPicture {
+    id: Id;
+    pictureId: Id;
+    cardId: Id;
+    picture: IPicture;
+}
+export interface IChapterPicture {
+    id: Id;
+    pictureId: Id;
+    chapterId: Id;
+    picture: IPicture;
+}
+export interface IOscePicture {
+    id: Id;
+    osceStationId: Id;
+    pictureId: Id;
+    picture: IPicture;
+}
+export interface IOsceCandidatePicture extends IOscePicture {
+}
+export interface IOsceActorPicture extends IOscePicture {
+}
+export interface IOsceExaminerPicture extends IOscePicture {
+}
+export interface IOsceWalkthroughPicture extends IOscePicture {
+}

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,90 @@
+import { IConcept } from './Concept';
+import { EDifficultyType } from './Difficulty';
+import { IQuestionPicture } from './Picture';
+import { Id } from './Type';
+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 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: IQuestionPicture[];
+    difficulty: EDifficultyType;
+    elo: number;
+    psaSectionId: EPsaSectionType;
+}
+export interface IQuestionChoice {
+    id: Id;
+    name: string;
+    explanation: string | null;
+    label: string;
+    answer: boolean;
+    votes: number;
+}
+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/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
+}

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

@@ -0,0 +1,24 @@
+import { ICard } from './Card';
+import { Id } from './Type';
+export interface ITodo {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    userId: Id;
+    dailyTask: boolean;
+    marks: ITodoMark[];
+    source: string;
+}
+export interface ITodoMark {
+    id: Id;
+    todoId: Id;
+    cardId: Id;
+    card: ICard;
+    score: number;
+    timeTaken: number;
+}
+export interface IPreBuildTodo {
+    unseen: number;
+    seen: number;
+    buildRef: number;
+}

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

@@ -0,0 +1,7 @@
+import { Id } from './Type';
+export interface IToken {
+    id: Id;
+    userId: Id;
+    token: string;
+    deviceId: string;
+}

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

@@ -0,0 +1,17 @@
+import { IConcept } from './Concept';
+import { Id } from './Type';
+export declare enum ETopicType {
+    ALL = 0,
+    BASIC_SCIENCE = 1,
+    CLINICAL = 2,
+    ANATOMY = 3,
+    DATA_INTERPRETATION = 4,
+    PSA = 5,
+    OSCE = 6
+}
+export interface ITopic {
+    id: Id;
+    name: string;
+    typeId: ETopicType | null;
+    concepts?: IConcept[];
+}

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

@@ -0,0 +1,7 @@
+export declare type Id = number;
+export declare type Count = {
+    count: string;
+};
+export declare type Sum = {
+    sum: string;
+};

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

@@ -0,0 +1,5 @@
+export interface IUniversity {
+    id: number;
+    name: string;
+    country: string;
+}

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

@@ -0,0 +1,105 @@
+import { ICard } from './Card';
+import { IConcept } from './Concept';
+import { IMarksheetMark } from './Marksheet';
+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 {
+    PRECLINICAL = 0,
+    CLINICAL = 1
+}
+export declare const classYearGroup: {
+    [key: string]: EClassYearGroup;
+};
+export interface IPayload {
+    id: Id;
+    displayName: string;
+    firstName: string;
+    lastName: string;
+    username: string;
+    accessLevel: IAccessLevel;
+    tocAccepted: boolean;
+    exp: number;
+    stripeSubscriptionEndDate: number | null;
+    stripeQBankSubscriptionEndDate: number | null;
+    stripeOsceSubscriptionEndDate: number | null;
+    stripeBundleSubscriptionEndDate: number | null;
+}
+export interface IUser {
+    id: Id;
+    displayName: string;
+    username: string;
+    firstName: string;
+    lastName: string;
+    tocAccepted: boolean;
+    dailyFeedResetTime: number;
+    dailyFeedMax: number;
+    classYear: IClassYear;
+    graduationYear: number;
+    universityId: number;
+    examDate: number | Date | null;
+    stripeCustomerId: string;
+    qBankSubscriptionId: Id | null;
+    qBankSubscription: ISubscription | null;
+    stripeQBankSubscriptionEndDate: number | Date | null;
+    osceSubscriptionId: Id | null;
+    osceSubscription: ISubscription | null;
+    stripeOsceSubscriptionEndDate: number | Date | null;
+    bundleSubscriptionId: Id | null;
+    bundleSubscription: ISubscription | null;
+    stripeBundleSubscriptionEndDate: number | Date | null;
+    subscriptionId: Id | null;
+    subscription?: ISubscription | null;
+    stripeSubscriptionEndDate: number | Date | null;
+    stripePriceNickname: string | null;
+}
+export declare function currentClassYear(createdAtUnix: number, classYear: IClassYear): IClassYear;
+export declare function currentClassGroup(createdAtUnix: number, classYear: IClassYear): EClassYearGroup;
+export interface IUserCompletedQuestions {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    questionId: Id;
+    userId: Id;
+    correct: boolean;
+    question: IQuestion;
+    topic: ITopic;
+    concept: IConcept;
+}
+export interface IUserCompletedCards {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    cardId: Id;
+    card: ICard;
+    userId: Id;
+    topic: ITopic;
+    concept: IConcept;
+    lastSeen: number | Date;
+    score: number;
+    iteration: number;
+    optimalFactor: number;
+}
+export interface IUserFlaggedQuestions {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    questionId: Id;
+    question: IQuestion;
+    userId: Id;
+    markId: Id;
+    mark: IMarksheetMark;
+}
+export interface IUserProgress {
+    id: Id;
+    date: number | Date;
+    userId: Id;
+    topicId: Id;
+    count: number;
+    correct: number;
+    countCards: number;
+}

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

@@ -0,0 +1,25 @@
+import { IConcept } from './Concept';
+import { IFile } from './File';
+import { IOsceStation } from './OsceStation';
+import { Id } from './Type';
+export interface IVideo {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    startTime: number | Date;
+    endTime: number | Date;
+    title: string;
+    museId: string;
+    thumbnail: string;
+    views: number;
+    live: boolean;
+    description: string;
+    duration: number;
+    concepts: IConcept[];
+    osceStation: IOsceStation;
+    files: IFile[];
+    send1hrPushAt: number | Date | null;
+    sent1hrPushAt: number | Date | null;
+    send24hrPushAt: number | Date | null;
+    sent24hrPushAt: number | Date | null;
+}

package/dist/mjs/models/index.js

@@ -0,0 +1,24 @@
+export * from './Author';
+export * from './Blog';
+export * from './Book';
+export * from './Card';
+export * from './Chapter';
+export * from './Concept';
+export * from './Difficulty';
+export * from './Feedback';
+export * from './File';
+export * from './Marksheet';
+export * from './MockTest';
+export * from './OsceMarksheet';
+export * from './OsceStation';
+export * from './Picture';
+export * from './Promo';
+export * from './Question';
+export * from './Subscription';
+export * from './Todo';
+export * from './Token';
+export * from './Topic';
+export * from './Type';
+export * from './University';
+export * from './User';
+export * from './Video';

package/dist/mjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/mjs/resolvers/apollo.d.ts

@@ -0,0 +1,8 @@
+import { DefaultContext, FetchResult } from '@apollo/client';
+export declare type ApolloUpdateResultRestricted<T> = Omit<FetchResult<{
+    restricted: T;
+}>, 'context'>;
+export interface ApolloUpdateOptions {
+    context?: DefaultContext;
+    variables?: Record<string, any>;
+}

package/dist/mjs/resolvers/fragments/blog.d.ts

@@ -0,0 +1 @@
+export declare const BLOG_POST_FIELDS: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/fragments/chapter.d.ts

@@ -0,0 +1,2 @@
+export declare const CHAPTER_FILE_FIELDS: import("@apollo/client").DocumentNode;
+export declare const CHAPTER_FIELDS: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/fragments/concept.d.ts

@@ -0,0 +1,3 @@
+export declare const CONCEPT_TOPIC_FIELDS: import("@apollo/client").DocumentNode;
+export declare const CONCEPT_FIELDS: import("@apollo/client").DocumentNode;
+export declare const CONCEPT_VIDEO_FIELDS: import("@apollo/client").DocumentNode;

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

@@ -0,0 +1,7 @@
+export * from './blog';
+export * from './chapter';
+export * from './concept';
+export * from './osce';
+export * from './picture';
+export * from './user';
+export * from './video';

package/dist/mjs/resolvers/fragments/osce.d.ts

@@ -0,0 +1,5 @@
+export declare const OSCE_STATION_MARK_FIELDS: import("@apollo/client").DocumentNode;
+export declare const OSCE_STATION_FIELDS: import("@apollo/client").DocumentNode;
+export declare const OSCE_MARKSHEET_MARK_FIELDS: import("@apollo/client").DocumentNode;
+export declare const OSCE_MARKSHEET_FIELDS: import("@apollo/client").DocumentNode;
+export declare const OSCE_MATCHMAKING_ACTION_FIELDS: import("@apollo/client").DocumentNode;