craterview 0.4.31 → 0.4.34

package/README.md

@@ -28,6 +28,28 @@ both: it reads an image's dimensions from its header — nothing is decoded —
 can tell the API how big your file is and `etaSeconds` is estimated for that file rather
 than for a typical one. `fetch`, `Blob` and `crypto.getRandomValues` are standard in both.
 
+## What it does
+
+Each model has its own page on the site:
+
+- [AI photo enhancer and upscaler](https://craterview.ai/features/enhance): `cv-enhance-v3`
+  enlarges a photo and rebuilds its fine detail at the new size.
+- [AI photo denoiser for grainy, low-light shots](https://craterview.ai/features/denoise):
+  `cv-denoise-v1` takes out the grain and keeps the colours, light and detail.
+- [AI photo restoration for old, damaged prints](https://craterview.ai/features/restore):
+  `cv-restore-v1` removes tears, creases, scratches and dust and corrects faded colour.
+- [AI face enhancer for group photos](https://craterview.ai/features/small-faces):
+  `cv-faces-v1` redraws faces too small or blurred to look natural.
+- [AI headshot generator from a snapshot](https://craterview.ai/features/headshot):
+  `cv-headshot-v1` turns a photo of a person into a professional headshot.
+- [AI image detector](https://craterview.ai/features/real-or-ai): `cv-real-check-v2`
+  estimates whether an image was made by a generative model.
+- [AI content moderation for images](https://craterview.ai/features/content-moderation):
+  `cv-content-check-v1` screens an image against the content policy.
+
+[All features](https://craterview.ai/features) are on one page. What each model costs, its
+limits and its parameters are in the catalogue: `cv.models()`.
+
 ## Quickstart
 
 ```ts

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.31";
+export const VERSION = "0.4.34";
 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.
@@ -1110,8 +1110,12 @@ export class CraterView {
   }
 
   /**
-   * Mint another key. **The value is in this response and nowhere else** — keys are stored
-   * as hashes, so one that is not written down has to be replaced rather than recovered.
+   * Mint another key, named for what will use it. **The value is in this response and
+   * nowhere else** — keys are stored as hashes, so one that is not written down has to be
+   * replaced rather than recovered.
+   *
+   * The name is required: every key on the account is listed by it, with `keys()` and on the
+   * account page, and it is how you tell one from another when you come to revoke one.
    *
    * Several keys on an account is the ordinary arrangement, one per service or environment.
    * They share the account's credits and history. This is also how you rotate without
@@ -1120,7 +1124,7 @@ export class CraterView {
    * An account is given a limited number of new keys an hour, whichever of its keys asks:
    * past it this throws `RateLimited`, whose `retryAfter` says when to ask again.
    */
-  async createKey(name = "api"): Promise<NewKey> {
+  async createKey(name: string): Promise<NewKey> {
     return await this.request("POST", "/v1/keys", { name }) as NewKey;
   }
 

package/package.json

@@ -1,10 +1,24 @@
 {
   "name": "craterview",
-  "version": "0.4.31",
+  "version": "0.4.34",
   "dependencies": {
     "image-size": "^2.0.4"
   },
-  "description": "TypeScript client for the CraterView.ai image enhancement API",
+  "description": "TypeScript client for the CraterView.ai API: AI photo upscaling, denoising, restoration, headshots and AI image detection",
+  "keywords": [
+    "upscaling",
+    "super-resolution",
+    "image-restoration",
+    "api-client",
+    "image-upscaler",
+    "photo-enhancer",
+    "denoising",
+    "photo-restoration",
+    "headshot",
+    "ai-image-detector",
+    "content-moderation",
+    "typescript"
+  ],
   "type": "module",
   "main": "index.ts",
   "types": "index.ts",