@altnovatrail/contracts 0.8.2 → 0.8.3

package/novatrail/api/v1/progress_pb.d.ts

@@ -0,0 +1,623 @@
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file novatrail/api/v1/progress.proto (package novatrail.api.v1, syntax proto3)
+/* eslint-disable */
+
+// The skill map and the adult's progress in the contract between `app` and `api`: the state of a
+// learner's skills in a module, as the learner model reads it, and the attempts of a profile with
+// the traps that repeat in them. What each message means is the rule of contracts/README.md,
+// section 15.
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { Action, SubmissionEnd } from "./attempt_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { CloseReason } from "./cause_pb.js";
+
+/**
+ * Describes the file novatrail/api/v1/progress.proto.
+ */
+export declare const file_novatrail_api_v1_progress: GenFile;
+
+/**
+ * A request for the skill map of a module.
+ *
+ * @generated from message novatrail.api.v1.GetSkillMapRequest
+ */
+export declare type GetSkillMapRequest = Message<"novatrail.api.v1.GetSkillMapRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The module's ID.
+   *
+   * @generated from field: string module_id = 2;
+   */
+  moduleId: string;
+
+  /**
+   * Whose action it is: the learner's, on the learner's screen, or an adult's, in the section for
+   * adults.
+   *
+   * @generated from field: novatrail.api.v1.Action action = 3;
+   */
+  action: Action;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetSkillMapRequest.
+ * Use `create(GetSkillMapRequestSchema)` to create a new message.
+ */
+export declare const GetSkillMapRequestSchema: GenMessage<GetSkillMapRequest>;
+
+/**
+ * The skill map of a module.
+ *
+ * @generated from message novatrail.api.v1.GetSkillMapResponse
+ */
+export declare type GetSkillMapResponse = Message<"novatrail.api.v1.GetSkillMapResponse"> & {
+  /**
+   * The digest of the package of the module's current version, by which `app` takes the open view
+   * of its skill graph and its tiers.
+   *
+   * @generated from field: string package_digest = 1;
+   */
+  packageDigest: string;
+
+  /**
+   * The state of each skill of the graph whose assessability is `verdict`, by its local ID. A skill
+   * of `rubric` or `none` has none.
+   *
+   * @generated from field: repeated novatrail.api.v1.SkillState skills = 2;
+   */
+  skills: SkillState[];
+
+  /**
+   * The state of each anchor skill that the graph names as a prerequisite or in `teaches`.
+   *
+   * @generated from field: repeated novatrail.api.v1.AnchorSkillState anchor_skills = 3;
+   */
+  anchorSkills: AnchorSkillState[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetSkillMapResponse.
+ * Use `create(GetSkillMapResponseSchema)` to create a new message.
+ */
+export declare const GetSkillMapResponseSchema: GenMessage<GetSkillMapResponse>;
+
+/**
+ * The state of a skill of a module, as `learner-model` reads it (concepts 11). No trap is in it:
+ * the trap catalog is closed, and the traps that repeat go to the adult's progress alone.
+ *
+ * @generated from message novatrail.api.v1.SkillState
+ */
+export declare type SkillState = Message<"novatrail.api.v1.SkillState"> & {
+  /**
+   * The skill's local ID.
+   *
+   * @generated from field: string skill = 1;
+   */
+  skill: string;
+
+  /**
+   * The number of pieces of evidence: attempts where the skill, a primary skill of an item, has an
+   * answer.
+   *
+   * @generated from field: int32 evidence_count = 2;
+   */
+  evidenceCount: number;
+
+  /**
+   * When the skill was last practised: absent without practice.
+   *
+   * @generated from field: google.protobuf.Timestamp last_practiced_at = 3;
+   */
+  lastPracticedAt?: Timestamp | undefined;
+
+  /**
+   * The estimate of mastery, the module's level plus the skill's adjustment, on the scale of the
+   * module's bands: absent without practice.
+   *
+   * @generated from field: optional double estimate = 4;
+   */
+  estimate?: number | undefined;
+
+  /**
+   * The uncertainty of the estimate, as `learner-model` gives it: absent without practice.
+   *
+   * @generated from field: optional double uncertainty = 5;
+   */
+  uncertainty?: number | undefined;
+
+  /**
+   * The retention of the skill at the time of the request, from 0 to 1: absent without practice.
+   *
+   * @generated from field: optional double retention = 6;
+   */
+  retention?: number | undefined;
+
+  /**
+   * The ID of the mastery band, the band the skill is mastered at: empty when it is not mastered.
+   *
+   * @generated from field: string mastery_band = 7;
+   */
+  masteryBand: string;
+
+  /**
+   * Beside a mastered skill: the cautious probability of a correct answer with retention, at the
+   * middle task of the mastery band.
+   *
+   * @generated from field: optional double cautious_probability = 8;
+   */
+  cautiousProbability?: number | undefined;
+
+  /**
+   * Beside a mastered skill: the review date, when the cautious probability with retention falls
+   * below the threshold of mastery. Absent when the review is due already.
+   *
+   * @generated from field: google.protobuf.Timestamp review_date = 9;
+   */
+  reviewDate?: Timestamp | undefined;
+
+  /**
+   * Beside a mastered skill: the review is due already, since the threshold does not hold even
+   * without forgetting.
+   *
+   * @generated from field: bool review_due = 10;
+   */
+  reviewDue: boolean;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SkillState.
+ * Use `create(SkillStateSchema)` to create a new message.
+ */
+export declare const SkillStateSchema: GenMessage<SkillState>;
+
+/**
+ * The state of an anchor skill of the shared taxonomy, as `learner-model` reads it from the skills
+ * that teach it in the learner's modules (concepts 4).
+ *
+ * @generated from message novatrail.api.v1.AnchorSkillState
+ */
+export declare type AnchorSkillState = Message<"novatrail.api.v1.AnchorSkillState"> & {
+  /**
+   * The anchor skill's ID, "core.multiplication-table".
+   *
+   * @generated from field: string anchor_skill = 1;
+   */
+  anchorSkill: string;
+
+  /**
+   * Whether the learner holds it.
+   *
+   * @generated from field: novatrail.api.v1.AnchorSkillHolding holding = 2;
+   */
+  holding: AnchorSkillHolding;
+
+  /**
+   * Why, beside `ANCHOR_SKILL_HOLDING_NOT_HELD` and `ANCHOR_SKILL_HOLDING_UNKNOWN`.
+   *
+   * @generated from field: novatrail.api.v1.AnchorSkillReason reason = 3;
+   */
+  reason: AnchorSkillReason;
+
+  /**
+   * The full IDs of the skills that teach it, in the modules whose graphs the learner model has.
+   *
+   * @generated from field: repeated string teaching_skills = 4;
+   */
+  teachingSkills: string[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.AnchorSkillState.
+ * Use `create(AnchorSkillStateSchema)` to create a new message.
+ */
+export declare const AnchorSkillStateSchema: GenMessage<AnchorSkillState>;
+
+/**
+ * A request for the progress of a profile.
+ *
+ * @generated from message novatrail.api.v1.GetProgressRequest
+ */
+export declare type GetProgressRequest = Message<"novatrail.api.v1.GetProgressRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The page: empty for the first, and otherwise the `next_page_token` of the page before.
+   *
+   * @generated from field: string page_token = 2;
+   */
+  pageToken: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetProgressRequest.
+ * Use `create(GetProgressRequestSchema)` to create a new message.
+ */
+export declare const GetProgressRequestSchema: GenMessage<GetProgressRequest>;
+
+/**
+ * A page of the progress of a profile.
+ *
+ * @generated from message novatrail.api.v1.GetProgressResponse
+ */
+export declare type GetProgressResponse = Message<"novatrail.api.v1.GetProgressResponse"> & {
+  /**
+   * The attempts of the page, newest first.
+   *
+   * @generated from field: repeated novatrail.api.v1.AttemptRecord attempts = 1;
+   */
+  attempts: AttemptRecord[];
+
+  /**
+   * The traps that repeat in the profile's closed attempts: on the first page alone, the one asked
+   * for with an empty `page_token`, and empty on the others.
+   *
+   * @generated from field: repeated novatrail.api.v1.RepeatingTrap repeating_traps = 2;
+   */
+  repeatingTraps: RepeatingTrap[];
+
+  /**
+   * The token of the next page: empty on the last.
+   *
+   * @generated from field: string next_page_token = 3;
+   */
+  nextPageToken: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetProgressResponse.
+ * Use `create(GetProgressResponseSchema)` to create a new message.
+ */
+export declare const GetProgressResponseSchema: GenMessage<GetProgressResponse>;
+
+/**
+ * An attempt in the progress of a profile. How it came out follows from its close reason and its
+ * wrong answers: correct with none is correct at the first submission.
+ *
+ * @generated from message novatrail.api.v1.AttemptRecord
+ */
+export declare type AttemptRecord = Message<"novatrail.api.v1.AttemptRecord"> & {
+  /**
+   * The full ID of the task, "novatrail/olympiad-math/task/counting-gaps-3".
+   *
+   * @generated from field: string task = 1;
+   */
+  task: string;
+
+  /**
+   * The version of the module the attempt went on, X.Y.Z.
+   *
+   * @generated from field: string module_version = 2;
+   */
+  moduleVersion: string;
+
+  /**
+   * The full ID of the lesson, when the attempt is one of a lesson run's segments: empty outside a
+   * lesson.
+   *
+   * @generated from field: string lesson = 3;
+   */
+  lesson: string;
+
+  /**
+   * Why the attempt was closed: `CLOSE_REASON_UNSPECIFIED` while it is open.
+   *
+   * @generated from field: novatrail.api.v1.CloseReason close_reason = 4;
+   */
+  closeReason: CloseReason;
+
+  /**
+   * How many wrong answers it has.
+   *
+   * @generated from field: int32 wrong_answers = 5;
+   */
+  wrongAnswers: number;
+
+  /**
+   * When it began.
+   *
+   * @generated from field: google.protobuf.Timestamp begun_at = 6;
+   */
+  begunAt?: Timestamp | undefined;
+
+  /**
+   * When it was closed: absent while it is open.
+   *
+   * @generated from field: google.protobuf.Timestamp closed_at = 7;
+   */
+  closedAt?: Timestamp | undefined;
+
+  /**
+   * When the engine chose the task, or the lesson of the run: absent for an attempt begun again by
+   * the learner.
+   *
+   * @generated from field: google.protobuf.Timestamp chosen_at = 8;
+   */
+  chosenAt?: Timestamp | undefined;
+
+  /**
+   * On a task with a rubric: each submission, in order, with how it ended and its feedback's marks.
+   *
+   * @generated from field: repeated novatrail.api.v1.EssayRecord essay_submissions = 9;
+   */
+  essaySubmissions: EssayRecord[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.AttemptRecord.
+ * Use `create(AttemptRecordSchema)` to create a new message.
+ */
+export declare const AttemptRecordSchema: GenMessage<AttemptRecord>;
+
+/**
+ * A submission of an essay in the progress of a profile.
+ *
+ * @generated from message novatrail.api.v1.EssayRecord
+ */
+export declare type EssayRecord = Message<"novatrail.api.v1.EssayRecord"> & {
+  /**
+   * When it came.
+   *
+   * @generated from field: google.protobuf.Timestamp submitted_at = 1;
+   */
+  submittedAt?: Timestamp | undefined;
+
+  /**
+   * How it ended.
+   *
+   * @generated from field: novatrail.api.v1.SubmissionEnd end = 2;
+   */
+  end: SubmissionEnd;
+
+  /**
+   * Beside `SUBMISSION_END_FEEDBACK`: the mark of each criterion of the rubric, in the order of
+   * the criteria (R87).
+   *
+   * @generated from field: repeated novatrail.api.v1.CriterionMark criterion_marks = 3;
+   */
+  criterionMarks: CriterionMark[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.EssayRecord.
+ * Use `create(EssayRecordSchema)` to create a new message.
+ */
+export declare const EssayRecordSchema: GenMessage<EssayRecord>;
+
+/**
+ * A trap that repeats: one that the program found in two closed attempts of the profile or more,
+ * counted by its full ID. An attempt on a version withdrawn `wrong_key` counts no trap: its
+ * verdicts are wrong (R63).
+ *
+ * @generated from message novatrail.api.v1.RepeatingTrap
+ */
+export declare type RepeatingTrap = Message<"novatrail.api.v1.RepeatingTrap"> & {
+  /**
+   * The full ID of the trap, "novatrail/olympiad-math/trap/off-by-one".
+   *
+   * @generated from field: string trap = 1;
+   */
+  trap: string;
+
+  /**
+   * The trap's `description`, from the trap catalog of the version of the last attempt that found
+   * it.
+   *
+   * @generated from field: string description = 2;
+   */
+  description: string;
+
+  /**
+   * The trap's `trap_advice`, from the same catalog.
+   *
+   * @generated from field: string trap_advice = 3;
+   */
+  trapAdvice: string;
+
+  /**
+   * How many closed attempts found it.
+   *
+   * @generated from field: int32 attempt_count = 4;
+   */
+  attemptCount: number;
+
+  /**
+   * When the last of them was closed.
+   *
+   * @generated from field: google.protobuf.Timestamp last_closed_at = 5;
+   */
+  lastClosedAt?: Timestamp | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.RepeatingTrap.
+ * Use `create(RepeatingTrapSchema)` to create a new message.
+ */
+export declare const RepeatingTrapSchema: GenMessage<RepeatingTrap>;
+
+/**
+ * Whether a learner holds an anchor skill. A value its build does not know `app` reads as
+ * `ANCHOR_SKILL_HOLDING_UNKNOWN`.
+ *
+ * @generated from enum novatrail.api.v1.AnchorSkillHolding
+ */
+export enum AnchorSkillHolding {
+  /**
+   * Not named: never sent.
+   *
+   * @generated from enum value: ANCHOR_SKILL_HOLDING_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Holds it: a skill that teaches it is mastered, in any module and at any band.
+   *
+   * @generated from enum value: ANCHOR_SKILL_HOLDING_HELD = 1;
+   */
+  HELD = 1,
+
+  /**
+   * Does not hold it: the skills that teach it in the engine's modules, and may be mastered, are
+   * not.
+   *
+   * @generated from enum value: ANCHOR_SKILL_HOLDING_NOT_HELD = 2;
+   */
+  NOT_HELD = 2,
+
+  /**
+   * Unknown: no skill of the engine's modules that may be mastered teaches it.
+   *
+   * @generated from enum value: ANCHOR_SKILL_HOLDING_UNKNOWN = 3;
+   */
+  UNKNOWN = 3,
+}
+
+/**
+ * Describes the enum novatrail.api.v1.AnchorSkillHolding.
+ */
+export declare const AnchorSkillHoldingSchema: GenEnum<AnchorSkillHolding>;
+
+/**
+ * Why a learner does not hold an anchor skill, or why it is unknown. A reason its build does not
+ * know `app` shows no reason for.
+ *
+ * @generated from enum novatrail.api.v1.AnchorSkillReason
+ */
+export enum AnchorSkillReason {
+  /**
+   * No reason: beside a skill held.
+   *
+   * @generated from enum value: ANCHOR_SKILL_REASON_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Not held: a skill that teaches it has answers, and is not mastered.
+   *
+   * @generated from enum value: ANCHOR_SKILL_REASON_NOT_MASTERED = 1;
+   */
+  NOT_MASTERED = 1,
+
+  /**
+   * Not held: no skill that teaches it has answers yet.
+   *
+   * @generated from enum value: ANCHOR_SKILL_REASON_NO_EVIDENCE = 2;
+   */
+  NO_EVIDENCE = 2,
+
+  /**
+   * Unknown: no module of the engine teaches it.
+   *
+   * @generated from enum value: ANCHOR_SKILL_REASON_NOBODY_TEACHES = 3;
+   */
+  NOBODY_TEACHES = 3,
+
+  /**
+   * Unknown: only skills that cannot be mastered, of `rubric` or `none`, or with no band they are
+   * taught at, teach it.
+   *
+   * @generated from enum value: ANCHOR_SKILL_REASON_ONLY_UNASSESSABLE = 4;
+   */
+  ONLY_UNASSESSABLE = 4,
+}
+
+/**
+ * Describes the enum novatrail.api.v1.AnchorSkillReason.
+ */
+export declare const AnchorSkillReasonSchema: GenEnum<AnchorSkillReason>;
+
+/**
+ * The mark of a criterion in a feedback (R87). A mark its build does not know `app` reads as
+ * `CRITERION_MARK_NOT_ASSESSED`.
+ *
+ * @generated from enum novatrail.api.v1.CriterionMark
+ */
+export enum CriterionMark {
+  /**
+   * Not named: never sent.
+   *
+   * @generated from enum value: CRITERION_MARK_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Met.
+   *
+   * @generated from enum value: CRITERION_MARK_MET = 1;
+   */
+  MET = 1,
+
+  /**
+   * Not met.
+   *
+   * @generated from enum value: CRITERION_MARK_NOT_MET = 2;
+   */
+  NOT_MET = 2,
+
+  /**
+   * Not assessed.
+   *
+   * @generated from enum value: CRITERION_MARK_NOT_ASSESSED = 3;
+   */
+  NOT_ASSESSED = 3,
+}
+
+/**
+ * Describes the enum novatrail.api.v1.CriterionMark.
+ */
+export declare const CriterionMarkSchema: GenEnum<CriterionMark>;
+
+/**
+ * What the learner model and the history of a profile show: the skill map, on the learner's screen
+ * and in the section for adults, and the progress, which the adult views. Every method carries the
+ * token of the sign-in service and may get the refusals of every request with a token, which the
+ * comment of `AccountService` names with what `app` does on each; a profile that is not the
+ * account's gets `CAUSE_NO_PROFILE`, a learning request of a profile whose consent is not
+ * confirmed `CAUSE_NO_CONSENT`, a request without the right it needs the code `permission_denied`
+ * with no `Refusal`, and a request whose form the contract refuses the code `invalid_argument`
+ * with no `Refusal`. Both repeat by the state of the profile, with no idempotency key.
+ *
+ * @generated from service novatrail.api.v1.ProgressService
+ */
+export declare const ProgressService: GenService<{
+  /**
+   * The state of the skills of a connected module's current version, for the skill map (concepts
+   * 11), as `learner-model` reads it at the time of the request. The graph and its tiers `app`
+   * takes by the digest of the answer, `GetSkillGraph`, so a skill that the current version no
+   * longer names is not on the map. A learning action needs the right `can_learn`, and an action of
+   * an adult `can_view`. Refusals: `CAUSE_NOT_FOUND`, a module not connected, and
+   * `CAUSE_NO_CURRENT_VERSION`.
+   *
+   * @generated from rpc novatrail.api.v1.ProgressService.GetSkillMap
+   */
+  getSkillMap: {
+    methodKind: "unary";
+    input: typeof GetSkillMapRequestSchema;
+    output: typeof GetSkillMapResponseSchema;
+  },
+  /**
+   * The progress of a profile, which an adult views with the right `can_view`: its attempts, newest
+   * first, a page at a time, and the traps that repeat in its closed attempts, with their
+   * descriptions and advice (section 16 of the module format).
+   *
+   * @generated from rpc novatrail.api.v1.ProgressService.GetProgress
+   */
+  getProgress: {
+    methodKind: "unary";
+    input: typeof GetProgressRequestSchema;
+    output: typeof GetProgressResponseSchema;
+  },
+}>;
+