@giveitsmaller/contracts 0.32.0 → 0.34.0

package/availability/availability.json

@@ -1,5 +1,5 @@
 {
-  "capabilities_version": 114,
+  "capabilities_version": 116,
   "endpoints": {
     "DELETE /api/auth/api-keys/{apiKeyId}": {
       "auth": "required",
@@ -1063,7 +1063,7 @@
             "colorspace": {
               "availability": "planned",
               "default": "unchanged",
-              "description": "Output color space. `planned` \u2014 not yet read by the worker.",
+              "description": "Output color space. `planned` \u2014 not yet read by the worker (use `grayscale` for grayscale conversion).",
               "type": "enum",
               "values": [
                 "unchanged",
@@ -1078,26 +1078,35 @@
               "description": "Flatten interactive form fields into static content. `planned` \u2014 not yet read by the worker.",
               "type": "boolean"
             },
+            "grayscale": {
+              "default": false,
+              "description": "Convert all images to grayscale (smaller output; discards colour). Worker-honored.",
+              "type": "boolean"
+            },
+            "image_dpi": {
+              "description": "Downsample images above this DPI (72\u2013600 inclusive). Omit to keep the worker's DPI analysis. Out-of-range is rejected as invalid_options.",
+              "max": 600,
+              "min": 72,
+              "type": "integer"
+            },
             "pages": {
               "availability": "planned",
               "description": "Page selection (e.g. '1-5,8,10-12'). Omit to keep all pages. `planned` \u2014 not yet read by the worker.",
               "type": "string"
             },
             "profile": {
-              "availability": "planned",
-              "default": "web",
-              "description": "Optimization profile. web = aggressive (downsample images, strip metadata), print = preserve quality, archive = PDF/A compliance, max = smallest file. `planned` \u2014 not yet read by the worker (use `quality`).",
+              "description": "Ghostscript optimization preset, pinned directly (overrides the quality\u2192preset mapping). screen = lowest-res / smallest, ebook = mid, printer = 300dpi, prepress = print-production. Optional \u2014 omit to let `quality` drive the preset.",
               "type": "enum",
               "values": [
-                "web",
-                "print",
-                "archive",
-                "max"
+                "screen",
+                "ebook",
+                "printer",
+                "prepress"
               ]
             },
             "quality": {
               "default": 50,
-              "description": "Compression quality (1 = smallest, 100 = best). Maps to a document compression preset (the only worker-honored document option today).",
+              "description": "Compression quality (1 = smallest, 100 = best). Maps to a Ghostscript preset. Overridden by `profile` when that is set.",
               "max": 100,
               "min": 1,
               "type": "integer"
@@ -1105,19 +1114,56 @@
           }
         },
         "image": {
+          "max_output_pixels": 16000000,
           "mimes": [
-            "image/webp",
             "image/gif",
-            "image/svg+xml",
             "image/tiff"
           ],
           "options": {
+            "fit": {
+              "default": "max",
+              "depends_on": {
+                "height": "set",
+                "logic": "or",
+                "width": "set"
+              },
+              "description": "Resize mode. max = fit within bounds (preserves aspect ratio, no crop), crop/scale = exact dimensions. Applies only when width or height is set, on whichever Output route runs.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "type": "enum",
+              "values": [
+                "max",
+                "crop",
+                "scale"
+              ]
+            },
+            "height": {
+              "description": "Resize-inside-Output: target height in pixels (1-16384; width*height <= max_output_pixels). Resize replaces the image (one output). Optional \u2014 see `width`.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
+            },
             "metadata": {
               "default": "all",
-              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP \u2014 the only supported behaviour (the compress worker always strips; preservation is not currently available).",
+              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP (default, the only live behaviour \u2014 the compress worker hardcodes keep_metadata=false). `keep` = preserve metadata \u2014 `planned` (the worker cannot preserve it yet; un-hardcoding keep_metadata is the Phase 1 keep/strip toggle). Optimiser (same_format) route \u2014 the format-change transcoder has no metadata-preservation control today.",
+              "honored_on": [
+                "same_format"
+              ],
+              "per_value_availability": {
+                "keep": {
+                  "availability": "planned"
+                }
+              },
               "type": "enum",
               "values": [
-                "all"
+                "all",
+                "keep"
               ]
             },
             "output_format": {
@@ -1132,31 +1178,86 @@
             "quality": {
               "default": 80,
               "description": "Compression quality (1 = smallest file, 100 = best quality). For animated GIF the worker honours this but real-world size reduction is typically small.",
+              "honored_on": [
+                "same_format"
+              ],
               "max": 100,
               "min": 1,
               "type": "integer"
+            },
+            "width": {
+              "description": "Resize-inside-Output: target width in pixels (1-16384; width*height <= max_output_pixels). Resize the image as part of Output (replace semantics, ONE transformed output) using the proven image resize engine (Lanczos, shared with thumbnail-images) \u2014 it is NOT the derivative `thumbnail` op. Optional; omit to keep the source dimensions.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
             }
           }
         },
         "image_avif": {
           "availability": "beta",
+          "max_output_pixels": 16000000,
           "mimes": [
             "image/avif"
           ],
           "options": {
             "avif_speed": {
               "default": 4,
-              "description": "AVIF encode speed (1-10, ravif). Lower = smaller file, slower encode; higher = faster, larger. Default 4.",
+              "description": "AVIF encode speed (1-10, ravif). Lower = smaller file, slower encode; higher = faster, larger. Default 4. Optimiser (same_format) route.",
+              "honored_on": [
+                "same_format"
+              ],
               "max": 10,
               "min": 1,
               "type": "integer"
             },
+            "fit": {
+              "default": "max",
+              "depends_on": {
+                "height": "set",
+                "logic": "or",
+                "width": "set"
+              },
+              "description": "Resize mode. max = fit within bounds (preserves aspect ratio, no crop), crop/scale = exact dimensions. Applies only when width or height is set, on whichever Output route runs.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "type": "enum",
+              "values": [
+                "max",
+                "crop",
+                "scale"
+              ]
+            },
+            "height": {
+              "description": "Resize-inside-Output: target height in pixels (1-16384; width*height <= max_output_pixels). Resize replaces the image (one output). Optional \u2014 see `width`.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
+            },
             "metadata": {
               "default": "all",
-              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP \u2014 the only supported behaviour (the compress worker always strips; preservation is not currently available).",
+              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP (default, the only live behaviour \u2014 the compress worker hardcodes keep_metadata=false). `keep` = preserve metadata \u2014 `planned` (the worker cannot preserve it yet; un-hardcoding keep_metadata is the Phase 1 keep/strip toggle). Optimiser (same_format) route \u2014 the format-change transcoder has no metadata-preservation control today.",
+              "honored_on": [
+                "same_format"
+              ],
+              "per_value_availability": {
+                "keep": {
+                  "availability": "planned"
+                }
+              },
               "type": "enum",
               "values": [
-                "all"
+                "all",
+                "keep"
               ]
             },
             "output_format": {
@@ -1171,23 +1272,84 @@
             "quality": {
               "default": 80,
               "description": "Compression quality (1 = smallest file, 100 = best quality).",
+              "honored_on": [
+                "same_format"
+              ],
               "max": 100,
               "min": 1,
               "type": "integer"
+            },
+            "width": {
+              "description": "Resize-inside-Output: target width in pixels (1-16384; width*height <= max_output_pixels). Resize the image as part of Output (replace semantics, ONE transformed output) using the proven image resize engine (Lanczos, shared with thumbnail-images) \u2014 it is NOT the derivative `thumbnail` op. Optional; omit to keep the source dimensions.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
             }
           }
         },
         "image_jpeg": {
+          "max_output_pixels": 16000000,
           "mimes": [
             "image/jpeg"
           ],
           "options": {
+            "fit": {
+              "default": "max",
+              "depends_on": {
+                "height": "set",
+                "logic": "or",
+                "width": "set"
+              },
+              "description": "Resize mode. max = fit within bounds (preserves aspect ratio, no crop), crop/scale = exact dimensions. Applies only when width or height is set, on whichever Output route runs.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "type": "enum",
+              "values": [
+                "max",
+                "crop",
+                "scale"
+              ]
+            },
+            "height": {
+              "description": "Resize-inside-Output: target height in pixels (1-16384; width*height <= max_output_pixels). Resize replaces the image (one output). Optional \u2014 see `width`.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
+            },
+            "lossless": {
+              "availability": "planned",
+              "default": false,
+              "description": "Encode losslessly (JPEG optimiser path). `planned` \u2014 the worker carries a `lossless` bool the API has never emitted (product-parked: a lossless output can be LARGER than lossy). Optimiser (same_format) route only.",
+              "honored_on": [
+                "same_format"
+              ],
+              "type": "boolean"
+            },
             "metadata": {
               "default": "all",
-              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP \u2014 the only supported behaviour (the compress worker always strips; preservation is not currently available).",
+              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP (default, the only live behaviour \u2014 the compress worker hardcodes keep_metadata=false). `keep` = preserve metadata \u2014 `planned` (the worker cannot preserve it yet; un-hardcoding keep_metadata is the Phase 1 keep/strip toggle). Optimiser (same_format) route \u2014 the format-change transcoder has no metadata-preservation control today.",
+              "honored_on": [
+                "same_format"
+              ],
+              "per_value_availability": {
+                "keep": {
+                  "availability": "planned"
+                }
+              },
               "type": "enum",
               "values": [
-                "all"
+                "all",
+                "keep"
               ]
             },
             "output_format": {
@@ -1201,34 +1363,101 @@
             },
             "progressive": {
               "default": true,
-              "description": "Enable progressive JPEG rendering (a low-quality preview renders first, then refines). JPEG only.",
+              "description": "Enable progressive JPEG rendering (a low-quality preview renders first, then refines). JPEG only \u2014 the optimiser (same_format) route.",
+              "honored_on": [
+                "same_format"
+              ],
               "type": "boolean"
             },
             "quality": {
               "default": 80,
               "description": "Compression quality (1 = smallest file, 100 = best quality).",
+              "honored_on": [
+                "same_format"
+              ],
               "max": 100,
               "min": 1,
               "type": "integer"
+            },
+            "width": {
+              "description": "Resize-inside-Output: target width in pixels (1-16384; width*height <= max_output_pixels). Resize the image as part of Output (replace semantics, ONE transformed output) using the proven image resize engine (Lanczos, shared with thumbnail-images) \u2014 it is NOT the derivative `thumbnail` op. Optional; omit to keep the source dimensions.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
             }
           }
         },
         "image_png": {
+          "max_output_pixels": 16000000,
           "mimes": [
             "image/png"
           ],
           "options": {
+            "fit": {
+              "default": "max",
+              "depends_on": {
+                "height": "set",
+                "logic": "or",
+                "width": "set"
+              },
+              "description": "Resize mode. max = fit within bounds (preserves aspect ratio, no crop), crop/scale = exact dimensions. Applies only when width or height is set, on whichever Output route runs.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "type": "enum",
+              "values": [
+                "max",
+                "crop",
+                "scale"
+              ]
+            },
+            "height": {
+              "description": "Resize-inside-Output: target height in pixels (1-16384; width*height <= max_output_pixels). Resize replaces the image (one output). Optional \u2014 see `width`.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
+            },
+            "lossy": {
+              "availability": "planned",
+              "default": false,
+              "description": "Lossy PNG palette quantization (pngquant/imagequant-class) \u2014 a large saving for flat-colour PNGs. `planned` AND LICENSING-GATED: do not stable-flip until the lambdas licensing spike confirms a permissive quantizer path (libimagequant/pngquant is GPL-or-commercial). Optimiser (same_format) route only.",
+              "honored_on": [
+                "same_format"
+              ],
+              "type": "boolean"
+            },
             "metadata": {
               "default": "all",
-              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP \u2014 the only supported behaviour (the compress worker always strips; preservation is not currently available).",
+              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP (default, the only live behaviour \u2014 the compress worker hardcodes keep_metadata=false). `keep` = preserve metadata \u2014 `planned` (the worker cannot preserve it yet; un-hardcoding keep_metadata is the Phase 1 keep/strip toggle). Optimiser (same_format) route \u2014 the format-change transcoder has no metadata-preservation control today.",
+              "honored_on": [
+                "same_format"
+              ],
+              "per_value_availability": {
+                "keep": {
+                  "availability": "planned"
+                }
+              },
               "type": "enum",
               "values": [
-                "all"
+                "all",
+                "keep"
               ]
             },
             "optimization_level": {
               "default": 3,
-              "description": "PNG optimization effort (0-6, oxipng). Higher = smaller file, slower encode. Default 3.",
+              "description": "PNG optimization effort (0-6, oxipng). Higher = smaller file, slower encode. Default 3. Optimiser (same_format) route.",
+              "honored_on": [
+                "same_format"
+              ],
               "max": 6,
               "min": 0,
               "type": "integer"
@@ -1245,9 +1474,157 @@
             "quality": {
               "default": 80,
               "description": "Compression quality (1 = smallest file, 100 = best quality).",
+              "honored_on": [
+                "same_format"
+              ],
+              "max": 100,
+              "min": 1,
+              "type": "integer"
+            },
+            "width": {
+              "description": "Resize-inside-Output: target width in pixels (1-16384; width*height <= max_output_pixels). Resize the image as part of Output (replace semantics, ONE transformed output) using the proven image resize engine (Lanczos, shared with thumbnail-images) \u2014 it is NOT the derivative `thumbnail` op. Optional; omit to keep the source dimensions.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
+            }
+          }
+        },
+        "image_svg": {
+          "mimes": [
+            "image/svg+xml"
+          ],
+          "options": {
+            "metadata": {
+              "default": "all",
+              "description": "Metadata handling. `all` = strip all metadata (default, live). `keep` = preserve metadata \u2014 `planned` (worker cannot preserve yet). Optimiser (same_format) route.",
+              "honored_on": [
+                "same_format"
+              ],
+              "per_value_availability": {
+                "keep": {
+                  "availability": "planned"
+                }
+              },
+              "type": "enum",
+              "values": [
+                "all",
+                "keep"
+              ]
+            },
+            "output_format": {
+              "default": "original",
+              "description": "Output format. original = keep input format (default); webp = recompress to WebP. Other format changes are the convert operation's job. See FORMAT.md.",
+              "type": "enum",
+              "values": [
+                "original",
+                "webp"
+              ]
+            },
+            "quality": {
+              "default": 80,
+              "description": "Compression quality (1 = smallest file, 100 = best quality).",
+              "honored_on": [
+                "same_format"
+              ],
+              "max": 100,
+              "min": 1,
+              "type": "integer"
+            }
+          }
+        },
+        "image_webp": {
+          "max_output_pixels": 16000000,
+          "mimes": [
+            "image/webp"
+          ],
+          "options": {
+            "fit": {
+              "default": "max",
+              "depends_on": {
+                "height": "set",
+                "logic": "or",
+                "width": "set"
+              },
+              "description": "Resize mode. max = fit within bounds (preserves aspect ratio, no crop), crop/scale = exact dimensions. Applies only when width or height is set, on whichever Output route runs.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "type": "enum",
+              "values": [
+                "max",
+                "crop",
+                "scale"
+              ]
+            },
+            "height": {
+              "description": "Resize-inside-Output: target height in pixels (1-16384; width*height <= max_output_pixels). Resize replaces the image (one output). Optional \u2014 see `width`.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
+            },
+            "lossless": {
+              "availability": "planned",
+              "default": false,
+              "description": "Encode WebP losslessly (optimiser path). `planned` \u2014 the worker carries a `lossless` bool the API has never emitted (product-parked: lossless can be LARGER). Optimiser (same_format) route only.",
+              "honored_on": [
+                "same_format"
+              ],
+              "type": "boolean"
+            },
+            "metadata": {
+              "default": "all",
+              "description": "Metadata handling. `all` = strip all EXIF/IPTC/XMP (default, the only live behaviour \u2014 the compress worker hardcodes keep_metadata=false). `keep` = preserve metadata \u2014 `planned` (the worker cannot preserve it yet; un-hardcoding keep_metadata is the Phase 1 keep/strip toggle). Optimiser (same_format) route \u2014 the format-change transcoder has no metadata-preservation control today.",
+              "honored_on": [
+                "same_format"
+              ],
+              "per_value_availability": {
+                "keep": {
+                  "availability": "planned"
+                }
+              },
+              "type": "enum",
+              "values": [
+                "all",
+                "keep"
+              ]
+            },
+            "output_format": {
+              "default": "original",
+              "description": "Output format. original = keep input format (default); webp = recompress to WebP \u2014 the one live compress+format target (proven on staging). Other format changes (jpeg/png/avif/gif/tiff) are the convert operation's job, not compress. See FORMAT.md.",
+              "type": "enum",
+              "values": [
+                "original",
+                "webp"
+              ]
+            },
+            "quality": {
+              "default": 80,
+              "description": "Compression quality (1 = smallest file, 100 = best quality).",
+              "honored_on": [
+                "same_format"
+              ],
               "max": 100,
               "min": 1,
               "type": "integer"
+            },
+            "width": {
+              "description": "Resize-inside-Output: target width in pixels (1-16384; width*height <= max_output_pixels). Resize the image as part of Output (replace semantics, ONE transformed output) using the proven image resize engine (Lanczos, shared with thumbnail-images) \u2014 it is NOT the derivative `thumbnail` op. Optional; omit to keep the source dimensions.",
+              "honored_on": [
+                "same_format",
+                "format_change"
+              ],
+              "max": 16384,
+              "min": 1,
+              "type": "integer"
             }
           }
         },
@@ -1543,7 +1920,10 @@
               "depends_on": {
                 "output_format": "jpeg"
               },
-              "description": "Background colour (hex, e.g. '#ffffff') for transparent images converted to JPEG",
+              "description": "Background colour (hex, e.g. '#ffffff') for transparent images converted to JPEG (the format-change\u2192JPEG alpha-flatten \u2014 Output's transparency fill control).",
+              "honored_on": [
+                "format_change"
+              ],
               "type": "string"
             },
             "output_format": {
@@ -1569,6 +1949,9 @@
                 ]
               },
               "description": "Output quality for lossy formats",
+              "honored_on": [
+                "format_change"
+              ],
               "max": 100,
               "min": 1,
               "type": "integer"
@@ -3595,7 +3978,7 @@
       "sole_op": true
     }
   },
-  "schema_version": "2.94.0",
+  "schema_version": "2.97.0",
   "source_commit": null,
   "user_tier": null,
   "workflow_features": {

package/dist/openapi/models/AccountLimitEntry.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.94.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/AccountLimitEntry.js

@@ -4,7 +4,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.94.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/openapi/models/AccountLimits.d.ts

@@ -2,7 +2,7 @@
  * GISL Compression API
  * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body.  **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings.  The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17).  **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).**  Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English.  - **Currently committed locales:** `en-GB` only (per ticket   [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier   shape (`Accept-Language` + `Content-Language` + `Vary` headers +   `locale` envelope field + `message_key` + `message_params`) is   stable and exercised; the **catalog** of translated `message`   strings is en-GB-only at runtime today. Additional locales (e.g.   `pt-PT`) will be advertised by name when their catalogs ship —   the request/response carrier shape does NOT change when a new   locale lands. Treat unrequested locales as \"machine-code +   `message_key` path is committed; localised `message` prose is   not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value   negotiation supported). The server selects the best-match locale   from its supported list; falls back to `en-GB` when no match —   which, until additional catalogs land, is every non-`en-GB`   `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised   response; `Vary: Accept-Language` on every response (CDN/cache   correctness — different `Accept-Language` requests produce   different responses). `Vary` is emitted unconditionally so the   header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for   `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed   error branches; surface `message_key` to client-side i18n   catalogs (SDK companion work tracked at X19, cross-repo);   display `message` for end-user UI; **never parse `message` for   control flow** — it changes per locale.  Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention.  **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
  *
- * The version of the OpenAPI document: 2.94.0
+ * The version of the OpenAPI document: 2.97.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).