@giveitsmaller/contracts 0.37.0 → 0.38.0

package/operations/schemas/compress.yaml

@@ -17,13 +17,17 @@ operation:
     #   image_png  -> + optimization_level (PNG-only)
     #   image_avif -> + avif_speed    (AVIF-only)
     #   image      -> webp/gif/svg/tiff (quality + output_format only)
-    # The worker reads quality/progressive/optimization_level/avif_speed (+ a
-    # `lossless` bool the API never emits). It HARDCODES metadata-strip, so
-    # `metadata` is a single fixed `all`. `mode` (lossy/lossless/auto) and
-    # `icc_profile` were REMOVED — the worker never read them and the API passed
-    # them verbatim; image compress is LOSSY-ONLY today (product decision
-    # 2026-06-20, lossless parked). width/height/fit/auto_orient stay removed
-    # (EsD1hs5u — worker recompresses only; resize -> thumbnail, format -> convert).
+    # The worker reads quality/progressive/optimization_level/avif_speed/lossless
+    # (the API now emits lossless) + metadata (strip/keep). The old `mode`
+    # (lossy/lossless/auto) was REMOVED (the worker never read it). HISTORY: this
+    # header once said width/height/fit/auto_orient "stay removed" and metadata is a
+    # fixed `all` — BOTH now superseded by the image-options work: RESIZE
+    # (width/height/fit) is back STABLE (v2.97.0, the route-aware Output model);
+    # `metadata` is strip/keep (canonical `strip`, deprecated `all`); `auto_orient`
+    # is re-added PLANNED (wave-2, below); and the old `icc_profile` is superseded by
+    # the decoupled `color_profile` control (wave-2, planned — ICC handling is its
+    # own axis, NOT folded into metadata-strip; that fold-in was the silent-colour-
+    # shift bug). See the per-option blocks for the live shape.
     #
     # output_format (replicated identically per group): the LIVE concrete
     # targets are `original` (no-op, default) and `webp` (the one proven
@@ -237,6 +241,33 @@ operation:
             worker has no such key). `crop`/`scale` = exact dimensions (`scale`
             deliberately enlarges past source). Applies only when width or height is
             set, on whichever Output route runs.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            ICC colour-profile handling — its OWN control, DECOUPLED from `metadata`
+            (stripping metadata must NOT silently shift colours; that coupling is the
+            correctness bug this fixes). `keep` (default) = preserve the embedded
+            profile; `srgb` = convert to sRGB (also handles CMYK→sRGB); `strip` = drop
+            the profile (smallest — only when the consumer manages colour itself).
+            `planned` — the worker does not yet honour it (today the default strips ICC
+            during metadata-strip; the fix preserves it). Applies on BOTH Output routes
+            (optimiser preserves; transcoder preserves/converts). Worker-proven flip.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            Bake EXIF orientation into the pixels (honour the camera/device rotation
+            tag) so the output displays upright everywhere, then drop the now-redundant
+            orientation tag. `planned` — a restored control (was removed): the worker
+            must apply the EXIF-orientation transform before encode on both Output
+            routes. Default `true` (a behaviour change, proven planned-first). No-op for
+            inputs without an orientation tag.
 
     image_png:
       mimes:
@@ -351,6 +382,33 @@ operation:
             worker has no such key). `crop`/`scale` = exact dimensions (`scale`
             deliberately enlarges past source). Applies only when width or height is
             set, on whichever Output route runs.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            ICC colour-profile handling — its OWN control, DECOUPLED from `metadata`
+            (stripping metadata must NOT silently shift colours; that coupling is the
+            correctness bug this fixes). `keep` (default) = preserve the embedded
+            profile; `srgb` = convert to sRGB (also handles CMYK→sRGB); `strip` = drop
+            the profile (smallest — only when the consumer manages colour itself).
+            `planned` — the worker does not yet honour it (today the default strips ICC
+            during metadata-strip; the fix preserves it). Applies on BOTH Output routes
+            (optimiser preserves; transcoder preserves/converts). Worker-proven flip.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            Bake EXIF orientation into the pixels (honour the camera/device rotation
+            tag) so the output displays upright everywhere, then drop the now-redundant
+            orientation tag. `planned` — a restored control (was removed): the worker
+            must apply the EXIF-orientation transform before encode on both Output
+            routes. Default `true` (a behaviour change, proven planned-first). No-op for
+            inputs without an orientation tag.
 
     image_avif:
       availability: beta
@@ -469,6 +527,33 @@ operation:
             worker has no such key). `crop`/`scale` = exact dimensions (`scale`
             deliberately enlarges past source). Applies only when width or height is
             set, on whichever Output route runs.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            ICC colour-profile handling — its OWN control, DECOUPLED from `metadata`
+            (stripping metadata must NOT silently shift colours; that coupling is the
+            correctness bug this fixes). `keep` (default) = preserve the embedded
+            profile; `srgb` = convert to sRGB (also handles CMYK→sRGB); `strip` = drop
+            the profile (smallest — only when the consumer manages colour itself).
+            `planned` — the worker does not yet honour it (today the default strips ICC
+            during metadata-strip; the fix preserves it). Applies on BOTH Output routes
+            (optimiser preserves; transcoder preserves/converts). Worker-proven flip.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            Bake EXIF orientation into the pixels (honour the camera/device rotation
+            tag) so the output displays upright everywhere, then drop the now-redundant
+            orientation tag. `planned` — a restored control (was removed): the worker
+            must apply the EXIF-orientation transform before encode on both Output
+            routes. Default `true` (a behaviour change, proven planned-first). No-op for
+            inputs without an orientation tag.
 
     # webp split out of the former bundled image group: it is the one input that
     # carries BOTH Resize (raster, proven in thumbnail-images) AND the optimiser
@@ -607,6 +692,33 @@ operation:
             worker has no such key). `crop`/`scale` = exact dimensions (`scale`
             deliberately enlarges past source). Applies only when width or height is
             set, on whichever Output route runs.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            ICC colour-profile handling — its OWN control, DECOUPLED from `metadata`
+            (stripping metadata must NOT silently shift colours; that coupling is the
+            correctness bug this fixes). `keep` (default) = preserve the embedded
+            profile; `srgb` = convert to sRGB (also handles CMYK→sRGB); `strip` = drop
+            the profile (smallest — only when the consumer manages colour itself).
+            `planned` — the worker does not yet honour it (today the default strips ICC
+            during metadata-strip; the fix preserves it). Applies on BOTH Output routes
+            (optimiser preserves; transcoder preserves/converts). Worker-proven flip.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            Bake EXIF orientation into the pixels (honour the camera/device rotation
+            tag) so the output displays upright everywhere, then drop the now-redundant
+            orientation tag. `planned` — a restored control (was removed): the worker
+            must apply the EXIF-orientation transform before encode on both Output
+            routes. Default `true` (a behaviour change, proven planned-first). No-op for
+            inputs without an orientation tag.
 
     # svg is VECTOR: no raster resize (thumbnail-images does not list svg), and the
     # optimiser `lossless` knob does not apply. SVG compression is SVGO; only
@@ -750,6 +862,33 @@ operation:
             worker has no such key). `crop`/`scale` = exact dimensions (`scale`
             deliberately enlarges past source). Applies only when width or height is
             set, on whichever Output route runs.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            ICC colour-profile handling — its OWN control, DECOUPLED from `metadata`
+            (stripping metadata must NOT silently shift colours; that coupling is the
+            correctness bug this fixes). `keep` (default) = preserve the embedded
+            profile; `srgb` = convert to sRGB (also handles CMYK→sRGB); `strip` = drop
+            the profile (smallest — only when the consumer manages colour itself).
+            `planned` — the worker does not yet honour it (today the default strips ICC
+            during metadata-strip; the fix preserves it). Applies on BOTH Output routes
+            (optimiser preserves; transcoder preserves/converts). Worker-proven flip.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [same_format, format_change]
+          description: >-
+            Bake EXIF orientation into the pixels (honour the camera/device rotation
+            tag) so the output displays upright everywhere, then drop the now-redundant
+            orientation tag. `planned` — a restored control (was removed): the worker
+            must apply the EXIF-orientation transform before encode on both Output
+            routes. Default `true` (a behaviour change, proven planned-first). No-op for
+            inputs without an orientation tag.
 
     audio:
       mimes:

package/operations/schemas/convert.yaml

@@ -124,6 +124,29 @@ operation:
             "no-enlarge" behaviour (there is no separate `no_enlarge` flag — the
             worker has no such key). `crop`/`scale` = exact dimensions (`scale`
             deliberately enlarges past source). Applies only when width or height is set.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [format_change]
+          description: >-
+            ICC colour-profile handling on the transcoder (format-change) route —
+            mirrors compress.image.color_profile (its own control, decoupled from
+            metadata). `keep` (default) = preserve; `srgb` = convert to sRGB
+            (incl. CMYK→sRGB); `strip` = drop. `planned` — the convert worker
+            re-encodes from pixels and does not yet preserve/convert the profile.
+            Declared HERE so the API re-validates the rewritten Output convert op.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [format_change]
+          description: >-
+            Bake EXIF orientation into the pixels on the transcoder (format-change)
+            route — mirrors compress.image.auto_orient. `planned` — the convert worker
+            does not yet apply the orientation transform. Declared HERE so the API
+            re-validates the rewritten Output convert op.
 
     # svg is VECTOR: it converts (rasterises) to a raster format, but CANNOT be
     # raster-resized — the convert worker rejects svg resize. Split out of
@@ -248,6 +271,26 @@ operation:
             Resize mode. `max` (default) = fit within bounds, preserving aspect ratio
             and never upscaling; `crop`/`scale` = exact dimensions. Applies only when
             width or height is set.
+        color_profile:
+          type: enum
+          values: [keep, srgb, strip]
+          default: keep
+          availability: planned
+          honored_on: [format_change]
+          description: >-
+            ICC colour-profile handling (format-change route) — mirrors
+            compress.image.color_profile. `keep` (default)/`srgb`/`strip`. `planned`
+            — applies to the still-image targets; the video targets (mp4/webm) carry
+            no ICC. Declared HERE so the API re-validates the rewritten Output op.
+        auto_orient:
+          type: boolean
+          default: true
+          availability: planned
+          honored_on: [format_change]
+          description: >-
+            Bake EXIF orientation into the pixels (format-change route) — mirrors
+            compress.image.auto_orient. `planned`. Declared HERE so the API
+            re-validates the rewritten Output op.
 
     video:
       mimes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@giveitsmaller/contracts",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "Generated contract types for GISL (Give It Smaller)",
   "license": "MIT",
   "type": "module",