@altnovatrail/contracts 0.0.0-stage → 0.7.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,48 @@
-# Temporary Holding Version
+# @altnovatrail/contracts
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The code of [NovaTrail](https://github.com/altnovatrail)'s API contracts for TypeScript: the messages and enums of each contract, with their descriptors, for [protobuf-es](https://github.com/bufbuild/protobuf-es) and Connect. The contracts are the protobuf files under [`contracts/`](https://github.com/altnovatrail/spec/tree/main/contracts) in `altnovatrail/spec`, and their text is [`contracts/README.md`](https://github.com/altnovatrail/spec/blob/main/contracts/README.md). `protoc-gen-es` generates this code from them: JavaScript with its declarations. Go code takes the same contracts from the Go module `github.com/altnovatrail/spec/contracts`, at the tag `contracts/vX.Y.Z` of the same number.
+
+Each file of code is exported by its path, the path of its `.proto` file with `_pb.js` in the place of `.proto`:
+
+```ts
+import { create, fromJson, toJson } from "@bufbuild/protobuf";
+import { ObservationSchema, Unreadable } from "@altnovatrail/contracts/novatrail/observation/v1/observation_pb.js";
+
+const observation = fromJson(ObservationSchema, json);
+const written = toJson(ObservationSchema, observation, { useProtoFieldName: true });
+```
+
+The code imports the runtime of protobuf-es, `@bufbuild/protobuf`, which the package depends on at the exact version of `protoc-gen-es` that wrote it. Take the runtime at that version too, or let npm install it with the package.
+
+JSON of a contract names each field by its protobuf name, in snake case, as the files of `spec` do: whatever writes it passes `useProtoFieldName: true` to `toJson`. A reader takes both the protobuf name and the lowerCamelCase one, as `fromJson` does ([the contracts' text](https://github.com/altnovatrail/spec/blob/main/contracts/README.md), section 6). The package has no types of JSON: `protoc-gen-es` would spell them in lowerCamelCase.
+
+The package is read through its `exports`, under `"moduleResolution": "nodenext"`, `"node16"` or `"bundler"`. `spec` checks its declarations with TypeScript 7 under both, strictly, and runs its code under Node.
+
+## Versions
+
+The package's version is the tag of the release of `altnovatrail/spec` it comes from, without its `v`: 0.7.0 is `v0.7.0`. Every release from the line 0.7 on carries one, even when the contracts have not changed. Take it at an exact version, the same tag as the `spec` submodule and the Go modules of `spec` you hold, and move all of them together. Leave it out of Dependabot, as the Go modules: a release of `spec` comes out with each change of its documents. Dependabot's `ignore` matches a dependency by the name the manifest gives it, `@altnovatrail/contracts` here, and `github.com/altnovatrail/spec/contracts` for the Go module.
+
+Within a contract's package — its last part, `v1` — a release only adds. A change that breaks it comes as a new package, `v2`, beside the old one, in a new line of `spec` ([the contracts' text](https://github.com/altnovatrail/spec/blob/main/contracts/README.md), section 2).
+
+## Checking the archive
+
+The archive in npm is the file `altnovatrail-contracts-<version>.tgz` of that release, which the release signs with cosign and whose attestation names it. A NovaTrail repository lets the package into its code only once spec's `release-verify-npm` has accepted its lock file, in CI of the pull request that changes it (decision R77 of spec; [RULES.md](https://github.com/altnovatrail/spec/blob/main/RULES.md), Hard rules). It runs from the repository's `spec` submodule:
+
+```sh
+just -f spec/justfile release-verify-npm package-lock.json
+```
+
+For this package, it downloads the archive from the registry and checks it against Sigstore's trust root and the cosign bundle of the file of the same name in the release of `altnovatrail/spec`. The archive must be signed by spec's own `.github/workflows/release.yml` on `main`, and is tied to its tag by the version its `package.json` holds. Last, the lock file's `integrity` must be the hash of the bytes so checked. A single archive, with its bundle beside it, is checked by `just -f spec/justfile release-verify spec v0.7.0 altnovatrail-contracts-0.7.0.tgz`.
+
+The release's attestation ties the archive to the release, not to a commit, and `gh release verify-asset` checks it apart:
+
+```sh
+npm pack @altnovatrail/contracts@0.7.0
+gh release verify-asset v0.7.0 altnovatrail-contracts-0.7.0.tgz -R altnovatrail/spec
+```
+
+The release publishes that file to npm itself, by trusted publishing, and npm gives each version it publishes that way a provenance attestation. The provenance names `.github/workflows/release.yml` of `altnovatrail/spec` and the commit of the run that published it, which is the tip of `main` when the run began rather than always the commit the release was cut from. 0.7.0 was published by hand and has no provenance. A release whose run did not publish its version — one that came out before the release published this package, or one whose publish failed and was not run again — has none in npm, so take a tag whose version is there.
+
+## License
+
+[Apache-2.0](https://github.com/altnovatrail/spec/blob/main/LICENSE). The runtime, `@bufbuild/protobuf`, is under Apache-2.0 and BSD-3-Clause.

package/novatrail/observation/v1/observation_pb.d.ts

@@ -0,0 +1,222 @@
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file novatrail/observation/v1/observation.proto (package novatrail.observation.v1, syntax proto3)
+/* eslint-disable */
+
+// The observation: what AI read in a learner's work, answer slot by answer slot, before any check
+// runs. A reader of `tutor` gives one; `module-kit` joins the observations of two readers into one
+// and gives the verdict on it. What the messages mean, how two observations are joined and which
+// verdict an observation gives are the rules of contracts/README.md, section 10.
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file novatrail/observation/v1/observation.proto.
+ */
+export declare const file_novatrail_observation_v1_observation: GenFile;
+
+/**
+ * What AI read in a work: one reader's observation, or the one that `module-kit` joins from two.
+ *
+ * @generated from message novatrail.observation.v1.Observation
+ */
+export declare type Observation = Message<"novatrail.observation.v1.Observation"> & {
+  /**
+   * Every answer slot whose answer AI reads, each once, in the task's order: items by their place,
+   * and answer slots by their place in the item. On a handwriting sheet these are the slots bound
+   * `anywhere`, `zone` and `sheet`; on a workbook, every box. A slot bound `choice` is tapped, not
+   * read, and is not here.
+   *
+   * @generated from field: repeated novatrail.observation.v1.AnswerSlotObservation answer_slots = 1;
+   */
+  answerSlots: AnswerSlotObservation[];
+};
+
+/**
+ * Describes the message novatrail.observation.v1.Observation.
+ * Use `create(ObservationSchema)` to create a new message.
+ */
+export declare const ObservationSchema: GenMessage<Observation>;
+
+/**
+ * What was read in one answer slot.
+ *
+ * @generated from message novatrail.observation.v1.AnswerSlotObservation
+ */
+export declare type AnswerSlotObservation = Message<"novatrail.observation.v1.AnswerSlotObservation"> & {
+  /**
+   * The answer slot.
+   *
+   * @generated from field: novatrail.observation.v1.AnswerSlotPlace answer_slot = 1;
+   */
+  answerSlot?: AnswerSlotPlace | undefined;
+
+  /**
+   * What the reading gives: a value, or why it gives none.
+   *
+   * @generated from oneof novatrail.observation.v1.AnswerSlotObservation.read
+   */
+  read: {
+    /**
+     * The value as it is written, never empty: the reader does not normalize it
+     * (contracts/README.md, section 10). In a slot bound `sheet`, the text of the essay.
+     *
+     * @generated from field: string value = 2;
+     */
+    value: string;
+    case: "value";
+  } | {
+    /**
+     * Why the reading gives no value.
+     *
+     * @generated from field: novatrail.observation.v1.Unreadable unreadable = 3;
+     */
+    value: Unreadable;
+    case: "unreadable";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * Where the value stands on the crop: only in a slot bound `anywhere`, only beside a value, and
+   * only when the reader names a valid box. In every other slot the place is the answer slot
+   * itself.
+   *
+   * @generated from field: novatrail.observation.v1.CropBox crop_box = 4;
+   */
+  cropBox?: CropBox | undefined;
+};
+
+/**
+ * Describes the message novatrail.observation.v1.AnswerSlotObservation.
+ * Use `create(AnswerSlotObservationSchema)` to create a new message.
+ */
+export declare const AnswerSlotObservationSchema: GenMessage<AnswerSlotObservation>;
+
+/**
+ * An answer slot by its place, which has no ID: its item's place among the task's items, and its
+ * place among the item's answer slots, each from 1. On a workbook an answer slot is a box.
+ *
+ * @generated from message novatrail.observation.v1.AnswerSlotPlace
+ */
+export declare type AnswerSlotPlace = Message<"novatrail.observation.v1.AnswerSlotPlace"> & {
+  /**
+   * The item's place among the task's items, from 1.
+   *
+   * @generated from field: int32 item = 1;
+   */
+  item: number;
+
+  /**
+   * The answer slot's place among the item's answer slots, from 1.
+   *
+   * @generated from field: int32 slot = 2;
+   */
+  slot: number;
+};
+
+/**
+ * Describes the message novatrail.observation.v1.AnswerSlotPlace.
+ * Use `create(AnswerSlotPlaceSchema)` to create a new message.
+ */
+export declare const AnswerSlotPlaceSchema: GenMessage<AnswerSlotPlace>;
+
+/**
+ * A box on the crop the device sent, in whole thousandths of the crop's height and width, from 0
+ * to 1000, as [ymin, xmin, ymax, xmax]: ymin < ymax and xmin < xmax (R53).
+ *
+ * @generated from message novatrail.observation.v1.CropBox
+ */
+export declare type CropBox = Message<"novatrail.observation.v1.CropBox"> & {
+  /**
+   * The top edge, in thousandths of the crop's height.
+   *
+   * @generated from field: int32 ymin = 1;
+   */
+  ymin: number;
+
+  /**
+   * The left edge, in thousandths of the crop's width.
+   *
+   * @generated from field: int32 xmin = 2;
+   */
+  xmin: number;
+
+  /**
+   * The bottom edge, in thousandths of the crop's height.
+   *
+   * @generated from field: int32 ymax = 3;
+   */
+  ymax: number;
+
+  /**
+   * The right edge, in thousandths of the crop's width.
+   *
+   * @generated from field: int32 xmax = 4;
+   */
+  xmax: number;
+};
+
+/**
+ * Describes the message novatrail.observation.v1.CropBox.
+ * Use `create(CropBoxSchema)` to create a new message.
+ */
+export declare const CropBoxSchema: GenMessage<CropBox>;
+
+/**
+ * Why a reading gives an answer slot no value. In a slot whose check gives a verdict, each makes
+ * the verdict `unreadable`, with the reason named as the value is, in lower case and without its
+ * prefix; an essay that is blank or illegible does not reach the assessment by its rubric
+ * (contracts/README.md, section 10).
+ *
+ * @generated from enum novatrail.observation.v1.Unreadable
+ */
+export enum Unreadable {
+  /**
+   * No reason: never sent. An observation that holds it, or a reason its reader does not know, is
+   * not valid.
+   *
+   * @generated from enum value: UNREADABLE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Nothing is written in the slot. On a workbook, a box that sends no crop.
+   *
+   * @generated from enum value: UNREADABLE_BLANK = 1;
+   */
+  BLANK = 1,
+
+  /**
+   * Something is written, and it cannot be read.
+   *
+   * @generated from enum value: UNREADABLE_ILLEGIBLE = 2;
+   */
+  ILLEGIBLE = 2,
+
+  /**
+   * What is written can be read more than one way: a digit written mirrored, a value with another
+   * reading, or two readers who read it differently.
+   *
+   * @generated from enum value: UNREADABLE_AMBIGUOUS = 3;
+   */
+  AMBIGUOUS = 3,
+
+  /**
+   * In a slot bound `anywhere`: the work holds no final answer.
+   *
+   * @generated from enum value: UNREADABLE_NO_FINAL_ANSWER = 4;
+   */
+  NO_FINAL_ANSWER = 4,
+
+  /**
+   * In a slot bound `anywhere`: the work holds more than one final answer.
+   *
+   * @generated from enum value: UNREADABLE_SEVERAL_FINAL_ANSWERS = 5;
+   */
+  SEVERAL_FINAL_ANSWERS = 5,
+}
+
+/**
+ * Describes the enum novatrail.observation.v1.Unreadable.
+ */
+export declare const UnreadableSchema: GenEnum<Unreadable>;
+

package/novatrail/observation/v1/observation_pb.js

@@ -0,0 +1,62 @@
+// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file novatrail/observation/v1/observation.proto (package novatrail.observation.v1, syntax proto3)
+/* eslint-disable */
+
+// The observation: what AI read in a learner's work, answer slot by answer slot, before any check
+// runs. A reader of `tutor` gives one; `module-kit` joins the observations of two readers into one
+// and gives the verdict on it. What the messages mean, how two observations are joined and which
+// verdict an observation gives are the rules of contracts/README.md, section 10.
+
+import { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+
+/**
+ * Describes the file novatrail/observation/v1/observation.proto.
+ */
+export const file_novatrail_observation_v1_observation = /*@__PURE__*/
+  fileDesc("Cipub3ZhdHJhaWwvb2JzZXJ2YXRpb24vdjEvb2JzZXJ2YXRpb24ucHJvdG8SGG5vdmF0cmFpbC5vYnNlcnZhdGlvbi52MSJUCgtPYnNlcnZhdGlvbhJFCgxhbnN3ZXJfc2xvdHMYASADKAsyLy5ub3ZhdHJhaWwub2JzZXJ2YXRpb24udjEuQW5zd2VyU2xvdE9ic2VydmF0aW9uIuEBChVBbnN3ZXJTbG90T2JzZXJ2YXRpb24SPgoLYW5zd2VyX3Nsb3QYASABKAsyKS5ub3ZhdHJhaWwub2JzZXJ2YXRpb24udjEuQW5zd2VyU2xvdFBsYWNlEg8KBXZhbHVlGAIgASgJSAASOgoKdW5yZWFkYWJsZRgDIAEoDjIkLm5vdmF0cmFpbC5vYnNlcnZhdGlvbi52MS5VbnJlYWRhYmxlSAASMwoIY3JvcF9ib3gYBCABKAsyIS5ub3ZhdHJhaWwub2JzZXJ2YXRpb24udjEuQ3JvcEJveEIGCgRyZWFkIi0KD0Fuc3dlclNsb3RQbGFjZRIMCgRpdGVtGAEgASgFEgwKBHNsb3QYAiABKAUiQQoHQ3JvcEJveBIMCgR5bWluGAEgASgFEgwKBHhtaW4YAiABKAUSDAoEeW1heBgDIAEoBRIMCgR4bWF4GAQgASgFKrgBCgpVbnJlYWRhYmxlEhoKFlVOUkVBREFCTEVfVU5TUEVDSUZJRUQQABIUChBVTlJFQURBQkxFX0JMQU5LEAESGAoUVU5SRUFEQUJMRV9JTExFR0lCTEUQAhIYChRVTlJFQURBQkxFX0FNQklHVU9VUxADEh4KGlVOUkVBREFCTEVfTk9fRklOQUxfQU5TV0VSEAQSJAogVU5SRUFEQUJMRV9TRVZFUkFMX0ZJTkFMX0FOU1dFUlMQBUKBAgocY29tLm5vdmF0cmFpbC5vYnNlcnZhdGlvbi52MUIQT2JzZXJ2YXRpb25Qcm90b1ABWk1naXRodWIuY29tL2FsdG5vdmF0cmFpbC9zcGVjL2NvbnRyYWN0cy9ub3ZhdHJhaWwvb2JzZXJ2YXRpb24vdjE7b2JzZXJ2YXRpb252MaICA05PWKoCGE5vdmF0cmFpbC5PYnNlcnZhdGlvbi5WMcoCGE5vdmF0cmFpbFxPYnNlcnZhdGlvblxWMeICJE5vdmF0cmFpbFxPYnNlcnZhdGlvblxWMVxHUEJNZXRhZGF0YeoCGk5vdmF0cmFpbDo6T2JzZXJ2YXRpb246OlYxYgZwcm90bzM");
+
+/**
+ * Describes the message novatrail.observation.v1.Observation.
+ * Use `create(ObservationSchema)` to create a new message.
+ */
+export const ObservationSchema = /*@__PURE__*/
+  messageDesc(file_novatrail_observation_v1_observation, 0);
+
+/**
+ * Describes the message novatrail.observation.v1.AnswerSlotObservation.
+ * Use `create(AnswerSlotObservationSchema)` to create a new message.
+ */
+export const AnswerSlotObservationSchema = /*@__PURE__*/
+  messageDesc(file_novatrail_observation_v1_observation, 1);
+
+/**
+ * Describes the message novatrail.observation.v1.AnswerSlotPlace.
+ * Use `create(AnswerSlotPlaceSchema)` to create a new message.
+ */
+export const AnswerSlotPlaceSchema = /*@__PURE__*/
+  messageDesc(file_novatrail_observation_v1_observation, 2);
+
+/**
+ * Describes the message novatrail.observation.v1.CropBox.
+ * Use `create(CropBoxSchema)` to create a new message.
+ */
+export const CropBoxSchema = /*@__PURE__*/
+  messageDesc(file_novatrail_observation_v1_observation, 3);
+
+/**
+ * Describes the enum novatrail.observation.v1.Unreadable.
+ */
+export const UnreadableSchema = /*@__PURE__*/
+  enumDesc(file_novatrail_observation_v1_observation, 0);
+
+/**
+ * Why a reading gives an answer slot no value. In a slot whose check gives a verdict, each makes
+ * the verdict `unreadable`, with the reason named as the value is, in lower case and without its
+ * prefix; an essay that is blank or illegible does not reach the assessment by its rubric
+ * (contracts/README.md, section 10).
+ *
+ * @generated from enum novatrail.observation.v1.Unreadable
+ */
+export const Unreadable = /*@__PURE__*/
+  tsEnum(UnreadableSchema);
+

package/package.json

@@ -1,6 +1,25 @@
 {
   "name": "@altnovatrail/contracts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.7.1",
+  "description": "The code of NovaTrail's API contracts for TypeScript, which protoc-gen-es generates from their protobuf files: the messages and enums of each contract, with their descriptors, for @bufbuild/protobuf and Connect.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/altnovatrail/spec.git"
+  },
+  "type": "module",
+  "exports": {
+    "./novatrail/observation/v1/observation_pb.js": {
+      "types": "./novatrail/observation/v1/observation_pb.d.ts",
+      "default": "./novatrail/observation/v1/observation_pb.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "novatrail"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@bufbuild/protobuf": "2.16.0"
+  }
+}