craterview 0.3.18 → 0.3.19

package/README.md

@@ -164,17 +164,17 @@ Every field the API publishes on a job is exposed here.
 | `etaSeconds` | Seconds until the job is expected to finish, recomputed on every read — it counts down while the job runs. Absent once the job has settled. Estimated for your image's size when `upload()` could read it (or when you pass `inputMegapixels` to `submit()`), for a typical image otherwise |
 | `community` | True when the job is on the community queue: served after priority work, always taking a share of it, so it never stalls behind paid work |
 | `outputUrl`, `downloadUrl` | The result, presigned. One to display, one to save |
-| `thumbUrl` | A small JPEG of the result, for listings. Null when none was drawn |
+| `thumbnailUrl` | A small JPEG of the job's picture, for listings — the result, or what the model worked from when it produced no file. Null when none was drawn |
 | `inputUrl` | The picture the model worked from — the region, where you named one |
 | `alphaUrl` | Only for a JPEG result of a picture with transparency, which JPEG cannot hold: the transparency as a grayscale JPEG, white where opaque. The result is then the colour alone |
 | `contentType` | The result's media type |
 | `outputBytes` | The result's size in bytes |
 | `blob()`, `arrayBuffer()` | Download the result |
 
-`result` is the whole of what the job produced, and the five rows above it that describe the
-file are getters onto `result.output` rather than separate fields — the API states those links
-once. A model with no file to hand back returns its answer in `result` and leaves every one of
-them null; the fields it answers with are its `result_schema` in `cv.models()`.
+`result` is the whole of what the job produced, and the rows above it that describe the
+result's file are getters onto `result.output` rather than separate fields — the API states
+those links once. A model with no file to hand back returns its answer in `result` and leaves
+every one of them null; the fields it answers with are its `result_schema` in `cv.models()`.
 
 `credits` is the only figure about cost the API states, and the price is fixed and published
 per model, so an invoice reconciles against `credits` alone. For how long a job took, subtract
@@ -198,13 +198,13 @@ a longer one.
 is signed in, so the second cannot be derived from the first. Both expire, so fetch the
 result rather than storing the link.
 
-`thumbUrl` and `inputUrl` are for building a job listing: a few-hundred-pixel preview so a
-page of results costs kilobytes, and the picture the model worked from so a result can be
+`thumbnailUrl` and `inputUrl` are for building a job listing: a few-hundred-pixel preview so a
+page of jobs costs kilobytes, and the picture the model worked from so a result can be
 shown against it. Where you named a region, `inputUrl` is that region — so a before-and-after
 is a true pair, and what was used is something you can look at rather than something to take
 on trust. It is not the file you uploaded: yours stays yours and is removed on its own
-schedule. Both expire with the result. A model that produces no file has no `thumbUrl`, but still
-has the picture it answered about.
+schedule. Both expire with the job's other pictures. A model that produces no file has no
+result to preview, so `thumbnailUrl` is a preview of the picture it answered about.
 
 ## Webhooks
 

package/index.ts

@@ -18,7 +18,7 @@ import { imageSize } from "image-size";
 // Mirrored from package.json, which is the number a release bumps. It cannot be imported
 // from there — this ships as TypeScript, so the import would have to resolve in the
 // consumer's toolchain — so test/version.test.ts asserts the two agree.
-export const VERSION = "0.3.18";
+export const VERSION = "0.3.19";
 const DEFAULT_BASE_URL = "https://api.craterview.ai";
 // The server rejects a longer wait outright, so asking for one costs a 422 rather than the
 // wait you asked for. `run()` clamps to this rather than letting that happen.
@@ -395,6 +395,12 @@ export interface JobData {
    * read them out of `result.output`.
    */
   result?: Record<string, unknown> | null;
+  /**
+   * A small JPEG of the job's picture, for a listing: the result, or the image the model
+   * worked from when it produced no file. Absent until the job succeeds, where none could be
+   * drawn, and once the job's pictures are deleted.
+   */
+  thumbnail_url?: string | null;
   /** Whole credits. TypeScript cannot say integer, but the API only ever sends one. */
   credits?: number | null;
   eta_seconds?: number | null;
@@ -423,17 +429,18 @@ export interface JobData {
  * by the same names.
  *
  * `result` is the whole of what the job produced. Where the model wrote a file,
- * `result.output` carries its links, and `outputUrl` / `downloadUrl` / `thumbUrl` /
+ * `result.output` carries its links, and `outputUrl` / `downloadUrl` /
  * `contentType` / `outputBytes` read out of it. `outputUrl` and `downloadUrl` are the same
  * object signed two ways: one to display, one to hand a person as a file. The disposition
  * is signed in, so the second cannot be derived from the first without the storage
  * credential. Both are presigned and expire — fetch the result rather than storing the link.
  *
- * `thumbUrl` is a small JPEG of the result, for showing a page of jobs without downloading
- * a page of full-size outputs. `inputUrl` is the picture the model worked from, so a result
- * can be shown against what it was made from. Both expire with the result. `alphaUrl` is
- * there only when you asked for a JPEG of a picture with transparency: the transparency, as
- * a file of its own.
+ * `thumbnailUrl` is a small JPEG of the job's picture — the result, or the image the model
+ * worked from when it produced no file — for showing a page of jobs without downloading a
+ * page of full-size pictures. `inputUrl` is the picture the model worked from, so a result
+ * can be shown against what it was made from. Both expire with the job's other pictures.
+ * `alphaUrl` is there only when you asked for a JPEG of a picture with transparency: the
+ * transparency, as a file of its own.
  *
  * `etaSeconds` is the whole of what is reported about waiting: how long until the result,
  * counting time spent waiting for a GPU as well as time spent on one. An estimate and never
@@ -468,6 +475,8 @@ export class Job {
   get flagged() { return this.data.flagged ?? null; }
   /** Retained past the ordinary expiry because you asked. */
   get kept() { return this.data.kept ?? false; }
+  /** A small JPEG of the job's picture, for a listing. Null where there is none. */
+  get thumbnailUrl() { return this.data.thumbnail_url ?? null; }
   /** Where this job stands with the public gallery, or null when it is not offered. */
   get gallery() { return this.data.gallery ?? null; }
   /** The whole answer, including where the file is when there is one. */
@@ -491,7 +500,6 @@ export class Job {
    * the disposition is signed in, so re-signing needs the storage credential.
    */
   get downloadUrl() { return (this.output["download_url"] as string) ?? null; }
-  get thumbUrl() { return (this.output["thumbnail_url"] as string) ?? null; }
   /**
    * A link to the picture the model worked from. Where you named a region, this is that
    * region — so what was used is something you can look at rather than something to take on

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "craterview",
-  "version": "0.3.18",
+  "version": "0.3.19",
   "dependencies": {
     "image-size": "^2.0.4"
   },