@goscribe/server 1.3.4 → 1.6.0

package/dist/services/worksheet.service.d.ts

@@ -0,0 +1,385 @@
+import type { PrismaClient } from '@prisma/client';
+import { BaseService } from './base.service.js';
+import { type WorksheetMode, type WorksheetPresetConfig, type WorksheetDifficultyInput } from './worksheet-generation.service.js';
+declare const QuestionType: {
+    readonly MULTIPLE_CHOICE: "MULTIPLE_CHOICE";
+    readonly TEXT: "TEXT";
+    readonly NUMERIC: "NUMERIC";
+    readonly TRUE_FALSE: "TRUE_FALSE";
+    readonly MATCHING: "MATCHING";
+    readonly FILL_IN_THE_BLANK: "FILL_IN_THE_BLANK";
+};
+type DifficultyUpper = 'EASY' | 'MEDIUM' | 'HARD';
+export interface CreateWorksheetInput {
+    workspaceId: string;
+    title: string;
+    description?: string;
+    difficulty?: DifficultyUpper;
+    estimatedTime?: string;
+    problems?: Array<{
+        question: string;
+        answer: string;
+        type: keyof typeof QuestionType;
+        options?: string[];
+    }>;
+}
+export interface UpdateWorksheetInput {
+    id: string;
+    title?: string;
+    description?: string;
+    difficulty?: DifficultyUpper;
+    estimatedTime?: string;
+    problems?: Array<{
+        id?: string;
+        question: string;
+        answer: string;
+        type: keyof typeof QuestionType;
+        options?: string[];
+    }>;
+}
+export interface GenerateWorksheetInput {
+    workspaceId: string;
+    prompt: string;
+    numQuestions: number;
+    difficulty: WorksheetDifficultyInput;
+    mode?: WorksheetMode;
+    presetId?: string;
+    configOverride?: Partial<WorksheetPresetConfig>;
+    title?: string;
+    estimatedTime?: string;
+}
+export declare class WorksheetService extends BaseService {
+    constructor(db: PrismaClient);
+    list(userId: string, workspaceId: string): Promise<({
+        versions: {
+            id: string;
+            createdAt: Date;
+            createdById: string | null;
+            artifactId: string;
+            content: string;
+            data: import("@prisma/client/runtime/library").JsonValue | null;
+            version: number;
+        }[];
+        questions: {
+            meta: import("@prisma/client/runtime/library").JsonValue | null;
+            id: string;
+            createdAt: Date;
+            type: import("@prisma/client").$Enums.QuestionType;
+            difficulty: import("@prisma/client").$Enums.Difficulty;
+            artifactId: string;
+            prompt: string;
+            answer: string | null;
+            order: number;
+        }[];
+    } & {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string;
+        type: import("@prisma/client").$Enums.ArtifactType;
+        title: string;
+        isArchived: boolean;
+        difficulty: import("@prisma/client").$Enums.Difficulty | null;
+        estimatedTime: string | null;
+        createdById: string | null;
+        description: string | null;
+        generating: boolean;
+        generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+        worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+        imageObjectKey: string | null;
+    })[] | {
+        questions: ({
+            id: string;
+            meta?: unknown;
+        } & {
+            meta: Record<string, unknown>;
+        })[];
+        versions: {
+            id: string;
+            createdAt: Date;
+            createdById: string | null;
+            artifactId: string;
+            content: string;
+            data: import("@prisma/client/runtime/library").JsonValue | null;
+            version: number;
+        }[];
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string;
+        type: import("@prisma/client").$Enums.ArtifactType;
+        title: string;
+        isArchived: boolean;
+        difficulty: import("@prisma/client").$Enums.Difficulty | null;
+        estimatedTime: string | null;
+        createdById: string | null;
+        description: string | null;
+        generating: boolean;
+        generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+        worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+        imageObjectKey: string | null;
+    }[]>;
+    listPresets(userId: string, workspaceId: string): Promise<{
+        name: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string | null;
+        userId: string | null;
+        isSystem: boolean;
+        config: import("@prisma/client/runtime/library").JsonValue;
+    }[]>;
+    createPreset(userId: string, input: {
+        workspaceId?: string;
+        name: string;
+        config: Record<string, unknown>;
+    }): Promise<{
+        name: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string | null;
+        userId: string | null;
+        isSystem: boolean;
+        config: import("@prisma/client/runtime/library").JsonValue;
+    }>;
+    updatePreset(userId: string, input: {
+        id: string;
+        name?: string;
+        config?: Record<string, unknown>;
+    }): Promise<{
+        name: string;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string | null;
+        userId: string | null;
+        isSystem: boolean;
+        config: import("@prisma/client/runtime/library").JsonValue;
+    }>;
+    deletePreset(userId: string, id: string): Promise<boolean>;
+    create(userId: string, input: CreateWorksheetInput): Promise<{
+        questions: {
+            meta: import("@prisma/client/runtime/library").JsonValue | null;
+            id: string;
+            createdAt: Date;
+            type: import("@prisma/client").$Enums.QuestionType;
+            difficulty: import("@prisma/client").$Enums.Difficulty;
+            artifactId: string;
+            prompt: string;
+            answer: string | null;
+            order: number;
+        }[];
+    } & {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string;
+        type: import("@prisma/client").$Enums.ArtifactType;
+        title: string;
+        isArchived: boolean;
+        difficulty: import("@prisma/client").$Enums.Difficulty | null;
+        estimatedTime: string | null;
+        createdById: string | null;
+        description: string | null;
+        generating: boolean;
+        generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+        worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+        imageObjectKey: string | null;
+    }>;
+    get(userId: string, worksheetId: string): Promise<({
+        questions: {
+            meta: import("@prisma/client/runtime/library").JsonValue | null;
+            id: string;
+            createdAt: Date;
+            type: import("@prisma/client").$Enums.QuestionType;
+            difficulty: import("@prisma/client").$Enums.Difficulty;
+            artifactId: string;
+            prompt: string;
+            answer: string | null;
+            order: number;
+        }[];
+    } & {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string;
+        type: import("@prisma/client").$Enums.ArtifactType;
+        title: string;
+        isArchived: boolean;
+        difficulty: import("@prisma/client").$Enums.Difficulty | null;
+        estimatedTime: string | null;
+        createdById: string | null;
+        description: string | null;
+        generating: boolean;
+        generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+        worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+        imageObjectKey: string | null;
+    }) | {
+        questions: ({
+            id: string;
+            meta?: unknown;
+        } & {
+            meta: Record<string, unknown>;
+        })[];
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string;
+        type: import("@prisma/client").$Enums.ArtifactType;
+        title: string;
+        isArchived: boolean;
+        difficulty: import("@prisma/client").$Enums.Difficulty | null;
+        estimatedTime: string | null;
+        createdById: string | null;
+        description: string | null;
+        generating: boolean;
+        generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+        worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+        imageObjectKey: string | null;
+    }>;
+    createWorksheetQuestion(userId: string, input: {
+        worksheetId: string;
+        prompt: string;
+        answer?: string;
+        type?: keyof typeof QuestionType;
+        difficulty?: DifficultyUpper;
+        order?: number;
+        meta?: Record<string, unknown>;
+    }): Promise<{
+        meta: import("@prisma/client/runtime/library").JsonValue | null;
+        id: string;
+        createdAt: Date;
+        type: import("@prisma/client").$Enums.QuestionType;
+        difficulty: import("@prisma/client").$Enums.Difficulty;
+        artifactId: string;
+        prompt: string;
+        answer: string | null;
+        order: number;
+    }>;
+    updateWorksheetQuestion(userId: string, input: {
+        worksheetQuestionId: string;
+        prompt?: string;
+        answer?: string;
+        type?: keyof typeof QuestionType;
+        difficulty?: DifficultyUpper;
+        order?: number;
+        meta?: Record<string, unknown>;
+    }): Promise<{
+        meta: import("@prisma/client/runtime/library").JsonValue | null;
+        id: string;
+        createdAt: Date;
+        type: import("@prisma/client").$Enums.QuestionType;
+        difficulty: import("@prisma/client").$Enums.Difficulty;
+        artifactId: string;
+        prompt: string;
+        answer: string | null;
+        order: number;
+    }>;
+    deleteWorksheetQuestion(userId: string, worksheetQuestionId: string): Promise<boolean>;
+    updateProblemStatus(userId: string, input: {
+        problemId: string;
+        completed: boolean;
+        answer?: string;
+        correct?: boolean;
+    }): Promise<{
+        meta: import("@prisma/client/runtime/library").JsonValue | null;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        userId: string;
+        worksheetQuestionId: string;
+        userAnswer: string | null;
+        completedAt: Date | null;
+        attempts: number;
+        timeSpentSec: number | null;
+        correct: boolean | null;
+        modified: boolean;
+    }>;
+    getProgress(userId: string, worksheetId: string): Promise<{
+        meta: import("@prisma/client/runtime/library").JsonValue | null;
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        userId: string;
+        worksheetQuestionId: string;
+        userAnswer: string | null;
+        completedAt: Date | null;
+        attempts: number;
+        timeSpentSec: number | null;
+        correct: boolean | null;
+        modified: boolean;
+    }[]>;
+    update(userId: string, input: UpdateWorksheetInput): Promise<{
+        questions: {
+            meta: import("@prisma/client/runtime/library").JsonValue | null;
+            id: string;
+            createdAt: Date;
+            type: import("@prisma/client").$Enums.QuestionType;
+            difficulty: import("@prisma/client").$Enums.Difficulty;
+            artifactId: string;
+            prompt: string;
+            answer: string | null;
+            order: number;
+        }[];
+    } & {
+        id: string;
+        createdAt: Date;
+        updatedAt: Date;
+        workspaceId: string;
+        type: import("@prisma/client").$Enums.ArtifactType;
+        title: string;
+        isArchived: boolean;
+        difficulty: import("@prisma/client").$Enums.Difficulty | null;
+        estimatedTime: string | null;
+        createdById: string | null;
+        description: string | null;
+        generating: boolean;
+        generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+        worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+        imageObjectKey: string | null;
+    }>;
+    delete(userId: string, id: string): Promise<boolean>;
+    generateFromPrompt(userId: string, input: GenerateWorksheetInput): Promise<{
+        artifact: {
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            workspaceId: string;
+            type: import("@prisma/client").$Enums.ArtifactType;
+            title: string;
+            isArchived: boolean;
+            difficulty: import("@prisma/client").$Enums.Difficulty | null;
+            estimatedTime: string | null;
+            createdById: string | null;
+            description: string | null;
+            generating: boolean;
+            generatingMetadata: import("@prisma/client/runtime/library").JsonValue | null;
+            worksheetConfig: import("@prisma/client/runtime/library").JsonValue | null;
+            imageObjectKey: string | null;
+        };
+    }>;
+    checkAnswer(userId: string, input: {
+        worksheetId: string;
+        questionId: string;
+        answer: string;
+    }): Promise<{
+        isCorrect: boolean;
+        userMarkScheme: any;
+        progress: {
+            meta: import("@prisma/client/runtime/library").JsonValue | null;
+            id: string;
+            createdAt: Date;
+            updatedAt: Date;
+            userId: string;
+            worksheetQuestionId: string;
+            userAnswer: string | null;
+            completedAt: Date | null;
+            attempts: number;
+            timeSpentSec: number | null;
+            correct: boolean | null;
+            modified: boolean;
+        };
+    }>;
+}
+export {};