All files / shared tutor.ts

97.95% Statements 48/49
77.77% Branches 7/9
100% Functions 5/5
100% Lines 45/45

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202        28x       28x 28x 28x 28x 28x 28x 28x   28x     28x     28x               28x   28x 28x 28x 28x           28x   28x                                 571x 59x     28x                 28x           28x           28x           21x 21x             16x 16x   20x 20x 16x 16x     28x                     28x           28x           28x       28x             28x           28x           28x             28x                           28x           28x             28x             28x            
import { z } from "zod";
import { INPUT_LIMITS } from "./input-limits";
import { examplesRefSchema, fullCommitShaSchema, repositorySlugSchema } from "./examples";
 
export const tutorModelSchema = z
  .string()
  .regex(/^[A-Za-z0-9][A-Za-z0-9._:/-]{0,127}$/, "Invalid tutor model identifier");
 
export const TUTOR_DIFFICULTY_MIN = 1;
export const TUTOR_DIFFICULTY_MAX = 100;
export const TUTOR_DEFAULT_DIFFICULTY = 30;
export const TUTOR_CONFIGURED_DIFFICULTY_STORAGE_KEY = "unoTutorConfiguredDifficulty";
export const TUTOR_ADAPTIVE_RATING_WINDOW = 4;
export const TUTOR_ADAPTIVE_MIN_STEP = -6;
export const TUTOR_ADAPTIVE_MAX_STEP = 4;
 
export const tutorDifficultySchema = z.number().int().min(TUTOR_DIFFICULTY_MIN).max(TUTOR_DIFFICULTY_MAX);
export type TutorDifficulty = z.infer<typeof tutorDifficultySchema>;
 
export const tutorAnswerRatingSchema = z.number().int().min(1).max(5);
export type TutorAnswerRating = z.infer<typeof tutorAnswerRatingSchema>;
 
export const TUTOR_RATING_DIFFICULTY_DELTAS: Record<TutorAnswerRating, number> = {
  1: -6,
  2: -3,
  3: 0,
  4: 2,
  5: 4,
};
 
export const tutorResponseStyleSchema = z.enum(["normal", "philosophical"]);
 
const tutorQuestionKindSchema = z.enum(["recall", "concept", "application", "prediction", "transfer"]);
const tutorLearningPhaseSchema = z.enum(["LEARN", "DEEPEN", "EXPAND"]);
export const tutorStrategySourceSchema = z.enum(["built-in", "repository"]);
export const tutorCourseContentContextSchema = z.object({
  repository: repositorySlugSchema,
  ref: examplesRefSchema,
  revision: fullCommitShaSchema,
  exampleId: z.string().regex(/^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$/).optional(),
}).strict();
export const tutorCourseContentSessionSchema = z.string().uuid();
export type TutorCourseContentContext = z.infer<typeof tutorCourseContentContextSchema>;
const tutorLearningMetadataFields = {
  topicId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
  conceptId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
  questionId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
  indicatorId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
  questionKind: tutorQuestionKindSchema.optional(),
  strategyId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
  strategySource: tutorStrategySourceSchema.optional(),
  contentRevision: z.string().regex(/^[a-f0-9]{40}$/i).optional(),
  learningPhase: tutorLearningPhaseSchema.optional(),
  activeTopicId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
  masteredTopicIds: z.array(z.string().regex(/^[a-z][a-z0-9-]{0,63}$/)).max(64).optional(),
  progressionBlockedReason: z.literal("content-exhausted").optional(),
  extensionTargetTopicId: z.string().regex(/^[a-z][a-z0-9-]{0,63}$/).optional(),
};
 
function withDefaultResponseStyle(value: unknown): unknown {
  if (typeof value !== "object" || value === null || "responseStyle" in value) return value;
  return { ...value, responseStyle: "normal" };
}
 
const tutorContentFields = {
  feedback: z.string().trim().min(1).max(INPUT_LIMITS.tutor.maxFeedbackChars).optional(),
  question: z.string().trim().min(1).max(2_000),
  topic: z.string().trim().min(1).max(120).optional(),
  difficulty: tutorDifficultySchema.optional(),
  mermaid: z.string().trim().min(1).max(12_000).optional(),
  ...tutorLearningMetadataFields,
};
 
const tutorNormalContentResultSchema = z.object({
  ...tutorContentFields,
  answerRating: tutorAnswerRatingSchema.optional(),
  responseStyle: z.literal("normal"),
}).strict();
 
const tutorPhilosophicalContentResultSchema = z.object({
  ...tutorContentFields,
  answerRating: z.never().optional(),
  responseStyle: z.literal("philosophical"),
}).strict();
 
const tutorContentResultUnionSchema = z.discriminatedUnion("responseStyle", [
  tutorNormalContentResultSchema,
  tutorPhilosophicalContentResultSchema,
]);
 
export function clampTutorDifficulty(value: number): TutorDifficulty {
  const normalized = Number.isFinite(value) ? Math.round(value) : TUTOR_DEFAULT_DIFFICULTY;
  return Math.min(TUTOR_DIFFICULTY_MAX, Math.max(TUTOR_DIFFICULTY_MIN, normalized));
}
 
export function calculateNextTutorDifficulty(
  currentDifficulty: TutorDifficulty,
  ratings: readonly TutorAnswerRating[],
): TutorDifficulty {
  const recentRatings = ratings.slice(-TUTOR_ADAPTIVE_RATING_WINDOW);
  Iif (recentRatings.length === 0) return currentDifficulty;
 
  const weightedSum = recentRatings.reduce((sum, rating, index) => sum + TUTOR_RATING_DIFFICULTY_DELTAS[rating] * (index + 1), 0);
  const weightSum = recentRatings.reduce((sum, _rating, index) => sum + index + 1, 0);
  const dampedStep = Math.max(TUTOR_ADAPTIVE_MIN_STEP, Math.min(TUTOR_ADAPTIVE_MAX_STEP, Math.round(weightedSum / weightSum)));
  return clampTutorDifficulty(currentDifficulty + dampedStep);
}
 
export const tutorQuestionRequestSchema = z
  .object({
    code: z.string().min(1).max(INPUT_LIMITS.compile.maxCodeChars),
    credential: z.string().min(1).max(INPUT_LIMITS.tutor.maxCredentialChars).optional(),
    model: tutorModelSchema.optional(),
    difficulty: tutorDifficultySchema.default(TUTOR_DEFAULT_DIFFICULTY),
    courseContent: tutorCourseContentContextSchema.optional(),
    courseContentSession: tutorCourseContentSessionSchema.optional(),
  })
  .strict();
 
export const tutorModelsRequestSchema = z
  .object({
    credential: z.string().min(1).max(INPUT_LIMITS.tutor.maxCredentialChars).optional(),
  })
  .strict();
 
export const tutorModelsResponseSchema = z
  .object({
    models: z.array(tutorModelSchema).max(256),
  })
  .strict();
 
export const tutorContentResultSchema = z.preprocess(withDefaultResponseStyle, tutorContentResultUnionSchema);
 
export type TutorContentResult = z.infer<typeof tutorContentResultSchema>;
 
const tutorDialogFields = {
  question: z.string().trim().min(1).max(2_000),
  answer: z.string().trim().min(1).max(INPUT_LIMITS.tutor.maxAnswerChars),
  feedback: z.string().trim().min(1).max(INPUT_LIMITS.tutor.maxFeedbackChars).optional(),
  ...tutorLearningMetadataFields,
};
 
const tutorNormalDialogTurnSchema = z.object({
  ...tutorDialogFields,
  answerRating: tutorAnswerRatingSchema.optional(),
  responseStyle: z.literal("normal"),
}).strict();
 
const tutorPhilosophicalDialogTurnSchema = z.object({
  ...tutorDialogFields,
  answerRating: z.never().optional(),
  responseStyle: z.literal("philosophical"),
}).strict();
 
export const tutorDialogTurnSchema = z.preprocess(
  withDefaultResponseStyle,
  z.discriminatedUnion("responseStyle", [tutorNormalDialogTurnSchema, tutorPhilosophicalDialogTurnSchema]),
);
 
export type TutorDialogTurn = z.infer<typeof tutorDialogTurnSchema>;
 
export const tutorDialogRequestSchema = z
  .object({
    code: z.string().min(1).max(INPUT_LIMITS.compile.maxCodeChars),
    history: z.array(tutorDialogTurnSchema).max(INPUT_LIMITS.tutor.maxHistoryEntries),
    question: z.string().trim().min(1).max(2_000),
    answer: z.string().trim().min(1).max(INPUT_LIMITS.tutor.maxAnswerChars),
    credential: z.string().min(1).max(INPUT_LIMITS.tutor.maxCredentialChars).optional(),
    model: tutorModelSchema.optional(),
    difficulty: tutorDifficultySchema.default(TUTOR_DEFAULT_DIFFICULTY),
    courseContent: tutorCourseContentContextSchema.optional(),
    courseContentSession: tutorCourseContentSessionSchema.optional(),
  })
  .strict();
 
const tutorResponseFields = {
  provider: z.string().min(1).max(64),
  model: z.string().min(1).max(128),
  courseContentSession: tutorCourseContentSessionSchema.optional(),
};
 
const tutorNormalResponseSchema = z.object({
  ...tutorContentFields,
  answerRating: tutorAnswerRatingSchema.optional(),
  responseStyle: z.literal("normal"),
  ...tutorResponseFields,
}).strict();
 
const tutorPhilosophicalResponseSchema = z.object({
  ...tutorContentFields,
  answerRating: z.never().optional(),
  responseStyle: z.literal("philosophical"),
  ...tutorResponseFields,
}).strict();
 
export const tutorResponseSchema = z.preprocess(
  withDefaultResponseStyle,
  z.discriminatedUnion("responseStyle", [tutorNormalResponseSchema, tutorPhilosophicalResponseSchema]),
);
 
export type TutorResponse = z.infer<typeof tutorResponseSchema>;