@giveitsmaller/contracts 0.1.2 → 0.2.3

package/operations/schemas/thumbnail.yaml

@@ -0,0 +1,120 @@
+schema_version: "1.0.0"
+
+operation:
+  type: thumbnail
+  description: "Generate a preview image from the source file"
+  default: false
+  input_model: single
+
+  mime_groups:
+    image:
+      mimes:
+        - image/jpeg
+        - image/png
+        - image/gif
+        - image/webp
+        - image/tiff
+        - image/bmp
+        - image/avif
+        - image/heic
+      options:
+        width:
+          type: integer
+          min: 1
+          max: 4096
+          required: true
+          description: "Thumbnail width in pixels"
+        height:
+          type: integer
+          min: 1
+          max: 4096
+          required: true
+          description: "Thumbnail height in pixels"
+        fit:
+          type: enum
+          values: [max, crop, scale]
+          default: crop
+          description: "Resize mode"
+        format:
+          type: enum
+          values: [jpg, png, webp]
+          default: jpg
+          description: "Output format for the thumbnail"
+
+    video:
+      mimes:
+        - video/mp4
+        - video/webm
+        - video/ogg
+      options:
+        timestamp:
+          type: string
+          default: "00:00:01"
+          description: "Frame to extract (HH:MM:SS or seconds)"
+        width:
+          type: integer
+          min: 1
+          max: 4096
+          required: true
+          description: "Thumbnail width in pixels"
+        height:
+          type: integer
+          min: 1
+          max: 4096
+          required: true
+          description: "Thumbnail height in pixels"
+        fit:
+          type: enum
+          values: [max, crop, scale]
+          default: crop
+          description: "Resize mode"
+        format:
+          type: enum
+          values: [jpg, png, webp]
+          default: jpg
+          description: "Output format for the thumbnail"
+
+    document:
+      mimes:
+        - application/pdf
+        - application/epub+zip
+        - application/vnd.openxmlformats-officedocument.wordprocessingml.document
+        - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+        - application/vnd.openxmlformats-officedocument.presentationml.presentation
+        - application/vnd.oasis.opendocument.text
+        - application/vnd.oasis.opendocument.spreadsheet
+        - application/vnd.oasis.opendocument.presentation
+      options:
+        source:
+          type: enum
+          values: [page, cover]
+          default: page
+          description: "page = render a specific page/slide, cover = extract cover image (EPUB only, ignored for other formats)"
+        page:
+          type: integer
+          min: 1
+          default: 1
+          depends_on: { source: page }
+          description: "Page/sheet/slide number to render"
+        width:
+          type: integer
+          min: 1
+          max: 4096
+          required: true
+          description: "Thumbnail width in pixels"
+        height:
+          type: integer
+          min: 1
+          max: 4096
+          required: true
+          description: "Thumbnail height in pixels"
+        fit:
+          type: enum
+          values: [max, crop, scale]
+          default: crop
+          description: "Resize mode"
+        format:
+          type: enum
+          values: [jpg, png, webp]
+          default: jpg
+          description: "Output format for the thumbnail"

package/operations/schemas/watermark.yaml

@@ -0,0 +1,87 @@
+schema_version: "1.1.0"
+
+operation:
+  type: watermark
+  description: "Apply a branding or protection overlay (image or text) to the source image. Source capped at 25 megapixels."
+  default: false
+  input_model: single
+
+  mime_groups:
+    image:
+      mimes:
+        - image/jpeg
+        - image/png
+        - image/webp
+      options:
+        watermark_type:
+          type: enum
+          values: [image, text]
+          default: image
+          description: "Overlay type. image = PNG/JPEG overlay fetched from S3, text = rendered text overlay using bundled Liberation Sans"
+
+        position:
+          type: enum
+          values: [center, top-left, top-right, bottom-left, bottom-right]
+          default: center
+          description: "Where the watermark is placed on the source image"
+
+        opacity:
+          type: float
+          min: 0.0
+          max: 1.0
+          default: 0.5
+          description: "Overlay opacity (0 = fully transparent, 1 = fully opaque). Clamped to range."
+
+        watermark_bucket:
+          type: string
+          required: true
+          depends_on: { watermark_type: image }
+          description: "S3 bucket containing the overlay image. Required when watermark_type is image."
+
+        watermark_key:
+          type: string
+          required: true
+          depends_on: { watermark_type: image }
+          description: "S3 key of the overlay image. Fetched in parallel with the source. Required when watermark_type is image."
+
+        text:
+          type: string
+          required: true
+          depends_on: { watermark_type: text }
+          description: "Watermark text. Must be non-empty. Rendered with bundled Liberation Sans (SIL OFL). Required when watermark_type is text."
+
+        font_size:
+          type: float
+          min: 8.0
+          max: 512.0
+          default: 48.0
+          depends_on: { watermark_type: text }
+          description: "Font size in pixels. Clamped to range. A single text overlay is capped at 4 megapixels before rendering fails."
+
+        color:
+          type: string
+          default: "#FFFFFF80"
+          depends_on: { watermark_type: text }
+          description: "Text colour as hex RGB (#RRGGBB) or RGBA (#RRGGBBAA). Default is white with 50% alpha."
+
+        watermark_mode:
+          type: enum
+          values: [single, tiled]
+          default: single
+          depends_on: { watermark_type: text }
+          description: "Text rendering mode. single = one label at position, tiled = repeated across the source. Distinct from watermark_type — both keys are read independently."
+
+        rotation:
+          type: float
+          min: -360.0
+          max: 360.0
+          default: -45.0
+          depends_on: { watermark_type: text }
+          description: "Rotation angle in degrees. Clamped to range. Tiled canvas is capped at 25 megapixels pre-rotation with a 5000 px maximum side length."
+
+        tile_spacing:
+          type: integer
+          min: 0
+          max: 1000
+          depends_on: { watermark_type: text, watermark_mode: tiled }
+          description: "Spacing between tiled text labels in pixels. Defaults to font_size if omitted. Only applies when watermark_mode is tiled."

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@giveitsmaller/contracts",
-  "version": "0.1.2",
+  "version": "0.2.3",
   "description": "Generated contract types for GISL (Give It Smaller)",
   "license": "MIT",
   "type": "module",
@@ -22,10 +22,21 @@
     "./operations": {
       "types": "./dist/operations/index.d.ts",
       "default": "./dist/operations/index.js"
-    }
+    },
+    "./openapi/api.yaml": "./openapi/api.yaml",
+    "./asyncapi/events.yaml": "./asyncapi/events.yaml",
+    "./operations/schemas/archive.yaml": "./operations/schemas/archive.yaml",
+    "./operations/schemas/compress.yaml": "./operations/schemas/compress.yaml",
+    "./operations/schemas/convert.yaml": "./operations/schemas/convert.yaml",
+    "./operations/schemas/merge.yaml": "./operations/schemas/merge.yaml",
+    "./operations/schemas/thumbnail.yaml": "./operations/schemas/thumbnail.yaml",
+    "./operations/schemas/watermark.yaml": "./operations/schemas/watermark.yaml"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "openapi/api.yaml",
+    "asyncapi/events.yaml",
+    "operations/schemas/"
   ],
   "scripts": {
     "build": "tsc",