@giveitsmaller/contracts 0.21.0 → 0.22.0

package/accepted-options/accepted-options.json

@@ -0,0 +1,688 @@
+{
+  "operations": {
+    "archive": {
+      "_operation": {
+        "accepted_options": {
+          "*": [
+            "folder_structure",
+            "format"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "audio_overlay": {
+      "audio": {
+        "accepted_options": {
+          "*": [
+            "duck_attack_ms",
+            "duck_ratio",
+            "duck_release_ms",
+            "duck_threshold",
+            "duration",
+            "fade_in_ms",
+            "fade_out_ms",
+            "loop",
+            "loop_interval",
+            "min_silence_ms",
+            "mode",
+            "overlay_gain_db",
+            "silence_threshold_db",
+            "start_at"
+          ]
+        },
+        "output_format_option": null
+      },
+      "video": {
+        "accepted_options": {
+          "*": [
+            "duck_attack_ms",
+            "duck_ratio",
+            "duck_release_ms",
+            "duck_threshold",
+            "duration",
+            "fade_in_ms",
+            "fade_out_ms",
+            "loop",
+            "loop_interval",
+            "min_silence_ms",
+            "mode",
+            "no_audio_track_behaviour",
+            "overlay_gain_db",
+            "silence_threshold_db",
+            "start_at"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "audio_to_video": {
+      "audio": {
+        "accepted_options": {
+          "mp4": [
+            "background_color",
+            "framerate",
+            "image_fit",
+            "output_format",
+            "output_resolution"
+          ]
+        },
+        "output_format_option": "output_format"
+      }
+    },
+    "audio_watermark": {
+      "audio": {
+        "accepted_options": {
+          "*": [
+            "density",
+            "method",
+            "payload",
+            "robustness"
+          ]
+        },
+        "output_format_option": null
+      },
+      "video": {
+        "accepted_options": {
+          "*": [
+            "density",
+            "method",
+            "payload",
+            "robustness"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "compress": {
+      "audio": {
+        "accepted_options": {
+          "aac": [
+            "bitrate",
+            "channels",
+            "normalize",
+            "output_format",
+            "sample_rate",
+            "trim_end",
+            "trim_start"
+          ],
+          "flac": [
+            "bitrate",
+            "channels",
+            "normalize",
+            "output_format",
+            "sample_rate",
+            "trim_end",
+            "trim_start"
+          ],
+          "mp3": [
+            "bitrate",
+            "channels",
+            "normalize",
+            "output_format",
+            "sample_rate",
+            "trim_end",
+            "trim_start"
+          ],
+          "ogg": [
+            "bitrate",
+            "channels",
+            "normalize",
+            "output_format",
+            "sample_rate",
+            "trim_end",
+            "trim_start"
+          ],
+          "original": [
+            "bitrate",
+            "channels",
+            "normalize",
+            "output_format",
+            "sample_rate",
+            "trim_end",
+            "trim_start"
+          ],
+          "wav": [
+            "bitrate",
+            "channels",
+            "normalize",
+            "output_format",
+            "sample_rate",
+            "trim_end",
+            "trim_start"
+          ]
+        },
+        "output_format_option": "output_format"
+      },
+      "document_epub": {
+        "accepted_options": {
+          "*": [
+            "font_subsetting",
+            "image_quality",
+            "strip_unused_css"
+          ]
+        },
+        "output_format_option": null
+      },
+      "document_odf": {
+        "accepted_options": {
+          "*": [
+            "image_quality",
+            "strip_metadata",
+            "strip_unused_styles"
+          ]
+        },
+        "output_format_option": null
+      },
+      "document_office": {
+        "accepted_options": {
+          "*": [
+            "image_quality",
+            "strip_hidden_data",
+            "strip_macros",
+            "strip_unused_fonts"
+          ]
+        },
+        "output_format_option": null
+      },
+      "document_pdf": {
+        "accepted_options": {
+          "*": [
+            "colorspace",
+            "flatten_forms",
+            "pages",
+            "profile"
+          ]
+        },
+        "output_format_option": null
+      },
+      "image": {
+        "accepted_options": {
+          "auto": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ],
+          "avif": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ],
+          "jpeg": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ],
+          "original": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ],
+          "png": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ],
+          "smallest": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ],
+          "webp": [
+            "icc_profile",
+            "metadata",
+            "mode",
+            "output_format",
+            "progressive",
+            "quality"
+          ]
+        },
+        "output_format_option": "output_format"
+      },
+      "video": {
+        "accepted_options": {
+          "mp4": [
+            "audio_bitrate",
+            "audio_codec",
+            "codec",
+            "crf",
+            "encoding_mode",
+            "faststart",
+            "fit",
+            "fps",
+            "height",
+            "output_format",
+            "preset",
+            "target_size_bytes",
+            "trim_end",
+            "trim_start",
+            "width"
+          ],
+          "ogg": [
+            "audio_bitrate",
+            "audio_codec",
+            "codec",
+            "crf",
+            "encoding_mode",
+            "faststart",
+            "fit",
+            "fps",
+            "height",
+            "output_format",
+            "preset",
+            "target_size_bytes",
+            "trim_end",
+            "trim_start",
+            "width"
+          ],
+          "original": [
+            "audio_bitrate",
+            "audio_codec",
+            "codec",
+            "crf",
+            "encoding_mode",
+            "faststart",
+            "fit",
+            "fps",
+            "height",
+            "output_format",
+            "preset",
+            "target_size_bytes",
+            "trim_end",
+            "trim_start",
+            "width"
+          ],
+          "webm": [
+            "audio_bitrate",
+            "audio_codec",
+            "codec",
+            "crf",
+            "encoding_mode",
+            "faststart",
+            "fit",
+            "fps",
+            "height",
+            "output_format",
+            "preset",
+            "target_size_bytes",
+            "trim_end",
+            "trim_start",
+            "width"
+          ]
+        },
+        "output_format_option": "output_format"
+      }
+    },
+    "convert": {
+      "audio": {
+        "accepted_options": {
+          "aac": [
+            "bitrate",
+            "output_format"
+          ],
+          "flac": [
+            "output_format"
+          ],
+          "mp3": [
+            "bitrate",
+            "output_format"
+          ],
+          "ogg": [
+            "bitrate",
+            "output_format"
+          ],
+          "wav": [
+            "output_format"
+          ]
+        },
+        "output_format_option": "output_format"
+      },
+      "document_pdf": {
+        "accepted_options": {
+          "jpeg": [
+            "dpi",
+            "output_format",
+            "pages"
+          ],
+          "png": [
+            "dpi",
+            "output_format",
+            "pages"
+          ]
+        },
+        "output_format_option": "output_format"
+      },
+      "image": {
+        "accepted_options": {
+          "avif": [
+            "output_format",
+            "quality"
+          ],
+          "gif": [
+            "output_format"
+          ],
+          "jpeg": [
+            "background",
+            "output_format",
+            "quality"
+          ],
+          "png": [
+            "output_format"
+          ],
+          "tiff": [
+            "output_format"
+          ],
+          "webp": [
+            "output_format",
+            "quality"
+          ]
+        },
+        "output_format_option": "output_format"
+      },
+      "video": {
+        "accepted_options": {
+          "gif": [
+            "output_format"
+          ],
+          "mp4": [
+            "codec",
+            "output_format",
+            "quality"
+          ],
+          "ogg": [
+            "codec",
+            "output_format",
+            "quality"
+          ],
+          "webm": [
+            "codec",
+            "output_format",
+            "quality"
+          ]
+        },
+        "output_format_option": "output_format"
+      }
+    },
+    "custom_luma": {
+      "video": {
+        "accepted_options": {
+          "*": [
+            "duration",
+            "mask_blur",
+            "mask_contrast",
+            "mask_invert",
+            "start_offset"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "image_watermark": {
+      "image": {
+        "accepted_options": {
+          "*": [
+            "anchor",
+            "margin_x",
+            "margin_y",
+            "opacity",
+            "overlay_width"
+          ]
+        },
+        "output_format_option": null
+      },
+      "image_gif": {
+        "accepted_options": {
+          "*": [
+            "anchor",
+            "margin_x",
+            "margin_y",
+            "opacity",
+            "overlay_width"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "merge": {
+      "audio": {
+        "accepted_options": {
+          "*": [
+            "crossfade_duration",
+            "gap_duration",
+            "normalize_audio",
+            "output_type",
+            "transition"
+          ]
+        },
+        "accepted_per_input_options": {
+          "*": [
+            "crossfade_duration",
+            "gap_duration",
+            "transition",
+            "trim_end",
+            "trim_start"
+          ]
+        },
+        "output_format_option": null
+      },
+      "image": {
+        "accepted_options": {
+          "*": [
+            "delay",
+            "duration_per_image",
+            "fps",
+            "loop_count",
+            "output_type",
+            "transition",
+            "transition_duration",
+            "video_format"
+          ]
+        },
+        "output_format_option": null
+      },
+      "video": {
+        "accepted_options": {
+          "*": [
+            "codec",
+            "crf",
+            "crossfade_duration",
+            "encoding_mode",
+            "normalize_audio",
+            "output_type",
+            "preset",
+            "re_encode_mode",
+            "target_resolution",
+            "target_size_bytes",
+            "transition"
+          ]
+        },
+        "accepted_per_input_options": {
+          "*": [
+            "crossfade_duration",
+            "transition",
+            "trim_end",
+            "trim_start"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "render_variants": {
+      "image": {
+        "accepted_options": {
+          "*": [
+            "targets"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "split": {
+      "audio": {
+        "accepted_options": {
+          "*": [
+            "count",
+            "cut_points",
+            "interval",
+            "mode",
+            "precision",
+            "silence_handling",
+            "silence_min_duration",
+            "silence_threshold_db"
+          ]
+        },
+        "output_format_option": null
+      },
+      "document_pdf": {
+        "accepted_options": {
+          "*": [
+            "mode",
+            "page_groups",
+            "page_range"
+          ]
+        },
+        "output_format_option": null
+      },
+      "image_gif": {
+        "accepted_options": {
+          "jpg": [
+            "frame_range",
+            "output_format"
+          ],
+          "png": [
+            "frame_range",
+            "output_format"
+          ],
+          "webp": [
+            "frame_range",
+            "output_format"
+          ]
+        },
+        "output_format_option": "output_format"
+      },
+      "video": {
+        "accepted_options": {
+          "*": [
+            "count",
+            "cut_points",
+            "interval",
+            "mode",
+            "precision"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "text_watermark": {
+      "image": {
+        "accepted_options": {
+          "*": [
+            "anchor",
+            "color",
+            "font_family",
+            "font_size",
+            "margin_x",
+            "margin_y",
+            "opacity",
+            "rotation",
+            "text",
+            "tile_spacing",
+            "watermark_mode"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "thumbnail": {
+      "document": {
+        "accepted_options": {
+          "*": [
+            "fit",
+            "format",
+            "height",
+            "page",
+            "source",
+            "width"
+          ]
+        },
+        "output_format_option": null
+      },
+      "image": {
+        "accepted_options": {
+          "*": [
+            "fit",
+            "format",
+            "height",
+            "width"
+          ]
+        },
+        "output_format_option": null
+      },
+      "video": {
+        "accepted_options": {
+          "*": [
+            "fit",
+            "format",
+            "height",
+            "timestamp",
+            "width"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "video_text_watermark": {
+      "video": {
+        "accepted_options": {
+          "*": [
+            "anchor",
+            "color",
+            "font_family",
+            "font_size",
+            "margin_x",
+            "margin_y",
+            "opacity",
+            "rotation",
+            "text",
+            "tile_spacing",
+            "watermark_mode"
+          ]
+        },
+        "output_format_option": null
+      }
+    },
+    "video_watermark": {
+      "video": {
+        "accepted_options": {
+          "*": [
+            "anchor",
+            "margin_x",
+            "margin_y",
+            "opacity",
+            "overlay_width"
+          ]
+        },
+        "output_format_option": null
+      }
+    }
+  },
+  "schema_version": "2.79.0"
+}

package/availability/availability.json

@@ -3401,7 +3401,7 @@
       }
     }
   },
-  "schema_version": "2.78.0",
+  "schema_version": "2.79.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.78.0
+ * The version of the OpenAPI document: 2.79.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).