@giveitsmaller/contracts 0.35.0 → 0.37.0

package/dist/operations/compress.metadata.js

@@ -9,15 +9,39 @@ export const compressMetadata = {
                 quality: {
                     per_value_availability: {},
                 },
+                encoding_mode: {
+                    per_value_availability: {},
+                },
+                target_size_bytes: {
+                    per_value_availability: {},
+                },
                 metadata: {
+                    per_value_availability: {
+                        all: {
+                            availability: 'deprecated',
+                        },
+                    },
+                },
+                keep_metadata: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 progressive: {
                     per_value_availability: {},
                 },
-                output_format: {
+                chroma_subsampling: {
                     per_value_availability: {},
                 },
+                output_format: {
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                    },
+                },
                 lossless: {
                     per_value_availability: {},
                 },
@@ -41,13 +65,28 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
+                    per_value_availability: {
+                        all: {
+                            availability: 'deprecated',
+                        },
+                    },
+                },
+                keep_metadata: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 optimization_level: {
                     per_value_availability: {},
                 },
                 output_format: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 lossy: {
                     availability: 'planned',
@@ -73,14 +112,31 @@ export const compressMetadata = {
                 quality: {
                     per_value_availability: {},
                 },
-                metadata: {
+                encoding_mode: {
                     per_value_availability: {},
                 },
+                target_size_bytes: {
+                    per_value_availability: {},
+                },
+                metadata: {
+                    per_value_availability: {
+                        all: {
+                            availability: 'deprecated',
+                        },
+                    },
+                },
                 avif_speed: {
                     per_value_availability: {},
                 },
                 output_format: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 width: {
                     per_value_availability: {},
@@ -101,11 +157,32 @@ export const compressMetadata = {
                 quality: {
                     per_value_availability: {},
                 },
+                encoding_mode: {
+                    per_value_availability: {},
+                },
+                target_size_bytes: {
+                    per_value_availability: {},
+                },
                 metadata: {
+                    per_value_availability: {
+                        all: {
+                            availability: 'deprecated',
+                        },
+                    },
+                },
+                keep_metadata: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 output_format: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 lossless: {
                     per_value_availability: {},
@@ -130,10 +207,21 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        all: {
+                            availability: 'deprecated',
+                        },
+                    },
                 },
                 output_format: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                    },
                 },
             },
             per_input_options: {},
@@ -146,10 +234,25 @@ export const compressMetadata = {
                     per_value_availability: {},
                 },
                 metadata: {
+                    per_value_availability: {
+                        all: {
+                            availability: 'deprecated',
+                        },
+                    },
+                },
+                keep_metadata: {
+                    availability: 'planned',
                     per_value_availability: {},
                 },
                 output_format: {
-                    per_value_availability: {},
+                    per_value_availability: {
+                        auto: {
+                            availability: 'planned',
+                        },
+                        smallest: {
+                            availability: 'planned',
+                        },
+                    },
                 },
                 width: {
                     per_value_availability: {},

package/dist/operations/convert.d.ts

@@ -6,10 +6,64 @@ export declare enum ConvertImageOutputFormat {
     Gif = "gif",
     Tiff = "tiff"
 }
+export declare enum ConvertImageMetadata {
+    Strip = "strip",
+    Keep = "keep"
+}
+export declare enum ConvertImageFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
 export interface ConvertImageOptions {
     output_format: ConvertImageOutputFormat;
     quality?: number;
     background?: string;
+    metadata?: ConvertImageMetadata;
+    width?: number;
+    height?: number;
+    fit?: ConvertImageFit;
+}
+export declare enum ConvertImageSvgOutputFormat {
+    Jpeg = "jpeg",
+    Png = "png",
+    Webp = "webp",
+    Avif = "avif",
+    Gif = "gif",
+    Tiff = "tiff"
+}
+export interface ConvertImageSvgOptions {
+    output_format: ConvertImageSvgOutputFormat;
+    quality?: number;
+    background?: string;
+}
+export declare enum ConvertImageGifOutputFormat {
+    Jpeg = "jpeg",
+    Png = "png",
+    Webp = "webp",
+    Avif = "avif",
+    Gif = "gif",
+    Tiff = "tiff",
+    Mp4 = "mp4",
+    Webm = "webm"
+}
+export declare enum ConvertImageGifMetadata {
+    Strip = "strip",
+    Keep = "keep"
+}
+export declare enum ConvertImageGifFit {
+    Max = "max",
+    Crop = "crop",
+    Scale = "scale"
+}
+export interface ConvertImageGifOptions {
+    output_format: ConvertImageGifOutputFormat;
+    quality?: number;
+    background?: string;
+    metadata?: ConvertImageGifMetadata;
+    width?: number;
+    height?: number;
+    fit?: ConvertImageGifFit;
 }
 export declare enum ConvertVideoOutputFormat {
     Mp4 = "mp4",

package/dist/operations/convert.js

@@ -8,6 +8,48 @@ export var ConvertImageOutputFormat;
     ConvertImageOutputFormat["Gif"] = "gif";
     ConvertImageOutputFormat["Tiff"] = "tiff";
 })(ConvertImageOutputFormat || (ConvertImageOutputFormat = {}));
+export var ConvertImageMetadata;
+(function (ConvertImageMetadata) {
+    ConvertImageMetadata["Strip"] = "strip";
+    ConvertImageMetadata["Keep"] = "keep";
+})(ConvertImageMetadata || (ConvertImageMetadata = {}));
+export var ConvertImageFit;
+(function (ConvertImageFit) {
+    ConvertImageFit["Max"] = "max";
+    ConvertImageFit["Crop"] = "crop";
+    ConvertImageFit["Scale"] = "scale";
+})(ConvertImageFit || (ConvertImageFit = {}));
+export var ConvertImageSvgOutputFormat;
+(function (ConvertImageSvgOutputFormat) {
+    ConvertImageSvgOutputFormat["Jpeg"] = "jpeg";
+    ConvertImageSvgOutputFormat["Png"] = "png";
+    ConvertImageSvgOutputFormat["Webp"] = "webp";
+    ConvertImageSvgOutputFormat["Avif"] = "avif";
+    ConvertImageSvgOutputFormat["Gif"] = "gif";
+    ConvertImageSvgOutputFormat["Tiff"] = "tiff";
+})(ConvertImageSvgOutputFormat || (ConvertImageSvgOutputFormat = {}));
+export var ConvertImageGifOutputFormat;
+(function (ConvertImageGifOutputFormat) {
+    ConvertImageGifOutputFormat["Jpeg"] = "jpeg";
+    ConvertImageGifOutputFormat["Png"] = "png";
+    ConvertImageGifOutputFormat["Webp"] = "webp";
+    ConvertImageGifOutputFormat["Avif"] = "avif";
+    ConvertImageGifOutputFormat["Gif"] = "gif";
+    ConvertImageGifOutputFormat["Tiff"] = "tiff";
+    ConvertImageGifOutputFormat["Mp4"] = "mp4";
+    ConvertImageGifOutputFormat["Webm"] = "webm";
+})(ConvertImageGifOutputFormat || (ConvertImageGifOutputFormat = {}));
+export var ConvertImageGifMetadata;
+(function (ConvertImageGifMetadata) {
+    ConvertImageGifMetadata["Strip"] = "strip";
+    ConvertImageGifMetadata["Keep"] = "keep";
+})(ConvertImageGifMetadata || (ConvertImageGifMetadata = {}));
+export var ConvertImageGifFit;
+(function (ConvertImageGifFit) {
+    ConvertImageGifFit["Max"] = "max";
+    ConvertImageGifFit["Crop"] = "crop";
+    ConvertImageGifFit["Scale"] = "scale";
+})(ConvertImageGifFit || (ConvertImageGifFit = {}));
 export var ConvertVideoOutputFormat;
 (function (ConvertVideoOutputFormat) {
     ConvertVideoOutputFormat["Mp4"] = "mp4";

package/dist/operations/convert.metadata.js

@@ -22,6 +22,71 @@ export const convertMetadata = {
                 background: {
                     per_value_availability: {},
                 },
+                metadata: {
+                    availability: 'planned',
+                    per_value_availability: {},
+                },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
+            },
+            per_input_options: {},
+        },
+        image_svg: {
+            processing_class: {},
+            per_mime_availability: {},
+            options: {
+                output_format: {
+                    per_value_availability: {},
+                },
+                quality: {
+                    per_value_availability: {},
+                },
+                background: {
+                    per_value_availability: {},
+                },
+            },
+            per_input_options: {},
+        },
+        image_gif: {
+            processing_class: {},
+            per_mime_availability: {},
+            options: {
+                output_format: {
+                    per_value_availability: {
+                        mp4: {
+                            availability: 'planned',
+                        },
+                        webm: {
+                            availability: 'planned',
+                        },
+                    },
+                },
+                quality: {
+                    per_value_availability: {},
+                },
+                background: {
+                    per_value_availability: {},
+                },
+                metadata: {
+                    availability: 'planned',
+                    per_value_availability: {},
+                },
+                width: {
+                    per_value_availability: {},
+                },
+                height: {
+                    per_value_availability: {},
+                },
+                fit: {
+                    per_value_availability: {},
+                },
             },
             per_input_options: {},
         },

package/openapi/api.yaml

@@ -89,7 +89,7 @@ info:
     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.
-  version: 2.102.0
+  version: 2.111.0
   contact:
     name: API Support
 
@@ -9984,6 +9984,28 @@ components:
           type: integer
           format: int64
           description: Output file size in bytes
+        mime_type:
+          type: string
+          maxLength: 100
+          description: |
+            OPTIONAL. MIME type of the produced artifact (the REST read-surface
+            mirror of the AsyncAPI `OperationResult.output_file_type` wire field —
+            the OpenAPI/REST convention names this concept `mime_type`, as on
+            `OperationDownload` / the upload-probe response). Present on completion
+            only.
+
+            **Purpose — the auto-format savings readout.** For most traffic the
+            client already knows the output format (compress is same-format; the
+            compress+format facade canonicalizes to a known `convert` target). This
+            field exists for the runtime-format-selection path — `compress`
+            `output_format: auto`/`smallest` (currently `planned`), where the server
+            picks the output format and the client cannot predict it. Combined with
+            `size_bytes` (output size) + `metrics.compression_ratio` (savings), it
+            lets the client render "AVIF saved 43%" from a single completion payload
+            without cross-referencing the downloads endpoint. Landed additively now
+            (cf. `output_file_type` / `watermark_id`) so the auto-format path needs
+            no later contract bump; the API populates it when that path ships.
+          example: "image/webp"
         export_key:
           type: string
           description: Key in the customer's export destination (if export configured)

package/operation-capabilities/operation-capabilities.json

@@ -197,6 +197,23 @@
             ]
           },
           "wire_code": "invalid_options"
+        },
+        {
+          "constraint_id": "compress.chroma_subsampling.lossless_conflict",
+          "message": "chroma_subsampling cannot be combined with lossless: lossless JPEG copies DCT coefficients and cannot resample chroma.",
+          "when": {
+            "all": [
+              {
+                "field": "compress.chroma_subsampling",
+                "isSet": true
+              },
+              {
+                "equals": true,
+                "field": "compress.lossless"
+              }
+            ]
+          },
+          "wire_code": "invalid_options"
         }
       ],
       "produces": {
@@ -204,7 +221,7 @@
       },
       "requires": [
         {
-          "constraint_id": "compress.video.target_size.bytes_required",
+          "constraint_id": "compress.target_size.bytes_required",
           "message": "target_size_bytes is required when encoding_mode is target_size.",
           "requires_field": "compress.target_size_bytes",
           "when": {
@@ -498,5 +515,5 @@
       "isAnimated": "maybe"
     }
   },
-  "schema_version": "2.102.0"
+  "schema_version": "2.111.0"
 }