@giveitsmaller/contracts 0.8.0 → 0.16.0

package/operations/schemas/video_watermark.yaml

@@ -2,14 +2,17 @@ schema_version: "2.0.0"
 
 operation:
   type: video_watermark
-  availability: planned
+  availability: beta
   description: |
-    Apply an image overlay (file or external source) onto a base video
+    Apply an image overlay onto a base video
     asset using FFmpeg's `overlay` filter. Multi-input role-based:
     exactly one input with `role: base` (the source video) + exactly
-    one with `role: overlay` (the watermark image). The overlay can be
-    an upload, an external_import handle, or a vault connection per
-    `WorkflowSource`.
+    one with `role: overlay` (the watermark image). Each input is a
+    `MultiInputSource` — an external_import handle, a vault connection,
+    or an upstream `job_output` (uploads are NOT referenced directly
+    inside inputs[]). To use an uploaded base or overlay, feed it through
+    a `passthrough` source job and reference it via `{ type: job_output,
+    from: <id> }` (per ticket 4som89Uh).
 
     **Dedicated operation, not an extension of `image_watermark`.**
     `image_watermark` is pure-Rust/no-FFmpeg and handles
@@ -21,9 +24,17 @@ operation:
     unchanged via FFmpeg stream-copy — the watermark applies to the
     visual track only.
 
-    `availability: planned` until the cross-repo Lambda support ships;
-    dispatch returns `feature_not_available` (422) until then. Per
-    ADR-0013 + lambdas pre-launch epic Wave A (ticket
+    Activated to `availability: beta` (Wave A, ticket
+    [`c3uthIP4`](https://trello.com/c/c3uthIP4)): the cross-repo Lambda
+    backend is live (API accepts + publishes via the operations SNS
+    topic), so the operation and its `short_form` processing class are
+    shape-stable + opt-in and MUST NOT return `feature_not_available`.
+    `long_form` stays `planned` (no live Fargate worker yet — its
+    long-form path is not provisioned) and the `multi_overlay_stack`
+    feature stays `planned` (Lambda support unconfirmed); requesting
+    those planned sub-features DOES still return `feature_not_available`
+    until they are separately activated. Per ADR-0013 + lambdas
+    pre-launch epic Wave A (ticket
     [`SlluxMBN`'s sibling `4NrRPCgh`](https://trello.com/c/4NrRPCgh)).
   default: false
   input_model: multi
@@ -55,7 +66,7 @@ operation:
         - video/webm
       processing_class:
         short_form:
-          availability: planned
+          availability: beta
           constraints:
             max_input_duration: "PT5M"
             max_input_size_bytes: 524288000

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@giveitsmaller/contracts",
-  "version": "0.8.0",
+  "version": "0.16.0",
   "description": "Generated contract types for GISL (Give It Smaller)",
   "license": "MIT",
   "type": "module",
@@ -35,6 +35,8 @@
     "./operations/schemas/custom_luma.yaml": "./operations/schemas/custom_luma.yaml",
     "./operations/schemas/image_watermark.yaml": "./operations/schemas/image_watermark.yaml",
     "./operations/schemas/merge.yaml": "./operations/schemas/merge.yaml",
+    "./operations/schemas/passthrough.yaml": "./operations/schemas/passthrough.yaml",
+    "./operations/schemas/render_variants.yaml": "./operations/schemas/render_variants.yaml",
     "./operations/schemas/split.yaml": "./operations/schemas/split.yaml",
     "./operations/schemas/text_watermark.yaml": "./operations/schemas/text_watermark.yaml",
     "./operations/schemas/thumbnail.yaml": "./operations/schemas/thumbnail.yaml",

package/dist/asyncapi/AnonymousSchema_253.d.ts

@@ -1,5 +0,0 @@
-declare enum AnonymousSchema_253 {
-    COMPRESS = "compress",
-    MERGE = "merge"
-}
-export default AnonymousSchema_253;

package/dist/asyncapi/AnonymousSchema_253.js

@@ -1,6 +0,0 @@
-var AnonymousSchema_253;
-(function (AnonymousSchema_253) {
-    AnonymousSchema_253["COMPRESS"] = "compress";
-    AnonymousSchema_253["MERGE"] = "merge";
-})(AnonymousSchema_253 || (AnonymousSchema_253 = {}));
-export default AnonymousSchema_253;

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

@@ -1,50 +0,0 @@
-/**
- * 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/Last-Modified 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.21.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- *
- * @export
- * @interface LogoutUser200Response
- */
-export interface LogoutUser200Response {
-    /**
-     *
-     * @type {LogoutUser200ResponseSuccessEnum}
-     * @memberof LogoutUser200Response
-     */
-    success: LogoutUser200ResponseSuccessEnum;
-    /**
-     * Empty object on logout success — preserves the
-     * `{ success: true, data: {...} }` envelope
-     * invariant from `info.description`. Logout has
-     * no return payload; the data slot is always
-     * `{}`.
-     *
-     * @type {object}
-     * @memberof LogoutUser200Response
-     */
-    data: object;
-}
-/**
- * @export
- */
-export declare const LogoutUser200ResponseSuccessEnum: {
-    readonly true: true;
-};
-export type LogoutUser200ResponseSuccessEnum = typeof LogoutUser200ResponseSuccessEnum[keyof typeof LogoutUser200ResponseSuccessEnum];
-/**
- * Check if a given object implements the LogoutUser200Response interface.
- */
-export declare function instanceOfLogoutUser200Response(value: object): value is LogoutUser200Response;
-export declare function LogoutUser200ResponseFromJSON(json: any): LogoutUser200Response;
-export declare function LogoutUser200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): LogoutUser200Response;
-export declare function LogoutUser200ResponseToJSON(json: any): LogoutUser200Response;
-export declare function LogoutUser200ResponseToJSONTyped(value?: LogoutUser200Response | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/LogoutUser200Response.js

@@ -1,53 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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/Last-Modified 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.21.0
- *
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-/**
- * @export
- */
-export const LogoutUser200ResponseSuccessEnum = {
-    true: true
-};
-/**
- * Check if a given object implements the LogoutUser200Response interface.
- */
-export function instanceOfLogoutUser200Response(value) {
-    if (!('success' in value) || value['success'] === undefined)
-        return false;
-    if (!('data' in value) || value['data'] === undefined)
-        return false;
-    return true;
-}
-export function LogoutUser200ResponseFromJSON(json) {
-    return LogoutUser200ResponseFromJSONTyped(json, false);
-}
-export function LogoutUser200ResponseFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'success': json['success'],
-        'data': json['data'],
-    };
-}
-export function LogoutUser200ResponseToJSON(json) {
-    return LogoutUser200ResponseToJSONTyped(json, false);
-}
-export function LogoutUser200ResponseToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'success': value['success'],
-        'data': value['data'],
-    };
-}