@gyldendalas/gyldendal-divine-api 0.2.5 → 0.2.7

package/dist/index.d.ts

@@ -42,6 +42,13 @@ declare class BaseService {
         addAuthHeaders?: boolean;
         timeout: number;
     }): Promise<Response>;
+    patchAsync({ url, headers, addAuthHeaders, body, timeout }: {
+        url: URL | string;
+        headers: Headers | undefined | null;
+        addAuthHeaders?: boolean;
+        body: string | null | undefined;
+        timeout: number;
+    }): Promise<Response>;
     callAsync({ url, body, method, headers, timeout, addAuthHeaders }: {
         url: URL | string;
         body: string | null | undefined;
@@ -833,6 +840,453 @@ declare class AIBotService extends BaseService {
     }): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
 }
 
+declare enum ApiErrors {
+    OVERVIEW_NOT_FOUND = "Quiz overview not found",
+    NOT_FOUND = "Quiz not found",
+    ARCHIVED = "This shared quiz session is archived",
+    GALE_USER_DATA_CLIENT_ERROR = "Failed to fetch Gale user data: Client error"
+}
+interface QuizStartResponse {
+    quizUnitId: number;
+}
+interface QuizApiError {
+    response: {
+        _data: {
+            Error: ApiErrors;
+        };
+    };
+}
+interface Quiz {
+    quizId: number;
+    quizName: string;
+    quizDescription: string;
+    quizFinished: boolean;
+    questions: Question[];
+    quizDeadline?: number;
+    quizResultAvailable?: number;
+    quizStartTime?: number;
+}
+interface Question {
+    questionId: number;
+    name: string;
+    introText: string;
+    caseSensitive?: boolean;
+    shuffle: boolean;
+    answerChecked: boolean;
+    questionType: string;
+    questionTypeId: number;
+    mediafile: Mediafile;
+    medias: Mediafile[];
+    answers: Answer[];
+    chosenAnswer: ChosenAnswer[] | null;
+    description: string;
+    freeText: string;
+    scores?: Score;
+    answerBins: {
+        binindex: number;
+        img: Mediafile;
+        txt: string;
+    }[];
+    tokenized: Tokens[];
+    'chosenAnswer correctness': string;
+}
+interface FormattedQuestion extends Question {
+    number: number;
+    answerTime?: string | null;
+    percentage: string;
+}
+interface Mediafile {
+    id: number;
+    placement: string;
+    caption: string;
+    altText: string;
+    identifier: string;
+    extension: string;
+    mimeType: string;
+    credit: string;
+}
+interface ChosenAnswer {
+    id: number | number[];
+    answerText: string;
+    created?: number;
+    position: number;
+    mediafile: Mediafile;
+    bins?: number[];
+    bin?: number;
+    answers?: Answer[];
+    answerBins?: AnswerBins[];
+    questionId: number;
+    isCorrect: boolean;
+    wordoption?: AnswerIcon;
+}
+interface AnswerBins {
+    txt: string;
+    binindex: number;
+    img: Mediafile;
+}
+interface Answer {
+    id: number | number[];
+    answerText: string;
+    isCorrect: boolean;
+    position: number | number[];
+    mediafile?: Mediafile;
+    bins?: number[];
+    inputText?: {
+        [key: string]: InputText;
+    };
+    dropdown?: DropdownMap;
+    tableData?: TableData;
+    wordoptions?: WordOptions;
+    wordoption?: AnswerIcon;
+    answerOptions?: AnswerIcon[];
+    questionId?: number;
+    answerBins?: AnswerBins[];
+}
+interface WordOptions {
+    options: WordOptionsOption[];
+    answerOptions?: string[] | AnswerIcon[];
+}
+interface WordOptionsOption {
+    words: string;
+    answers: string;
+    position: number;
+}
+interface AnswerIcon {
+    abbreviation: string;
+    icon: string;
+    description: string;
+    display: string;
+}
+interface InputText {
+    answerText: string;
+    bins: number[];
+    id?: number;
+    correctText: string;
+    isCorrect: boolean;
+    position: number;
+    index?: number;
+    maxCorrectValue?: number;
+    minCorrectValue?: number;
+}
+interface InputTextMap {
+    [key: string]: InputText;
+}
+interface DropdownMap {
+    [key: string]: Dropdown[];
+}
+interface Dropdown {
+    option: string;
+    isCorrect: boolean;
+    position?: number;
+}
+interface DropdownFormattedOption {
+    answerId: number;
+    options: Dropdown[];
+}
+interface TableData {
+    [key: string]: {
+        [key: string]: TableDataColumn | string;
+    };
+}
+interface TableDataColumn {
+    correctText: string;
+    isCorrect: boolean;
+    position: number;
+    options: Dropdown[];
+    minCorrectValue?: number;
+    maxCorrectValue?: number;
+}
+interface QuizResult {
+    Problemdata: Question[];
+    QuizSession?: {
+        closesAt: string | null;
+        description: string;
+        name: string;
+        opensAt: string | null;
+        problems: number;
+        quizSessionId: number;
+    };
+    QuizUnit?: {
+        averageScore: number;
+        finished: boolean;
+        finishedAt: number | null;
+        quizUnitId: number;
+        startedAt: number | null;
+        studentEkeysId: string;
+        studentId: number;
+        timeSpent: number;
+    };
+    Results: Results;
+}
+interface Results {
+    'Number of correct': number;
+    'Number of incorrect': number;
+    'Number of not answered': number;
+    'Number of partially correct': number;
+    'Number of questions': number;
+    unitScore: CalculatedScore;
+}
+interface Score {
+    'Number of correct options': number;
+    'Number of correct options chosen': number;
+    'Number of options': number;
+    'Number of options chosen': number;
+    'Percentage score': number;
+    'Student has answered'?: boolean;
+    'Token check': Tokens[];
+}
+interface WordOptionsAnswer {
+    answerId?: number;
+    options?: (string | AnswerIcon)[];
+    text: WordOptionsAnswerText | undefined;
+    index: number;
+    selected?: undefined | string | AnswerIcon;
+}
+interface WordOptionsAnswerText {
+    answers: string;
+    words: string;
+    position: number;
+}
+interface Tokens {
+    correctText: string;
+    diffCheck: TokensDiffCheck[];
+    numberOfTokenErrors: number;
+    studentAnswerText: string;
+}
+interface TokensDiffCheck {
+    error: boolean;
+    studentWord: string;
+    correctWord: string;
+}
+interface NewAnswer {
+    answerText: string;
+    bins: number[];
+    id: number;
+    isCorrect: boolean;
+    position: number;
+    questionId: number;
+}
+interface SaveAnswerResponse {
+    Result: string;
+}
+interface SaveAnswer {
+    'question-id': number;
+    'question-type-id': number;
+    'answer-id'?: number[];
+    'answer-text'?: (string | {
+        answers: string;
+    } | null)[];
+    'answer-position'?: number[];
+    'answer-bin'?: number[];
+    'answer-checked'?: boolean;
+}
+type QuizTextSettings = Record<string, string | number>;
+interface SharedQuizData {
+    'quiz-id'?: string | undefined;
+    isbn?: string | undefined;
+    title: string;
+    description: string;
+    'quiz-open': number | null;
+    'quiz-close': number | null;
+    'result-available-time'?: number | null;
+    'extra-teachers': string[];
+}
+interface SharedTeacherQuiz {
+    createdAt?: number;
+    deactivatedProblems?: number[];
+    extraTeachers?: string[];
+    isArchived?: boolean;
+    isExtraTeacher?: boolean;
+    isPinned?: boolean;
+    name?: string;
+    problems: number;
+    quizSessionId?: number;
+    studentsFinished?: number;
+}
+interface SharedStudentQuiz {
+    quizUnitId: number;
+    quizSessionId: number;
+    name: string;
+    createdBy: string;
+    startedAt: number | null;
+    finishedAt: number | null;
+    finished: boolean;
+}
+interface CalculatedScore {
+    points: number;
+    maxPoints: number;
+    percentage: number;
+}
+interface QuizSession extends SharedTeacherQuiz {
+    description?: string;
+    opensAt: number | null;
+    closesAt: number | null;
+    quizUnits?: QuizUnit[];
+    averageScores?: {
+        byProblem: CalculatedScore[];
+        overall: CalculatedScore;
+    };
+}
+interface QuizUnit {
+    quizUnitId: number;
+    studentId: number;
+    studentEkeysId: string;
+    finished: boolean;
+    finishedAt: number | null;
+    startedAt: number | null;
+    timeSpent: TimeSpent;
+    unitScore: CalculatedScore;
+    problemScores: ProblemScore[];
+}
+interface TimeSpent {
+    days: number;
+    hours: number;
+    minutes: number;
+    seconds: number;
+}
+interface FormattedQuizUnit extends QuizUnit {
+    formattedTimeSpent?: string;
+    formattedFinishedAt?: string | null;
+    formattedStartedAt?: string | null;
+    percentage?: string;
+    total?: string;
+}
+interface ProblemScore {
+    mathproblem: number;
+    questionTypeId: number;
+    questionTypeString: string;
+    score: Score;
+}
+type QuizTableAction = 'copy' | 'archive' | 'delete' | 'unarchive';
+type QuizTableItem = SharedTeacherQuiz | FormattedQuizUnit | SharedStudentQuiz;
+type SearchableKeys = 'name';
+type ProblemAnswerState = 'correct' | 'incorrect' | 'partially-correct' | 'unanswered';
+type QuizLocalState = {
+    id: number;
+    isLoading: boolean;
+    isApiError: boolean;
+    data: Quiz | null;
+    originalData: Quiz | null;
+    finished: boolean;
+    results: QuizResult | null;
+    instantFeedback: string | null;
+    showAdvancedResults: boolean;
+};
+declare class QuizService extends BaseService {
+    discoverUrlPrefix(): string;
+    private makeHeaders;
+    checkActiveSession({ isbn, quizNumber, extraHeaders, timeout }: {
+        isbn: string;
+        quizNumber: number;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<QuizStartResponse>;
+    startQuiz({ isbn, quiz, shared, extraHeaders, timeout }: {
+        isbn: string;
+        quiz: number;
+        shared?: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<QuizStartResponse>;
+    getProblems({ isbn, quizUnitId, shared, extraHeaders, timeout }: {
+        isbn: string;
+        quizUnitId: number;
+        shared?: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<Quiz>;
+    resetAnswer({ isbn, quizUnitId, questionID, extraHeaders, timeout }: {
+        isbn: string;
+        quizUnitId: number;
+        questionID: number;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<any>;
+    saveAnswer({ isbn, quizUnitId, answer, shared, extraHeaders, timeout }: {
+        isbn: string;
+        quizUnitId: number;
+        answer: object;
+        shared?: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<SaveAnswerResponse>;
+    finishQuiz({ isbn, quizUnitId, shared, extraHeaders, timeout }: {
+        isbn: string;
+        quizUnitId: number;
+        shared?: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<any>;
+    getResults({ isbn, quizUnitId, shared, extraHeaders, timeout }: {
+        isbn: string;
+        quizUnitId: number;
+        shared?: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<QuizResult>;
+    createSharedQuiz({ quizData, extraHeaders, timeout }: {
+        quizData: SharedQuizData;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<{
+        quizSessionId: number;
+    }>;
+    copyEditSharedQuiz({ quizSessionId, quizData, action, extraHeaders, timeout }: {
+        quizSessionId: number;
+        quizData: SharedQuizData;
+        action: 'edit' | 'copy';
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<{
+        quizSessionId: number;
+    }>;
+    getTeachersQuizProblems({ quizSessionId, extraHeaders, timeout }: {
+        quizSessionId: number;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<Quiz>;
+    getTeachersUnitOverview({ quizSessionId, quizUnitId, extraHeaders, timeout }: {
+        quizSessionId: number;
+        quizUnitId: number;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<QuizResult>;
+    activateDeactivateQuestion({ quizSessionId, questionId, activate, extraHeaders, timeout }: {
+        quizSessionId: string;
+        questionId: number;
+        activate: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<any>;
+    getTeachersQuizzes({ extraHeaders, timeout }: {
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<{
+        SharedQuizzes: SharedTeacherQuiz[];
+    }>;
+    getStudentsQuizzes({ extraHeaders, timeout }: {
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<SharedStudentQuiz[]>;
+    getTeachersQuiz({ quizSessionId, extraHeaders, timeout }: {
+        quizSessionId: string;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<QuizSession>;
+    toggleArchiveQuiz({ quizSessionId, archive, extraHeaders, timeout }: {
+        quizSessionId: string;
+        archive: boolean;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<any>;
+    deleteSharedQuizUnit({ quizSessionId, quizUnitId, extraHeaders, timeout }: {
+        quizSessionId: string;
+        quizUnitId: string;
+        extraHeaders?: Record<string, string>;
+        timeout?: number;
+    }): Promise<any>;
+}
+
 declare class WritingTaskService extends BaseService {
     discoverUrlPrefix(): string;
 }
@@ -841,4 +1295,4 @@ declare class SolrProxyService extends BaseService {
     discoverUrlPrefix(): string;
 }
 
-export { AIBotService, type AIChatCompletion, type AIChatCompletionDelta, type AIChatCompletionOptions, type AIChatCompletionRequest, type AIChatMessage, type AIChatMessageDelta, type AIChatRole, type ActivePublicationFilters, type Bookmark, type BookmarkUpdate, type ClientSettings, type ClientSettingsResponse, type Continue, type ContinueUpdate, CookieConsentLog, type CookieConsentRequest, type CookieConsentResponse, type CookieConsentState, type CurrentSpeedSelection, type CurrentVoiceSelection, type DisplayModeOption, type Folder, type FolderContent, type FolderObject, type FontFamily, type FrontPageSection, type Highlight, type HighlightAddResult, type HighlightCountResponse, type HighlightDeleteResult, type HighlightRanges, type HighlightRequest, type HighlightResponse, HighlightResultType, type HighlightSearchRequest, type HighlightSearchResponse, HighlightService, type HighlightUpdate, type HighlightUpdateRequest, type HighlightUpdateResponse, type HiglightSearchMatch, type ICtype, type ICtypeDict, type IRecreationData, type ITextStartEndObject, type LayoutView, type MRU, type NoteHighlight, type Notes, type NotesData, type NotesLabels, type NotesRequest, PdfGeneratorService, PollyService, type ReadAloudStore, type Readability, type Response$1 as Response, SSMLSpeechSpeeds, type SiteMapContent, type SiteMapLabels, type SiteMapPage, type SiteMapPageTreeData, type SiteMapPageTreeItem, type SiteMapRequest, SolrProxyService, type SortOptions, type SpeechmarkEvent, type SynthesisRequest, type SynthesisResponse, type Tag, type TagOutput, TaggingService, UserFolders, UserSettingsBookmarks, UserSettingsClientSettings, UserSettingsContinue, UserSettingsMRU, type WritingTaskData, type WritingTaskItem, type WritingTaskRequest, WritingTaskService };
+export { AIBotService, type AIChatCompletion, type AIChatCompletionDelta, type AIChatCompletionOptions, type AIChatCompletionRequest, type AIChatMessage, type AIChatMessageDelta, type AIChatRole, type ActivePublicationFilters, type Answer, type AnswerBins, type AnswerIcon, ApiErrors, type Bookmark, type BookmarkUpdate, type CalculatedScore, type ChosenAnswer, type ClientSettings, type ClientSettingsResponse, type Continue, type ContinueUpdate, CookieConsentLog, type CookieConsentRequest, type CookieConsentResponse, type CookieConsentState, type CurrentSpeedSelection, type CurrentVoiceSelection, type DisplayModeOption, type Dropdown, type DropdownFormattedOption, type DropdownMap, type Folder, type FolderContent, type FolderObject, type FontFamily, type FormattedQuestion, type FormattedQuizUnit, type FrontPageSection, type Highlight, type HighlightAddResult, type HighlightCountResponse, type HighlightDeleteResult, type HighlightRanges, type HighlightRequest, type HighlightResponse, HighlightResultType, type HighlightSearchRequest, type HighlightSearchResponse, HighlightService, type HighlightUpdate, type HighlightUpdateRequest, type HighlightUpdateResponse, type HiglightSearchMatch, type ICtype, type ICtypeDict, type IRecreationData, type ITextStartEndObject, type InputText, type InputTextMap, type LayoutView, type MRU, type Mediafile, type NewAnswer, type NoteHighlight, type Notes, type NotesData, type NotesLabels, type NotesRequest, PdfGeneratorService, PollyService, type ProblemAnswerState, type ProblemScore, type Question, type Quiz, type QuizApiError, type QuizLocalState, type QuizResult, QuizService, type QuizSession, type QuizStartResponse, type QuizTableAction, type QuizTableItem, type QuizTextSettings, type QuizUnit, type ReadAloudStore, type Readability, type Response$1 as Response, type Results, SSMLSpeechSpeeds, type SaveAnswer, type SaveAnswerResponse, type Score, type SearchableKeys, type SharedQuizData, type SharedStudentQuiz, type SharedTeacherQuiz, type SiteMapContent, type SiteMapLabels, type SiteMapPage, type SiteMapPageTreeData, type SiteMapPageTreeItem, type SiteMapRequest, SolrProxyService, type SortOptions, type SpeechmarkEvent, type SynthesisRequest, type SynthesisResponse, type TableData, type TableDataColumn, type Tag, type TagOutput, TaggingService, type TimeSpent, type Tokens, type TokensDiffCheck, UserFolders, UserSettingsBookmarks, UserSettingsClientSettings, UserSettingsContinue, UserSettingsMRU, type WordOptions, type WordOptionsAnswer, type WordOptionsAnswerText, type WordOptionsOption, type WritingTaskData, type WritingTaskItem, type WritingTaskRequest, WritingTaskService };