@quesmed/types 2.6.55 → 2.6.57

package/dist/cjs/resolvers/mutation/restricted/questionDiscussion.js

@@ -336,7 +336,8 @@ const optimisticQuestionCommentRemove = (comments, input, parentId) => {
 };
 exports.optimisticQuestionCommentRemove = optimisticQuestionCommentRemove;
 exports.ADD_QUESTION_HIGHLIGHT = (0, client_1.gql) `
-  mutation AddHighlight(
+  ${fragments_1.HIGHLIGHT_FIELDS}
+  mutation AddQuestionHighlight(
     $input: [AddQuestionHighlightInput!]!
     $marksheetId: Int
   ) {
@@ -346,12 +347,7 @@ exports.ADD_QUESTION_HIGHLIGHT = (0, client_1.gql) `
         questionId
         userId
         highlights {
-          start
-          end
-          text
-          part
-          tag
-          color
+          ...HighlightFields
         }
       }
     }

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

@@ -1,8 +1,9 @@
 import { IFile } from './File';
+import { IHighlightNode } from './Highlight';
+import { IUserChapterNote } from './Note';
 import { IPicture } from './Picture';
 import { ETopicType } from './Topic';
 import { Id } from './Type';
-import { IUserChapterNote } from './User';
 export interface IChapter {
     id: Id;
     createdAt: number | Date;
@@ -13,4 +14,5 @@ export interface IChapter {
     pictures?: IPicture[];
     files?: IFile[];
     userNote: null | IUserChapterNote;
+    highlights?: IHighlightNode[];
 }

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

@@ -0,0 +1,29 @@
+import { IChapter } from './Chapter';
+import { IQuestion } from './Question';
+import { Id } from './Type';
+import { IUser } from './User';
+export interface IHighlightNode {
+    start: number;
+    end: number;
+    text: string;
+    color?: string;
+    part?: string;
+    tag?: string;
+}
+export interface IHighlight {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    deletedAt: number | Date;
+    userId?: Id;
+    user?: IUser;
+    highlights?: IHighlightNode[];
+}
+export interface IQuestionHighlight extends IHighlight {
+    questionId?: Id;
+    question?: IQuestion;
+}
+export interface IChapterHighlight extends IHighlight {
+    chapterId?: Id;
+    chapter?: IChapter;
+}

package/dist/mjs/models/Highlight.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,18 @@
+import { IChapter } from './Chapter';
+import { IOsceStation } from './OsceStation';
+import { Id } from './Type';
+export interface IUserNote {
+    id: Id;
+    createdAt: number | Date;
+    updatedAt: number | Date;
+    userId: Id;
+    note: string;
+}
+export interface IUserChapterNote extends IUserNote {
+    chapterId: Id;
+    chapter: IChapter;
+}
+export interface IUserStationNote extends IUserNote {
+    stationId: Id;
+    station: IOsceStation;
+}

package/dist/mjs/models/Note.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,5 +1,6 @@
 import { IConcept } from './Concept';
 import { EDifficultyType } from './Difficulty';
+import { IUserStationNote } from './Note';
 import { IPaceScore } from './Paces';
 import { IPicture } from './Picture';
 import { IEntitlement } from './Product';
@@ -70,6 +71,7 @@ export interface IOsceStation {
     score?: number;
     status?: EUserLearningStatus;
     demo?: boolean;
+    userNote: null | IUserStationNote;
 }
 export interface IOsceStationTopic {
     id: Id;

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

@@ -1,6 +1,7 @@
 import { IConcept } from './Concept';
 import { ICondition } from './Condition';
 import { EDifficultyType } from './Difficulty';
+import { IHighlightNode } from './Highlight';
 import { IPicture } from './Picture';
 import { IPresentation } from './Presentation';
 import { ITopic } from './Topic';
@@ -90,26 +91,7 @@ export interface IQuestion {
     dislikes?: number;
     isLikedByMe?: EQuestionLike;
     comments?: IQuestionComment[];
-    highlights?: Array<IHighlight>;
-}
-export interface IHighlight {
-    start: number;
-    end: number;
-    text: string;
-    color?: string;
-    part?: string;
-    tag?: string;
-}
-export interface IQuestionHighlights {
-    id: Id;
-    createdAt: number | Date;
-    updatedAt: number | Date;
-    deletedAt: number | Date;
-    userId?: Id;
-    questionId?: Id;
-    user?: IUser;
-    question?: IQuestion;
-    highlights?: Array<IHighlight>;
+    highlights?: IHighlightNode[];
 }
 export interface IQuestionChoice {
     id: Id;

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

@@ -5,13 +5,12 @@ import { IMarksheet } from './Marksheet';
 import { INotification } from './Notification';
 import { IOsceStation } from './OsceStation';
 import { EProductType } from './Product';
-import { IQuestion, IQuestionHighlights } from './Question';
+import { IQuestion } from './Question';
 import { ISubscription } from './Subscription';
 import { ITodo } from './Todo';
 import { Id } from './Type';
 import { IUniversity } from './University';
 import { IVideo } from './Video';
-import { IChapter } from './Chapter';
 export type IUserSubsriptionDates = keyof ExtractKeysWithPattern<IPayload, 'EndDate'>;
 export declare enum IAccessLevel {
     SUBSCRIBER = "subscriber",
@@ -142,7 +141,6 @@ export interface IUser {
     radiologyInterviewSubscriptionEndDate: number | Date | null;
     plab1SubscriptionEndDate: number | Date | null;
     plab2SubscriptionEndDate: number | Date | null;
-    questionHighlights?: IQuestionHighlights[];
 }
 export declare function currentClassYear(createdAtUnix: number, classYear: IClassYear, compareUnix?: number): IClassYear;
 export declare function currentClassGroup(createdAtUnix: number, classYear: IClassYear): EClassYearGroup;
@@ -157,15 +155,6 @@ export interface IUserCompletedQuestion {
     question: IQuestion;
     concept: IConcept;
 }
-export interface IUserChapterNote {
-    id: Id;
-    createdAt: number | Date;
-    updatedAt: number | Date;
-    chapterId: Id;
-    chapter: IChapter;
-    userId: Id;
-    note: string;
-}
 export interface IUserCompletedCard {
     id: Id;
     createdAt: number | Date;

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

@@ -8,8 +8,10 @@ export * from './Condition';
 export * from './Difficulty';
 export * from './Feedback';
 export * from './File';
+export * from './Highlight';
 export * from './Marksheet';
 export * from './MockTest';
+export * from './Note';
 export * from './Notification';
 export * from './OsceMarksheet';
 export * from './OsceStation';

package/dist/mjs/models/index.js

@@ -8,8 +8,10 @@ export * from './Condition';
 export * from './Difficulty';
 export * from './Feedback';
 export * from './File';
+export * from './Highlight';
 export * from './Marksheet';
 export * from './MockTest';
+export * from './Note';
 export * from './Notification';
 export * from './OsceMarksheet';
 export * from './OsceStation';

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

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

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

@@ -1,7 +1,9 @@
 import { gql } from '@apollo/client';
 import { PICTURE_FIELDS } from './picture';
+import { HIGHLIGHT_FIELDS } from './highlight';
 export const CHAPTER_FIELDS = gql `
   ${PICTURE_FIELDS}
+  ${HIGHLIGHT_FIELDS}
   fragment ChapterFields on Chapter {
     id
     explanation
@@ -9,6 +11,9 @@ export const CHAPTER_FIELDS = gql `
     pictures {
       ...PictureFields
     }
+    highlights {
+      ...HighlightFields
+    }
     userNote {
       id
       userId
@@ -25,6 +30,7 @@ export const CHAPTER_FIELDS = gql `
     }
   }
 `;
+// used in cache updator
 export const UPSERT_CHAPTER_NOTE_FRAGMENT = gql `
   fragment UpsertChapterNoteFragment on Chapter {
     userNote {
@@ -36,3 +42,16 @@ export const UPSERT_CHAPTER_NOTE_FRAGMENT = gql `
     }
   }
 `;
+// used in cache updator
+export const CHAPTER_WITH_HIGHLIGHT_FIELDS = gql `
+  fragment ChapterWithHighlightFields on Chapter {
+    highlights {
+      start
+      end
+      text
+      part
+      tag
+      color
+    }
+  }
+`;

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

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

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

@@ -0,0 +1,11 @@
+import { gql } from '@apollo/client';
+export const HIGHLIGHT_FIELDS = gql `
+  fragment HighlightFields on HighlightNode {
+    start
+    end
+    text
+    part
+    tag
+    color
+  }
+`;

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

@@ -1,6 +1,7 @@
 export * from './blog';
 export * from './chapter';
 export * from './concept';
+export * from './highlight';
 export * from './marksheet';
 export * from './mockTest';
 export * from './osce';

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

@@ -1,6 +1,7 @@
 export * from './blog';
 export * from './chapter';
 export * from './concept';
+export * from './highlight';
 export * from './marksheet';
 export * from './mockTest';
 export * from './osce';

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

@@ -6,3 +6,4 @@ export declare const OSCE_MATCHMAKING_ACTION_FIELDS: import("@apollo/client").Do
 export declare const STATION_CONCEPT_FRAGMENT: import("@apollo/client").DocumentNode;
 export declare const COMPLETED_OSCE_MARKSHEET_FRAGMENT: import("@apollo/client").DocumentNode;
 export declare const COMPLETED_OSCE_STATION_FRAGMENT: import("@apollo/client").DocumentNode;
+export declare const UPSERT_STATION_NOTE_FRAGMENT: import("@apollo/client").DocumentNode;

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

@@ -169,3 +169,15 @@ export const COMPLETED_OSCE_STATION_FRAGMENT = gql `
     lastOsceMarksheetId
   }
 `;
+// used in cache updator
+export const UPSERT_STATION_NOTE_FRAGMENT = gql `
+  fragment UpsertStationNoteFragment on OsceStation {
+    userNote {
+      userId
+      stationId
+      note
+      createdAt
+      updatedAt
+    }
+  }
+`;

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

@@ -1,5 +1,6 @@
 import { gql } from '@apollo/client';
 import { CONCEPT_FIELDS } from './concept';
+import { HIGHLIGHT_FIELDS } from './highlight';
 import { PICTURE_FIELDS } from './picture';
 export const QUESTION_COMMENT_FIELDS = gql `
   fragment QuestionCommentFields on QuestionComment {
@@ -95,6 +96,7 @@ export const QUESTION_CATEGORY_FIELDS = gql `
   }
 `;
 export const QUESTION_FIELDS = gql `
+  ${HIGHLIGHT_FIELDS}
   ${QUESTION_CATEGORY_FIELDS}
   ${QUESTION_COMMENT_FIELDS}
   ${CONCEPT_FIELDS}
@@ -112,12 +114,7 @@ export const QUESTION_FIELDS = gql `
     typeId
     psaSectionId
     highlights {
-      start
-      end
-      text
-      part
-      tag
-      color
+      ...HighlightFields
     }
     choices {
       id

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

@@ -1,7 +1,10 @@
 import { ApolloCache } from '@apollo/client';
-import { IUserChapterNote } from '../../../models';
+import { IChapterHighlight, IHighlightNode, IUserChapterNote, Id } from '../../../models';
 import { ApolloUpdateOptions, ApolloUpdateResultRestricted } from '../../apollo';
-import { RestrictedData } from '../../types';
+import { RestrictedData, graphqlNormalize } from '../../types';
+/**
+ * upsertChapterNote
+ */
 export declare const UPSERT_CHAPTER_NOTE: import("@apollo/client").DocumentNode;
 export interface IUpsertChapterNoteVar {
     chapterId: number;
@@ -23,3 +26,16 @@ export declare const optimisticUpsertChapterNote: (data: IUpsertChapterNoteVar &
         };
     };
 };
+/**
+ * addChapterHighlight
+ */
+export interface IAddChapterHighlightVar {
+    marksheetId?: number;
+    input: {
+        chapterId: Id;
+        highlights: IHighlightNode[];
+    }[];
+}
+export type IAddChapterHighlightData = RestrictedData<(graphqlNormalize & IChapterHighlight)[], 'addChapterHighlight'>;
+export declare const ADD_CHAPTER_HIGHLIGHT: import("@apollo/client").DocumentNode;
+export declare const updateChapterHighlights: (cache: ApolloCache<any>, result: ApolloUpdateResultRestricted<IAddChapterHighlightData>, options: ApolloUpdateOptions<IAddChapterHighlightVar>) => void;

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

@@ -1,5 +1,8 @@
 import { gql } from '@apollo/client';
-import { UPSERT_CHAPTER_NOTE_FRAGMENT } from '../../fragments';
+import { CHAPTER_WITH_HIGHLIGHT_FIELDS, HIGHLIGHT_FIELDS, UPSERT_CHAPTER_NOTE_FRAGMENT, } from '../../fragments';
+/**
+ * upsertChapterNote
+ */
 export const UPSERT_CHAPTER_NOTE = gql `
   mutation UpsertChapterNote($chapterId: Int!, $note: String!) {
     restricted {
@@ -43,3 +46,45 @@ export const optimisticUpsertChapterNote = (data) => {
         },
     };
 };
+export const ADD_CHAPTER_HIGHLIGHT = gql `
+  ${HIGHLIGHT_FIELDS}
+  mutation AddChapterHighlight(
+    $input: [AddChapterHighlightInput!]!
+    $marksheetId: Int
+  ) {
+    restricted {
+      addChapterHighlight(input: $input, marksheetId: $marksheetId) {
+        id
+        chapterId
+        userId
+        highlights {
+          ...HighlightFields
+        }
+      }
+    }
+  }
+`;
+export const updateChapterHighlights = (cache, result, options) => {
+    const { addChapterHighlight } = result?.data?.restricted ?? {};
+    const { variables } = options || {};
+    if (!variables || !addChapterHighlight) {
+        return;
+    }
+    try {
+        for (const { chapterId, highlights } of variables.input) {
+            cache.writeFragment({
+                id: cache.identify({
+                    id: chapterId,
+                    __typename: 'Chapter',
+                }),
+                data: {
+                    highlights,
+                },
+                fragment: CHAPTER_WITH_HIGHLIGHT_FIELDS,
+            });
+        }
+    }
+    catch (error) {
+        console.error(error);
+    }
+};

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

@@ -1,5 +1,5 @@
 import { ApolloCache } from '@apollo/client';
-import { EOsceMarksheetAction, EOsceMarksheetState, EOsceRoles, EPaceMarkType, EProductType, EStudyAction, IOsceMarksheet, IOsceMarksheetMark, Id } from '../../../models';
+import { EOsceMarksheetAction, EOsceMarksheetState, EOsceRoles, EPaceMarkType, EProductType, EStudyAction, IOsceMarksheet, IOsceMarksheetMark, IUserStationNote, Id } from '../../../models';
 import { ApolloUpdateOptions, ApolloUpdateResultRestricted } from '../../apollo';
 import { IOsceMatchmakingAction } from '../../subscription/osce';
 import { RestrictedData, graphqlNormalize } from '../../types';
@@ -140,3 +140,27 @@ export interface ILeaveOsceMarksheetVar {
     osceMarksheetId: Id;
 }
 export type ILeaveOsceMarksheetData = RestrictedData<graphqlNormalize & IOsceMarksheet, 'leaveOsceMarksheet'>;
+/**
+ * upsertStationNote
+ */
+export declare const UPSERT_STATION_NOTE: import("@apollo/client").DocumentNode;
+export interface IUpsertStationNoteVar {
+    stationId: number;
+    note: string;
+}
+export type IUpsertStationNoteData = RestrictedData<IUserStationNote, 'upsertStationNote'>;
+export declare const updateCacheOnUpsertStationNote: (cache: ApolloCache<any>, result: ApolloUpdateResultRestricted<IUpsertStationNoteData>, options: ApolloUpdateOptions<IUpsertStationNoteVar>) => void;
+export declare const optimisticUpsertStationNote: (data: IUpsertStationNoteVar & {
+    userId: number;
+}) => {
+    restricted: {
+        upsertStationNote: {
+            createdAt: Date;
+            updatedAt: Date;
+            stationId: number;
+            note: string;
+            userId: number;
+            __typename: string;
+        };
+    };
+};

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

@@ -1,7 +1,6 @@
 import { gql } from '@apollo/client';
 import { EProductType, } from '../../../models';
-import { COMPLETED_OSCE_MARKSHEET_FRAGMENT, COMPLETED_OSCE_STATION_FRAGMENT, OSCE_MARKSHEET_FIELDS, OSCE_MATCHMAKING_ACTION_FIELDS, } from '../../fragments/osce';
-import { OSCE_STATION_FIELDS } from './../../fragments/osce';
+import { OSCE_STATION_FIELDS, COMPLETED_OSCE_MARKSHEET_FRAGMENT, COMPLETED_OSCE_STATION_FRAGMENT, OSCE_MARKSHEET_FIELDS, OSCE_MATCHMAKING_ACTION_FIELDS, UPSERT_STATION_NOTE_FRAGMENT, } from '../../fragments';
 export const START_OSCE_MATCHMAKING = gql `
   mutation StartOsceMatchmaking($sessionId: String!) {
     restricted {
@@ -290,3 +289,49 @@ export const LEAVE_OSCE_MARKSHEET = gql `
     }
   }
 `;
+/**
+ * upsertStationNote
+ */
+export const UPSERT_STATION_NOTE = gql `
+  mutation UpsertStationNote($stationId: Int!, $note: String!) {
+    restricted {
+      upsertStationNote(stationId: $stationId, note: $note) {
+        id
+        stationId
+        userId
+        note
+        createdAt
+        updatedAt
+      }
+    }
+  }
+`;
+export const updateCacheOnUpsertStationNote = (cache, result, options) => {
+    const { upsertStationNote } = result?.data?.restricted || {};
+    const { variables } = options || {};
+    if (!variables || !upsertStationNote) {
+        return;
+    }
+    cache.writeFragment({
+        id: cache.identify({
+            id: variables.stationId,
+            __typename: 'OsceStation',
+        }),
+        data: {
+            userNote: upsertStationNote,
+        },
+        fragment: UPSERT_STATION_NOTE_FRAGMENT,
+    });
+};
+export const optimisticUpsertStationNote = (data) => {
+    return {
+        restricted: {
+            upsertStationNote: {
+                __typename: 'UserStationNote',
+                ...data,
+                createdAt: new Date(),
+                updatedAt: new Date(),
+            },
+        },
+    };
+};

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

@@ -1,6 +1,6 @@
 import { ApolloCache } from '@apollo/client';
 import { ApolloUpdateOptions, ApolloUpdateResultRestricted } from '../..';
-import { EQuestionLike, EQuestionType, IAccessLevel, IHighlight, IQuestion, IQuestionComment, IQuestionHighlights, Id } from '../../../models';
+import { EQuestionLike, EQuestionType, IAccessLevel, IHighlightNode, IQuestion, IQuestionComment, IQuestionHighlight, Id } from '../../../models';
 import { RestrictedData, graphqlNormalize } from '../../types';
 interface LikeData {
     likes?: number;
@@ -56,10 +56,10 @@ export interface IAddQuestionHighlightVar {
     marksheetId?: number;
     input: {
         questionId: Id;
-        highlights: IHighlight[];
+        highlights: IHighlightNode[];
     }[];
 }
-export type IAddQuestionHighlightData = RestrictedData<(graphqlNormalize & IQuestionHighlights)[], 'addQuestionHighlight'>;
+export type IAddQuestionHighlightData = RestrictedData<(graphqlNormalize & IQuestionHighlight)[], 'addQuestionHighlight'>;
 export declare const ADD_QUESTION_HIGHLIGHT: import("@apollo/client").DocumentNode;
 export declare const updateQuestionHighlights: (typeId: EQuestionType) => (cache: ApolloCache<any>, result: ApolloUpdateResultRestricted<IAddQuestionHighlightData>, options: ApolloUpdateOptions<IAddQuestionHighlightVar>) => void;
 export {};

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

@@ -1,7 +1,7 @@
 import { gql } from '@apollo/client';
 import { DateTime } from 'luxon';
 import { EQuestionLike, EQuestionType, } from '../../../models';
-import { QUESTION_COMMENT_FIELDS, QUESTION_WITH_COMMENT_FIELDS, QUESTION_WITH_HIGHLIGHT_FIELDS, } from '../../fragments';
+import { HIGHLIGHT_FIELDS, QUESTION_COMMENT_FIELDS, QUESTION_WITH_COMMENT_FIELDS, QUESTION_WITH_HIGHLIGHT_FIELDS, } from '../../fragments';
 export const getLikeData = (like, item) => {
     let { likes = 0, dislikes = 0, isLikedByMe } = item;
     if (isLikedByMe === EQuestionLike.LIKE) {
@@ -325,7 +325,8 @@ export const optimisticQuestionCommentRemove = (comments, input, parentId) => {
     };
 };
 export const ADD_QUESTION_HIGHLIGHT = gql `
-  mutation AddHighlight(
+  ${HIGHLIGHT_FIELDS}
+  mutation AddQuestionHighlight(
     $input: [AddQuestionHighlightInput!]!
     $marksheetId: Int
   ) {
@@ -335,12 +336,7 @@ export const ADD_QUESTION_HIGHLIGHT = gql `
         questionId
         userId
         highlights {
-          start
-          end
-          text
-          part
-          tag
-          color
+          ...HighlightFields
         }
       }
     }

package/package.json

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