@altnovatrail/contracts 0.8.1 → 0.8.3

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

@@ -0,0 +1,754 @@
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file novatrail/api/v1/learning.proto (package novatrail.api.v1, syntax proto3)
+/* eslint-disable */
+
+// The way from a module to a task in the contract between `app` and `api`: the engine's choice, the
+// beginning of an attempt and the open attempt, and lessons, which `api` leads by lesson runs. What
+// each message means is the rule of contracts/README.md, section 15.
+
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { EngineChoice, RunEnd } from "./cause_pb.js";
+import type { OpenView } from "./package_pb.js";
+import type { ItemVerdict, RungHint, SubmissionEnd } from "./attempt_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+
+/**
+ * Describes the file novatrail/api/v1/learning.proto.
+ */
+export declare const file_novatrail_api_v1_learning: GenFile;
+
+/**
+ * "Something else".
+ *
+ * @generated from message novatrail.api.v1.ChooseNextRequest
+ */
+export declare type ChooseNextRequest = Message<"novatrail.api.v1.ChooseNextRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The idempotency key of this action of the learner.
+   *
+   * @generated from field: string idempotency_key = 2;
+   */
+  idempotencyKey: string;
+
+  /**
+   * The full ID of the skill that the learner chose on the skill map, "novatrail/olympiad-math/
+   * skill/counting-gaps": empty when the engine leads.
+   *
+   * @generated from field: string skill = 3;
+   */
+  skill: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.ChooseNextRequest.
+ * Use `create(ChooseNextRequestSchema)` to create a new message.
+ */
+export declare const ChooseNextRequestSchema: GenMessage<ChooseNextRequest>;
+
+/**
+ * The engine's choice.
+ *
+ * @generated from message novatrail.api.v1.ChooseNextResponse
+ */
+export declare type ChooseNextResponse = Message<"novatrail.api.v1.ChooseNextResponse"> & {
+  /**
+   * The choice.
+   *
+   * @generated from field: novatrail.api.v1.EngineChoice choice = 1;
+   */
+  choice?: EngineChoice | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.ChooseNextResponse.
+ * Use `create(ChooseNextResponseSchema)` to create a new message.
+ */
+export declare const ChooseNextResponseSchema: GenMessage<ChooseNextResponse>;
+
+/**
+ * The beginning of an attempt.
+ *
+ * @generated from message novatrail.api.v1.BeginAttemptRequest
+ */
+export declare type BeginAttemptRequest = Message<"novatrail.api.v1.BeginAttemptRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The idempotency key of this action of the learner.
+   *
+   * @generated from field: string idempotency_key = 2;
+   */
+  idempotencyKey: string;
+
+  /**
+   * What the attempt begins by.
+   *
+   * @generated from oneof novatrail.api.v1.BeginAttemptRequest.start
+   */
+  start: {
+    /**
+     * An engine's choice of a task, `CHOICE_KIND_TASK`: the task, on the current version of its
+     * module.
+     *
+     * @generated from field: string choice_id = 3;
+     */
+    value: string;
+    case: "choiceId";
+  } | {
+    /**
+     * A task segment of an open lesson run, on the run's package: every task segment before it has
+     * ended, and it has not.
+     *
+     * @generated from field: novatrail.api.v1.SegmentPlace segment = 4;
+     */
+    value: SegmentPlace;
+    case: "segment";
+  } | {
+    /**
+     * The same task again, outside a lesson, on the current version of its module: the ID of an
+     * earlier attempt of it, open or closed. A template gives a new seed, and maybe another
+     * instance.
+     *
+     * @generated from field: string previous_attempt_id = 5;
+     */
+    value: string;
+    case: "previousAttemptId";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * The provider of the learner's own key, by its code in the admission table, without the key:
+   * with a profile of its owner that checks the task by its own key, so that `api` chooses the
+   * route to AI for the checks of the beginning, and checks no quota. Empty when platform AI checks
+   * it. Each later request on the attempt that calls AI goes by the `own_key` it carries, or on
+   * platform AI without one, and meets the quota there as an outcome (R84).
+   *
+   * @generated from field: string own_key_provider = 6;
+   */
+  ownKeyProvider: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.BeginAttemptRequest.
+ * Use `create(BeginAttemptRequestSchema)` to create a new message.
+ */
+export declare const BeginAttemptRequestSchema: GenMessage<BeginAttemptRequest>;
+
+/**
+ * The attempt begun.
+ *
+ * @generated from message novatrail.api.v1.BeginAttemptResponse
+ */
+export declare type BeginAttemptResponse = Message<"novatrail.api.v1.BeginAttemptResponse"> & {
+  /**
+   * The attempt.
+   *
+   * @generated from field: novatrail.api.v1.AttemptStart attempt = 1;
+   */
+  attempt?: AttemptStart | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.BeginAttemptResponse.
+ * Use `create(BeginAttemptResponseSchema)` to create a new message.
+ */
+export declare const BeginAttemptResponseSchema: GenMessage<BeginAttemptResponse>;
+
+/**
+ * A task segment of a lesson run.
+ *
+ * @generated from message novatrail.api.v1.SegmentPlace
+ */
+export declare type SegmentPlace = Message<"novatrail.api.v1.SegmentPlace"> & {
+  /**
+   * The lesson run.
+   *
+   * @generated from field: string lesson_run_id = 1;
+   */
+  lessonRunId: string;
+
+  /**
+   * The segment's place among the segments of the lesson, from 1: a segment has no ID.
+   *
+   * @generated from field: int32 segment = 2;
+   */
+  segment: number;
+};
+
+/**
+ * Describes the message novatrail.api.v1.SegmentPlace.
+ * Use `create(SegmentPlaceSchema)` to create a new message.
+ */
+export declare const SegmentPlaceSchema: GenMessage<SegmentPlace>;
+
+/**
+ * An attempt as it begins: what `app` shows the task by.
+ *
+ * @generated from message novatrail.api.v1.AttemptStart
+ */
+export declare type AttemptStart = Message<"novatrail.api.v1.AttemptStart"> & {
+  /**
+   * The ID of the attempt.
+   *
+   * @generated from field: string attempt_id = 1;
+   */
+  attemptId: string;
+
+  /**
+   * The open view of the task, of the instance when the task is a template.
+   *
+   * @generated from field: novatrail.api.v1.OpenView task = 2;
+   */
+  task?: OpenView | undefined;
+
+  /**
+   * The digest of the package the attempt goes on, by which `app` takes the open views of its
+   * manifest, technique catalog and solving steps.
+   *
+   * @generated from field: string package_digest = 3;
+   */
+  packageDigest: string;
+
+  /**
+   * The task segment, when the attempt is one of a lesson run; absent outside a lesson.
+   *
+   * @generated from field: novatrail.api.v1.SegmentPlace segment = 4;
+   */
+  segment?: SegmentPlace | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.AttemptStart.
+ * Use `create(AttemptStartSchema)` to create a new message.
+ */
+export declare const AttemptStartSchema: GenMessage<AttemptStart>;
+
+/**
+ * A request for the open attempt.
+ *
+ * @generated from message novatrail.api.v1.GetOpenAttemptRequest
+ */
+export declare type GetOpenAttemptRequest = Message<"novatrail.api.v1.GetOpenAttemptRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The attempt.
+   *
+   * @generated from field: string attempt_id = 2;
+   */
+  attemptId: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetOpenAttemptRequest.
+ * Use `create(GetOpenAttemptRequestSchema)` to create a new message.
+ */
+export declare const GetOpenAttemptRequestSchema: GenMessage<GetOpenAttemptRequest>;
+
+/**
+ * The open attempt.
+ *
+ * @generated from message novatrail.api.v1.GetOpenAttemptResponse
+ */
+export declare type GetOpenAttemptResponse = Message<"novatrail.api.v1.GetOpenAttemptResponse"> & {
+  /**
+   * The attempt.
+   *
+   * @generated from field: novatrail.api.v1.OpenAttempt attempt = 1;
+   */
+  attempt?: OpenAttempt | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetOpenAttemptResponse.
+ * Use `create(GetOpenAttemptResponseSchema)` to create a new message.
+ */
+export declare const GetOpenAttemptResponseSchema: GenMessage<GetOpenAttemptResponse>;
+
+/**
+ * An open attempt, as the server keeps it: what lets the learner go on with it.
+ *
+ * @generated from message novatrail.api.v1.OpenAttempt
+ */
+export declare type OpenAttempt = Message<"novatrail.api.v1.OpenAttempt"> & {
+  /**
+   * The attempt, as it began.
+   *
+   * @generated from field: novatrail.api.v1.AttemptStart start = 1;
+   */
+  start?: AttemptStart | undefined;
+
+  /**
+   * The verdict of every item at the last submission with a verdict, in the task's order, and what
+   * was read: empty before the first one, and on a task with a rubric.
+   *
+   * @generated from field: repeated novatrail.api.v1.ItemVerdict items = 2;
+   */
+  items: ItemVerdict[];
+
+  /**
+   * How many wrong answers the attempt has.
+   *
+   * @generated from field: int32 wrong_answers = 3;
+   */
+  wrongAnswers: number;
+
+  /**
+   * The current rung and the words the attempt keeps for it, or its fallback text: absent before
+   * the first wrong answer.
+   *
+   * @generated from field: novatrail.api.v1.RungHint rung = 4;
+   */
+  rung?: RungHint | undefined;
+
+  /**
+   * Whether "explain differently" was asked for on the current rung.
+   *
+   * @generated from field: bool explained_differently = 5;
+   */
+  explainedDifferently: boolean;
+
+  /**
+   * The IDs of the techniques given at a step, local IDs of the technique catalog.
+   *
+   * @generated from field: repeated string step_technique_ids = 6;
+   */
+  stepTechniqueIds: string[];
+
+  /**
+   * The IDs of the techniques given on request.
+   *
+   * @generated from field: repeated string requested_technique_ids = 7;
+   */
+  requestedTechniqueIds: string[];
+
+  /**
+   * On a task with a rubric: each submission, in order, with how it ended and when, without the
+   * text read and the words of the feedback, which are nowhere on the server (R87).
+   *
+   * @generated from field: repeated novatrail.api.v1.EssaySubmission essay_submissions = 8;
+   */
+  essaySubmissions: EssaySubmission[];
+};
+
+/**
+ * Describes the message novatrail.api.v1.OpenAttempt.
+ * Use `create(OpenAttemptSchema)` to create a new message.
+ */
+export declare const OpenAttemptSchema: GenMessage<OpenAttempt>;
+
+/**
+ * A submission of an essay as the server keeps it.
+ *
+ * @generated from message novatrail.api.v1.EssaySubmission
+ */
+export declare type EssaySubmission = Message<"novatrail.api.v1.EssaySubmission"> & {
+  /**
+   * 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;
+};
+
+/**
+ * Describes the message novatrail.api.v1.EssaySubmission.
+ * Use `create(EssaySubmissionSchema)` to create a new message.
+ */
+export declare const EssaySubmissionSchema: GenMessage<EssaySubmission>;
+
+/**
+ * The opening of the lesson of an engine's choice.
+ *
+ * @generated from message novatrail.api.v1.OpenLessonRequest
+ */
+export declare type OpenLessonRequest = Message<"novatrail.api.v1.OpenLessonRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The engine's choice of the lesson, `CHOICE_KIND_LESSON`.
+   *
+   * @generated from field: string choice_id = 2;
+   */
+  choiceId: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.OpenLessonRequest.
+ * Use `create(OpenLessonRequestSchema)` to create a new message.
+ */
+export declare const OpenLessonRequestSchema: GenMessage<OpenLessonRequest>;
+
+/**
+ * The lesson opened.
+ *
+ * @generated from message novatrail.api.v1.OpenLessonResponse
+ */
+export declare type OpenLessonResponse = Message<"novatrail.api.v1.OpenLessonResponse"> & {
+  /**
+   * The lesson run.
+   *
+   * @generated from field: novatrail.api.v1.LessonRun run = 1;
+   */
+  run?: LessonRun | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.OpenLessonResponse.
+ * Use `create(OpenLessonResponseSchema)` to create a new message.
+ */
+export declare const OpenLessonResponseSchema: GenMessage<OpenLessonResponse>;
+
+/**
+ * A request for an open lesson run.
+ *
+ * @generated from message novatrail.api.v1.GetLessonRunRequest
+ */
+export declare type GetLessonRunRequest = Message<"novatrail.api.v1.GetLessonRunRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The lesson run.
+   *
+   * @generated from field: string lesson_run_id = 2;
+   */
+  lessonRunId: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetLessonRunRequest.
+ * Use `create(GetLessonRunRequestSchema)` to create a new message.
+ */
+export declare const GetLessonRunRequestSchema: GenMessage<GetLessonRunRequest>;
+
+/**
+ * The open lesson run.
+ *
+ * @generated from message novatrail.api.v1.GetLessonRunResponse
+ */
+export declare type GetLessonRunResponse = Message<"novatrail.api.v1.GetLessonRunResponse"> & {
+  /**
+   * The lesson run.
+   *
+   * @generated from field: novatrail.api.v1.LessonRun run = 1;
+   */
+  run?: LessonRun | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.GetLessonRunResponse.
+ * Use `create(GetLessonRunResponseSchema)` to create a new message.
+ */
+export declare const GetLessonRunResponseSchema: GenMessage<GetLessonRunResponse>;
+
+/**
+ * An open lesson run: what `app` leads the lesson by.
+ *
+ * @generated from message novatrail.api.v1.LessonRun
+ */
+export declare type LessonRun = Message<"novatrail.api.v1.LessonRun"> & {
+  /**
+   * The ID of the run, which every answer about the lesson, an attempt of its segment, and "lesson
+   * done" name.
+   *
+   * @generated from field: string lesson_run_id = 1;
+   */
+  lessonRunId: string;
+
+  /**
+   * The open view of the lesson, whole: its title and its segments, without its skills and age
+   * categories.
+   *
+   * @generated from field: novatrail.api.v1.OpenView lesson = 2;
+   */
+  lesson?: OpenView | undefined;
+
+  /**
+   * The digest of the package the run goes on.
+   *
+   * @generated from field: string package_digest = 3;
+   */
+  packageDigest: string;
+
+  /**
+   * The places of the task segments that have ended, in order.
+   *
+   * @generated from field: repeated int32 ended_segments = 4;
+   */
+  endedSegments: number[];
+
+  /**
+   * The open attempt of a segment of the run, when there is one: `app` opens the lesson at the
+   * later of it and the place it keeps.
+   *
+   * @generated from field: novatrail.api.v1.OpenAttemptRef open_attempt = 5;
+   */
+  openAttempt?: OpenAttemptRef | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.LessonRun.
+ * Use `create(LessonRunSchema)` to create a new message.
+ */
+export declare const LessonRunSchema: GenMessage<LessonRun>;
+
+/**
+ * "Lesson done".
+ *
+ * @generated from message novatrail.api.v1.CompleteLessonRequest
+ */
+export declare type CompleteLessonRequest = Message<"novatrail.api.v1.CompleteLessonRequest"> & {
+  /**
+   * The profile.
+   *
+   * @generated from field: string profile_id = 1;
+   */
+  profileId: string;
+
+  /**
+   * The lesson run.
+   *
+   * @generated from field: string lesson_run_id = 2;
+   */
+  lessonRunId: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.CompleteLessonRequest.
+ * Use `create(CompleteLessonRequestSchema)` to create a new message.
+ */
+export declare const CompleteLessonRequestSchema: GenMessage<CompleteLessonRequest>;
+
+/**
+ * The lesson run ended "passed".
+ *
+ * @generated from message novatrail.api.v1.CompleteLessonResponse
+ */
+export declare type CompleteLessonResponse = Message<"novatrail.api.v1.CompleteLessonResponse"> & {
+  /**
+   * How the run ended, `RUN_END_REASON_PASSED`, and the engine's choice.
+   *
+   * @generated from field: novatrail.api.v1.RunEnd end = 1;
+   */
+  end?: RunEnd | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.CompleteLessonResponse.
+ * Use `create(CompleteLessonResponseSchema)` to create a new message.
+ */
+export declare const CompleteLessonResponseSchema: GenMessage<CompleteLessonResponse>;
+
+/**
+ * The open attempt of a profile, as the list of profiles names it.
+ *
+ * @generated from message novatrail.api.v1.OpenAttemptRef
+ */
+export declare type OpenAttemptRef = Message<"novatrail.api.v1.OpenAttemptRef"> & {
+  /**
+   * The attempt, which `GetOpenAttempt` gives.
+   *
+   * @generated from field: string attempt_id = 1;
+   */
+  attemptId: string;
+
+  /**
+   * Its task segment, when it is an attempt of a lesson run; absent outside a lesson.
+   *
+   * @generated from field: novatrail.api.v1.SegmentPlace segment = 2;
+   */
+  segment?: SegmentPlace | undefined;
+};
+
+/**
+ * Describes the message novatrail.api.v1.OpenAttemptRef.
+ * Use `create(OpenAttemptRefSchema)` to create a new message.
+ */
+export declare const OpenAttemptRefSchema: GenMessage<OpenAttemptRef>;
+
+/**
+ * An open lesson run of a profile, as the list of profiles names it: what a device that keeps no
+ * state of the lesson finds it by.
+ *
+ * @generated from message novatrail.api.v1.LessonRunRef
+ */
+export declare type LessonRunRef = Message<"novatrail.api.v1.LessonRunRef"> & {
+  /**
+   * The lesson run, which `GetLessonRun` gives.
+   *
+   * @generated from field: string lesson_run_id = 1;
+   */
+  lessonRunId: string;
+
+  /**
+   * The full ID of the lesson, "novatrail/olympiad-math/lesson/counting-gaps-1".
+   *
+   * @generated from field: string lesson = 2;
+   */
+  lesson: string;
+
+  /**
+   * The digest of the package the run goes on.
+   *
+   * @generated from field: string package_digest = 3;
+   */
+  packageDigest: string;
+};
+
+/**
+ * Describes the message novatrail.api.v1.LessonRunRef.
+ * Use `create(LessonRunRefSchema)` to create a new message.
+ */
+export declare const LessonRunRefSchema: GenMessage<LessonRunRef>;
+
+/**
+ * The way from a module to a task, from a learner's session: each method is a learning request,
+ * with the right `can_learn`. 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 request of a
+ * profile whose consent is not confirmed `CAUSE_NO_CONSENT`, and a request whose form the contract
+ * refuses the code `invalid_argument` with no `Refusal`. A profile has one open attempt: a new one
+ * closes the one before `CLOSE_REASON_LEFT`. A lesson run goes on the package it began on, and
+ * every attempt of its task segments too. `app` keeps the place in a lesson and the state of its
+ * demos by the key "lesson's full ID, package digest", beside the ID of the run: the state of
+ * another run under the same key it drops, and it erases the state of the lesson at every end of
+ * the run, in an answer or in a refusal.
+ *
+ * @generated from service novatrail.api.v1.LearningService
+ */
+export declare const LearningService: GenService<{
+  /**
+   * "Something else": the engine's choice of what comes next, outside a lesson or in place of one,
+   * when the learner asks for it, or when nothing is open. It closes the open attempt
+   * `CLOSE_REASON_LEFT`, and `app` warns beforehand that the attempt cannot be gone back to. The
+   * choice gives a lesson or a task, or nothing, with the outcome that says why. Refusals:
+   * `CAUSE_NOT_FOUND`, a skill named that no module connected has, `CAUSE_KEY_ALREADY_USED` and
+   * `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets the same choice.
+   *
+   * @generated from rpc novatrail.api.v1.LearningService.ChooseNext
+   */
+  chooseNext: {
+    methodKind: "unary";
+    input: typeof ChooseNextRequestSchema;
+    output: typeof ChooseNextResponseSchema;
+  },
+  /**
+   * Begins an attempt: by an engine's choice of a task, on a task segment of a lesson run, or the
+   * same task again. It closes the open attempt `CLOSE_REASON_LEFT`. A choice begins one attempt:
+   * once it has, another request by it gets `CAUSE_ALREADY_EXISTS`, and `app` reads the open
+   * attempt of the profile; a choice of a lesson gets `invalid_argument`. An attempt on a segment
+   * of a run whose package the image no longer gives ends the run `RUN_END_REASON_UNCHECKED` and
+   * gets `CAUSE_RUN_ENDED`, and `app` then asks `CheckPackages`. The answer is the attempt with
+   * the open view of its task, of an instance when the task is a template; the seed of the attempt
+   * never goes to the device. Refusals: `CAUSE_QUOTA`, `CAUSE_PLATFORM_LIMIT` and
+   * `CAUSE_NOT_ADMITTED`, when platform AI checks the task, and a lesson run stays open on them;
+   * `CAUSE_NOT_SUITABLE`, `CAUSE_NO_CURRENT_VERSION`, `CAUSE_PACKAGE_UNKNOWN`,
+   * `CAUSE_RUN_ENDED`, `CAUSE_SEGMENT_UNAVAILABLE`, `CAUSE_ALREADY_EXISTS`,
+   * `CAUSE_KEY_NOT_FOR_PROFILE`, `CAUSE_NOT_FOUND`, `CAUSE_KEY_ALREADY_USED` and
+   * `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets the same attempt and its open
+   * view.
+   *
+   * @generated from rpc novatrail.api.v1.LearningService.BeginAttempt
+   */
+  beginAttempt: {
+    methodKind: "unary";
+    input: typeof BeginAttemptRequestSchema;
+    output: typeof BeginAttemptResponseSchema;
+  },
+  /**
+   * The open attempt, by which the learner goes on with it, on another device too, with a clean
+   * sheet: the strokes stay on the device that wrote them. Refusals: `CAUSE_NOT_FOUND`,
+   * `CAUSE_ATTEMPT_CLOSED` with its close reason, and `CAUSE_PACKAGE_UNKNOWN`. It repeats by the
+   * state of the attempt.
+   *
+   * @generated from rpc novatrail.api.v1.LearningService.GetOpenAttempt
+   */
+  getOpenAttempt: {
+    methodKind: "unary";
+    input: typeof GetOpenAttemptRequestSchema;
+    output: typeof GetOpenAttemptResponseSchema;
+  },
+  /**
+   * Opens the lesson of an engine's choice: the open run of the lesson, when the profile has one,
+   * or else a new run on the package of the module's current version. A choice opens one run: once
+   * it has ended, the choice gets `CAUSE_RUN_ENDED`, and a new run takes a new choice. Before the
+   * answer `api` checks that the module is connected and has a current version for the learner,
+   * and that the lesson and each of its tasks suit the age category of the profile — on the
+   * package of the run when it is open; a run that fails ends `RUN_END_REASON_NOT_SUITABLE`, and
+   * a run whose package the image no longer gives `RUN_END_REASON_UNCHECKED`, after which `app`
+   * asks `CheckPackages`. A choice of a task gets `invalid_argument`. Refusals:
+   * `CAUSE_NOT_SUITABLE`, `CAUSE_NO_CURRENT_VERSION`, `CAUSE_PACKAGE_UNKNOWN`,
+   * `CAUSE_RUN_ENDED` and `CAUSE_NOT_FOUND`. It carries no idempotency key: it repeats by the
+   * state of the run.
+   *
+   * @generated from rpc novatrail.api.v1.LearningService.OpenLesson
+   */
+  openLesson: {
+    methodKind: "unary";
+    input: typeof OpenLessonRequestSchema;
+    output: typeof OpenLessonResponseSchema;
+  },
+  /**
+   * An open lesson run again, by its ID: after a restart, and on another device. `api` checks it as
+   * `OpenLesson` does. Refusals: `CAUSE_RUN_ENDED`, with how the run ended, and the engine's choice
+   * when this request ended it; `CAUSE_NOT_FOUND` and `CAUSE_PACKAGE_UNKNOWN`. It repeats by the
+   * state of the run.
+   *
+   * @generated from rpc novatrail.api.v1.LearningService.GetLessonRun
+   */
+  getLessonRun: {
+    methodKind: "unary";
+    input: typeof GetLessonRunRequestSchema;
+    output: typeof GetLessonRunResponseSchema;
+  },
+  /**
+   * "Lesson done": `app` sends it when the learner presses "Continue" on the last segment, and
+   * repeats it until `api` answers. It ends the run `RUN_END_REASON_PASSED` once every task segment
+   * has ended, and the answer holds the engine's choice; a repeat on a run that ended so gets the
+   * same answer. Refusals: `CAUSE_SEGMENTS_NOT_ENDED`, with the places of the task segments that
+   * have ended, `CAUSE_RUN_ENDED` with another reason, and `CAUSE_NOT_FOUND`. It carries no
+   * idempotency key: it repeats by the state of the run.
+   *
+   * @generated from rpc novatrail.api.v1.LearningService.CompleteLesson
+   */
+  completeLesson: {
+    methodKind: "unary";
+    input: typeof CompleteLessonRequestSchema;
+    output: typeof CompleteLessonResponseSchema;
+  },
+}>;
+