craterview 0.4.35 → 0.4.37

package/README.md

@@ -202,6 +202,7 @@ Every field the API publishes on a job is exposed here.
 | `inputUrl` | The picture the model worked from — the region, where you named one |
 | `contentType` | The result's media type |
 | `outputBytes` | The result's size in bytes |
+| `outputWidth`, `outputHeight` | The result's size in pixels |
 | `blob()`, `arrayBuffer()` | Download the result |
 
 `result` is the whole of what the job produced, and the rows above it that describe the
@@ -219,12 +220,12 @@ they are about to send and declare it; the API signs it into the presigned URL,
 accepts exactly that length and nothing else. You do not pass it — it is read off the data
 in hand, which is what makes it impossible to get wrong.
 
-**Running out of credit does not stop you.** A job submitted against a balance of zero is
-accepted, and unless a subscription has work left this period it runs free on the community
-queue, which runs on shared, free capacity and can wait longer at busy times. It comes back with `community`
-set, and `usage()` reports the same flag for your next job before you send it. There is no
-payment error to handle: paying — with credit, or with a subscription — moves work onto paid
-compute that scales with demand, rather than buying the right to submit.
+**Running out of credit does not stop you.** A job at a balance of zero is accepted. Without a
+subscription, or once a limited subscription's monthly allowance is spent, it runs free on the
+community queue: same models, smaller size limits, longer waits at busy times. It comes back with
+`community` set, and `usage()` reports the same flag for your next job before you send it. There
+is no payment error to handle: credit or a subscription moves work onto paid compute that scales
+with demand.
 `etaSeconds` covers the whole wait, queue time included, so a community job simply reports
 a longer one.
 
@@ -321,6 +322,7 @@ old one. You cannot revoke the key you are calling with.
 await cv.models();                            // models, what each takes and answers with, which queue you are on
 await cv.job("job_...");                      // one job by id
 await cv.usage();                             // credit balance, next job's queue, spend and job counts
+await cv.quote("cv-enhance-v3", { scale: 2 }, { inputWidth: 1500, inputHeight: 1000 }); // a job's price and result size, run nothing
 
 for await (const job of cv.jobs({ limit: 50, status: "succeeded" })) {
   console.log(job.id, job.status);            // newest first, paging transparently

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.4.35";
+export const VERSION = "0.4.37";
 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.
@@ -475,12 +475,11 @@ export interface ModelInfo {
    */
   result_schema: Record<string, unknown>;
   /**
-   * Whether your key's work goes to the community queue, which runs on shared, free capacity
-   * and can wait longer at busy times. False while the account is paying — holding credit, or
-   * on a subscription — which puts its work on paid compute that scales with demand.
+   * Whether your next job runs free on the community queue: same models, smaller size limits,
+   * longer waits at busy times. True without credit or a subscription, or once a limited
+   * subscription's monthly allowance is spent. Otherwise it runs on paid compute.
    *
-   * The same field, meaning the same thing, as `Job.community`. How long a wait will be
-   * is answered on the job, once you have one — `Job.eta_seconds` — and nowhere else.
+   * How long a wait will be is answered on the job, once you have one: `Job.eta_seconds`.
    */
   community: boolean;
   /** Of `params_schema`, the ones that apply to still images only. */
@@ -502,6 +501,12 @@ export interface KeyInfo {
    * back in. This client has no method for that call.
    */
   current: boolean;
+  /**
+   * Whether this key belongs to the CraterView.ai app on an iPhone or iPad: the key the
+   * person's devices share, or one device's own. It cannot be revoked by id; the app ends it
+   * when the person signs out in it.
+   */
+  app: boolean;
 }
 
 /** A freshly minted key. The only response that carries a usable value. */
@@ -603,7 +608,7 @@ export interface JobData {
  * A submitted job. Mirrors the API's job representation field for field.
  *
  * `credits` is what you were billed, and it is the only figure about cost the API states.
- * What your balance does not cover is never collected: it is written off when credit next
+ * Nothing is owed for what the balance does not cover: it is written off when credit next
  * arrives or a subscription renews.
  * For how long a job took, `finishedAt` minus `createdAt` is the wait you actually had,
  * queue included — both are here and both are on the webhook, which states the same fields
@@ -629,12 +634,9 @@ export interface JobData {
  * run is done — an estimate that never reaches 1 before the job finishes, and null when none
  * holds. Null while the job is queued and once it has settled.
  *
- * `community` says the job is on the community queue, which runs on shared, free capacity —
- * so it waits longer at busy times, and never stops. That is where an account's work goes
- * when it is not paying: no credit, and no subscription with work left this period. An empty
- * balance is never itself a reason to refuse a job — paying moves work onto paid compute that
- * scales with demand, not the right to submit — but on some models the community queue takes
- * smaller files.
+ * `community` says the job runs free on the community queue: same models, smaller size
+ * limits, longer waits at busy times. A job goes there without credit or a subscription, or
+ * once a limited subscription's monthly allowance is spent. A balance of zero never stops a job.
  * `models()` lists each model's limits for your key, and a file over them is refused with
  * the limit named.
  */
@@ -704,6 +706,10 @@ export class Job {
   }
   get contentType() { return (this.output["content_type"] as string) ?? null; }
   get outputBytes() { return (this.output["bytes"] as number) ?? null; }
+  /** The result's width in pixels. */
+  get outputWidth() { return (this.output["width"] as number) ?? null; }
+  /** The result's height in pixels. */
+  get outputHeight() { return (this.output["height"] as number) ?? null; }
 
   /** Null when absent or unparseable — never a bad Date, which compares false to itself. */
   get createdAt(): Date | null { return this.moment(this.data.created_at); }
@@ -922,10 +928,8 @@ export class CraterView {
    *
    * Prices are published here, so the cost of a job is knowable before submitting it.
    *
-   * `community` and the limits are answered **for the queue your key would use**. The API
-   * looks up the account's standing and reports the queue a job from this key would land
-   * in — so two keys asking at the same moment can get different answers, and paying —
-   * credit or a subscription — changes yours.
+   * `community` and the limits are for your key's next job, so two keys can get different
+   * answers, and credit or a subscription changes yours.
    *
    * A model that is available is not always listed — a model in trial, or being retired,
    * stays usable by name while absent from this catalog.
@@ -1055,7 +1059,8 @@ export class CraterView {
    * time, and `credits_granted` what it has been given. `credits_remaining` is always a
    * number, floored at zero. A balance of zero never stops a
    * submission: `community` says whether your next job runs on the community queue, which is
-   * free and can wait longer at busy times, or on paid compute. `jobs_in_flight` and
+   * free and can wait longer at busy times, or on paid compute. `subscription_allowance` is a
+   * number on a limited subscription and null on an unlimited one. `jobs_in_flight` and
    * `max_jobs_in_flight` are the state of the queue and are what a 429 on submit is about.
    *
    * Account-wide, so every key on an account reports the same figures.
@@ -1064,6 +1069,25 @@ export class CraterView {
     return await this.request("GET", "/v1/usage");
   }
 
+  /**
+   * What a job would cost and how large its result would be, without running it.
+   *
+   * Nothing is uploaded, queued or charged. `inputWidth` and `inputHeight` are the picture's size
+   * the way up a person sees it. A size a job would be refused for is an error with status 422,
+   * in the words the job would fail with.
+   *
+   * The answer has `credits`, or `credits_at_most` where the price is not known yet, `community`
+   * for the queue that price is for, and `result_megapixels` where `scale` sizes the job.
+   */
+  async quote(model: string, params: Record<string, unknown> = {},
+              size: { inputWidth?: number; inputHeight?: number } = {}): Promise<unknown> {
+    return await this.request("POST", "/v1/quotes", {
+      model, params,
+      ...(size.inputWidth !== undefined ? { input_width: size.inputWidth } : {}),
+      ...(size.inputHeight !== undefined ? { input_height: size.inputHeight } : {}),
+    });
+  }
+
   /**
    * The secret your callbacks are signed with, created the first time you ask or with your
    * first delivery, whichever comes first.
@@ -1133,7 +1157,9 @@ export class CraterView {
    *
    * You cannot revoke the key this client is authenticating with: it is refused with status
    * 409, because it would leave you unable to make another. Create a replacement, move onto
-   * it, then revoke this one.
+   * it, then revoke this one. A key of the CraterView.ai app on an iPhone or iPad, which
+   * `keys()` marks `app`, is refused with 409 too: those end when the person signs out in
+   * the app.
    *
    * `keyId` is a key's `id` from `keys()` or `createKey()`, never its value or its prefix.
    * Anything else throws a `CraterViewError` without a request being made.

package/package.json

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