@giveitsmaller/contracts 0.1.2 → 0.2.0

package/dist/asyncapi/OperationType.d.ts

@@ -1,6 +1,10 @@
 declare enum OperationType {
     COMPRESS = "compress",
     THUMBNAIL = "thumbnail",
+    THUMBNAIL_IMAGE = "thumbnail_image",
+    THUMBNAIL_VIDEO = "thumbnail_video",
+    THUMBNAIL_DOCUMENT = "thumbnail_document",
+    THUMBNAIL_OFFICE = "thumbnail_office",
     WATERMARK = "watermark",
     CONVERT = "convert",
     MERGE = "merge",

package/dist/asyncapi/OperationType.js

@@ -2,6 +2,10 @@ var OperationType;
 (function (OperationType) {
     OperationType["COMPRESS"] = "compress";
     OperationType["THUMBNAIL"] = "thumbnail";
+    OperationType["THUMBNAIL_IMAGE"] = "thumbnail_image";
+    OperationType["THUMBNAIL_VIDEO"] = "thumbnail_video";
+    OperationType["THUMBNAIL_DOCUMENT"] = "thumbnail_document";
+    OperationType["THUMBNAIL_OFFICE"] = "thumbnail_office";
     OperationType["WATERMARK"] = "watermark";
     OperationType["CONVERT"] = "convert";
     OperationType["MERGE"] = "merge";

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

@@ -10,7 +10,14 @@
  * Do not edit the class manually.
  */
 /**
- * Media type category derived from MIME type. Used for SNS routing:
+ * Media type category derived from MIME type. Used as the
+ * `job_type` SNS message attribute on the `job-requests` topic —
+ * the single filter attribute that routes compression traffic to
+ * per-media-type compression queues. Not used by any other SNS
+ * topic; non-compression operations are routed by `operation_type`
+ * on the separate `operations` topic.
+ *
+ * Derivation:
  * - image/* -> image
  * - video/* -> video
  * - audio/* -> audio

package/dist/openapi/models/JobType.js

@@ -12,7 +12,14 @@
  * Do not edit the class manually.
  */
 /**
- * Media type category derived from MIME type. Used for SNS routing:
+ * Media type category derived from MIME type. Used as the
+ * `job_type` SNS message attribute on the `job-requests` topic —
+ * the single filter attribute that routes compression traffic to
+ * per-media-type compression queues. Not used by any other SNS
+ * topic; non-compression operations are routed by `operation_type`
+ * on the separate `operations` topic.
+ *
+ * Derivation:
  * - image/* -> image
  * - video/* -> video
  * - audio/* -> audio

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

@@ -11,7 +11,9 @@
  */
 /**
  * Whether the operation accepts a single file or multiple files:
- * - single: One input file (compress, thumbnail, watermark, convert)
+ * - single: One input file (compress, thumbnail, thumbnail_image,
+ *   thumbnail_video, thumbnail_document, thumbnail_office,
+ *   watermark, convert)
  * - multi: Multiple input files (merge, archive)
  *
  * @export

package/dist/openapi/models/OperationInputModel.js

@@ -13,7 +13,9 @@
  */
 /**
  * Whether the operation accepts a single file or multiple files:
- * - single: One input file (compress, thumbnail, watermark, convert)
+ * - single: One input file (compress, thumbnail, thumbnail_image,
+ *   thumbnail_video, thumbnail_document, thumbnail_office,
+ *   watermark, convert)
  * - multi: Multiple input files (merge, archive)
  *
  * @export

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

@@ -12,17 +12,39 @@
 /**
  * Available operation types:
  * - compress: Reduce file size (images, audio, video, documents)
- * - thumbnail: Generate preview image (images, video, documents)
- * - watermark: Apply branding/protection (images, video, audio, documents)
+ * - thumbnail: Legacy thumbnail value. Generates a preview image
+ *   for any media type via a single Lambda. Currently the only
+ *   thumbnail value the compression_api publisher emits; retirement
+ *   is planned after the publisher adopts the four sub-type values
+ *   below in a follow-up API PR.
+ * - thumbnail_image: Image thumbnail sub-type. Backed by a dedicated
+ *   Rust image Lambda. Not yet emitted by the publisher.
+ * - thumbnail_video: Video thumbnail sub-type. Backed by a dedicated
+ *   FFmpeg Lambda. Not yet emitted.
+ * - thumbnail_document: PDF/EPUB thumbnail sub-type. Backed by a
+ *   dedicated Ghostscript Lambda. Not yet emitted.
+ * - thumbnail_office: Office document (DOCX/XLSX/PPTX/ODT/ODS/ODP)
+ *   thumbnail sub-type. Backed by a dedicated LibreOffice Lambda.
+ *   Not yet emitted.
+ * - watermark: Apply branding/protection (images only)
  * - merge: Concatenate/combine multiple files into one (images, video, audio, documents/PDF). Multi-input.
  * - archive: Bundle files into ZIP/tar.gz (all types). Multi-input.
  * - convert: Change file format (all types)
  *
+ * Both the legacy `thumbnail` value and the four sub-type values
+ * are valid routing targets today during the thumbnail migration
+ * window. See `asyncapi/events.yaml` for the full routing
+ * vocabulary and the publisher branching rule.
+ *
  * @export
  */
 export declare const OperationType: {
     readonly compress: "compress";
     readonly thumbnail: "thumbnail";
+    readonly thumbnail_image: "thumbnail_image";
+    readonly thumbnail_video: "thumbnail_video";
+    readonly thumbnail_document: "thumbnail_document";
+    readonly thumbnail_office: "thumbnail_office";
     readonly watermark: "watermark";
     readonly merge: "merge";
     readonly archive: "archive";

package/dist/openapi/models/OperationType.js

@@ -14,17 +14,39 @@
 /**
  * Available operation types:
  * - compress: Reduce file size (images, audio, video, documents)
- * - thumbnail: Generate preview image (images, video, documents)
- * - watermark: Apply branding/protection (images, video, audio, documents)
+ * - thumbnail: Legacy thumbnail value. Generates a preview image
+ *   for any media type via a single Lambda. Currently the only
+ *   thumbnail value the compression_api publisher emits; retirement
+ *   is planned after the publisher adopts the four sub-type values
+ *   below in a follow-up API PR.
+ * - thumbnail_image: Image thumbnail sub-type. Backed by a dedicated
+ *   Rust image Lambda. Not yet emitted by the publisher.
+ * - thumbnail_video: Video thumbnail sub-type. Backed by a dedicated
+ *   FFmpeg Lambda. Not yet emitted.
+ * - thumbnail_document: PDF/EPUB thumbnail sub-type. Backed by a
+ *   dedicated Ghostscript Lambda. Not yet emitted.
+ * - thumbnail_office: Office document (DOCX/XLSX/PPTX/ODT/ODS/ODP)
+ *   thumbnail sub-type. Backed by a dedicated LibreOffice Lambda.
+ *   Not yet emitted.
+ * - watermark: Apply branding/protection (images only)
  * - merge: Concatenate/combine multiple files into one (images, video, audio, documents/PDF). Multi-input.
  * - archive: Bundle files into ZIP/tar.gz (all types). Multi-input.
  * - convert: Change file format (all types)
  *
+ * Both the legacy `thumbnail` value and the four sub-type values
+ * are valid routing targets today during the thumbnail migration
+ * window. See `asyncapi/events.yaml` for the full routing
+ * vocabulary and the publisher branching rule.
+ *
  * @export
  */
 export const OperationType = {
     compress: 'compress',
     thumbnail: 'thumbnail',
+    thumbnail_image: 'thumbnail_image',
+    thumbnail_video: 'thumbnail_video',
+    thumbnail_document: 'thumbnail_document',
+    thumbnail_office: 'thumbnail_office',
     watermark: 'watermark',
     merge: 'merge',
     archive: 'archive',

package/dist/operations/index.d.ts

@@ -3,3 +3,4 @@ export * from './compress.js';
 export * from './convert.js';
 export * from './merge.js';
 export * from './thumbnail.js';
+export * from './watermark.js';

package/dist/operations/index.js

@@ -4,3 +4,4 @@ export * from './compress.js';
 export * from './convert.js';
 export * from './merge.js';
 export * from './thumbnail.js';
+export * from './watermark.js';

package/dist/operations/watermark.d.ts

@@ -0,0 +1,28 @@
+export declare enum WatermarkImageWatermarkType {
+    Image = "image",
+    Text = "text"
+}
+export declare enum WatermarkImagePosition {
+    Center = "center",
+    TopLeft = "top-left",
+    TopRight = "top-right",
+    BottomLeft = "bottom-left",
+    BottomRight = "bottom-right"
+}
+export declare enum WatermarkImageWatermarkMode {
+    Single = "single",
+    Tiled = "tiled"
+}
+export interface WatermarkImageOptions {
+    watermark_type?: WatermarkImageWatermarkType;
+    position?: WatermarkImagePosition;
+    opacity?: number;
+    watermark_bucket?: string;
+    watermark_key?: string;
+    text?: string;
+    font_size?: number;
+    color?: string;
+    watermark_mode?: WatermarkImageWatermarkMode;
+    rotation?: number;
+    tile_spacing?: number;
+}

package/dist/operations/watermark.js

@@ -0,0 +1,19 @@
+// Auto-generated from watermark.yaml -- do not edit
+export var WatermarkImageWatermarkType;
+(function (WatermarkImageWatermarkType) {
+    WatermarkImageWatermarkType["Image"] = "image";
+    WatermarkImageWatermarkType["Text"] = "text";
+})(WatermarkImageWatermarkType || (WatermarkImageWatermarkType = {}));
+export var WatermarkImagePosition;
+(function (WatermarkImagePosition) {
+    WatermarkImagePosition["Center"] = "center";
+    WatermarkImagePosition["TopLeft"] = "top-left";
+    WatermarkImagePosition["TopRight"] = "top-right";
+    WatermarkImagePosition["BottomLeft"] = "bottom-left";
+    WatermarkImagePosition["BottomRight"] = "bottom-right";
+})(WatermarkImagePosition || (WatermarkImagePosition = {}));
+export var WatermarkImageWatermarkMode;
+(function (WatermarkImageWatermarkMode) {
+    WatermarkImageWatermarkMode["Single"] = "single";
+    WatermarkImageWatermarkMode["Tiled"] = "tiled";
+})(WatermarkImageWatermarkMode || (WatermarkImageWatermarkMode = {}));

package/package.json

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