@giveitsmaller/contracts 0.1.0

package/operations/README.md

@@ -0,0 +1,17 @@
+# TypeScript -- Operation Option Models
+
+> **Auto-generated** -- do not edit manually. Changes will be overwritten on the next generation run.
+>
+> Regenerate with: `make project/generate-tests`
+
+## Source
+
+- **Spec:** `compression_contracts/schemas/operations/*.yaml` (custom schema format)
+- **Generator:** Custom Python emitter (`scripts/generators/operation_schema/typescript.py`)
+- **Files:** 6
+
+## Contents
+
+TypeScript enums and interfaces for per-operation options (compression quality, thumbnail dimensions, conversion formats, etc.).
+
+Operation types covered: compress, convert, merge, thumbnail, archive.

package/operations/archive.ts

@@ -0,0 +1,16 @@
+// Auto-generated from archive.yaml -- do not edit
+
+export enum ArchiveFormat {
+  Zip = 'zip',
+  TarGz = 'tar.gz',
+}
+
+export enum ArchiveFolderStructure {
+  Flat = 'flat',
+  ByJob = 'by_job',
+}
+
+export interface ArchiveOptions {
+  format?: ArchiveFormat;
+  folder_structure?: ArchiveFolderStructure;
+}

package/operations/compress.ts

@@ -0,0 +1,177 @@
+// Auto-generated from compress.yaml -- do not edit
+
+export enum CompressImageMode {
+  Lossy = 'lossy',
+  Lossless = 'lossless',
+  Auto = 'auto',
+}
+
+export enum CompressImageFit {
+  Max = 'max',
+  Crop = 'crop',
+  Scale = 'scale',
+}
+
+export enum CompressImageMetadata {
+  All = 'all',
+  None = 'none',
+  Copyright = 'copyright',
+  Sensitive = 'sensitive',
+}
+
+export enum CompressImageIccProfile {
+  Preserve = 'preserve',
+  Strip = 'strip',
+  Srgb = 'srgb',
+}
+
+export enum CompressImageOutputFormat {
+  Original = 'original',
+  Auto = 'auto',
+  Smallest = 'smallest',
+  Jpeg = 'jpeg',
+  Png = 'png',
+  Webp = 'webp',
+  Avif = 'avif',
+}
+
+export interface CompressImageOptions {
+  mode?: CompressImageMode;
+  quality?: number;
+  width?: number;
+  height?: number;
+  fit?: CompressImageFit;
+  metadata?: CompressImageMetadata;
+  icc_profile?: CompressImageIccProfile;
+  auto_orient?: boolean;
+  progressive?: boolean;
+  output_format?: CompressImageOutputFormat;
+}
+
+export enum CompressAudioBitrate {
+  _64 = 64,
+  _96 = 96,
+  _128 = 128,
+  _192 = 192,
+  _256 = 256,
+  _320 = 320,
+}
+
+export enum CompressAudioSampleRate {
+  _22050 = 22050,
+  _44100 = 44100,
+  _48000 = 48000,
+}
+
+export interface CompressAudioOptions {
+  bitrate?: CompressAudioBitrate;
+  channels?: number;
+  sample_rate?: CompressAudioSampleRate;
+  normalize?: boolean;
+  trim_start?: number;
+  trim_end?: number;
+}
+
+export enum CompressVideoCodec {
+  H264 = 'h264',
+  H265 = 'h265',
+  Vp9 = 'vp9',
+  Av1 = 'av1',
+}
+
+export enum CompressVideoEncodingMode {
+  Crf = 'crf',
+  TargetSize = 'target_size',
+}
+
+export enum CompressVideoPreset {
+  Ultrafast = 'ultrafast',
+  Superfast = 'superfast',
+  Veryfast = 'veryfast',
+  Faster = 'faster',
+  Fast = 'fast',
+  Medium = 'medium',
+  Slow = 'slow',
+  Slower = 'slower',
+  Veryslow = 'veryslow',
+}
+
+export enum CompressVideoFit {
+  Max = 'max',
+  Crop = 'crop',
+  Scale = 'scale',
+  Pad = 'pad',
+}
+
+export enum CompressVideoAudioCodec {
+  Aac = 'aac',
+  Opus = 'opus',
+  Vorbis = 'vorbis',
+  Copy = 'copy',
+}
+
+export enum CompressVideoAudioBitrate {
+  _64 = 64,
+  _96 = 96,
+  _128 = 128,
+  _192 = 192,
+  _256 = 256,
+  _320 = 320,
+}
+
+export interface CompressVideoOptions {
+  codec?: CompressVideoCodec;
+  encoding_mode?: CompressVideoEncodingMode;
+  crf?: number;
+  target_size_bytes?: number;
+  preset?: CompressVideoPreset;
+  width?: number;
+  height?: number;
+  fit?: CompressVideoFit;
+  fps?: number;
+  faststart?: boolean;
+  audio_codec?: CompressVideoAudioCodec;
+  audio_bitrate?: CompressVideoAudioBitrate;
+  trim_start?: number;
+  trim_end?: number;
+}
+
+export enum CompressDocumentPdfProfile {
+  Web = 'web',
+  Print = 'print',
+  Archive = 'archive',
+  Max = 'max',
+}
+
+export enum CompressDocumentPdfColorspace {
+  Unchanged = 'unchanged',
+  Rgb = 'rgb',
+  Cmyk = 'cmyk',
+  Grayscale = 'grayscale',
+}
+
+export interface CompressDocumentPdfOptions {
+  profile?: CompressDocumentPdfProfile;
+  colorspace?: CompressDocumentPdfColorspace;
+  pages?: string;
+  flatten_forms?: boolean;
+}
+
+export interface CompressDocumentOfficeOptions {
+  image_quality?: number;
+  strip_macros?: boolean;
+  strip_hidden_data?: boolean;
+  strip_unused_fonts?: boolean;
+}
+
+export interface CompressDocumentOdfOptions {
+  image_quality?: number;
+  strip_metadata?: boolean;
+  strip_unused_styles?: boolean;
+}
+
+export interface CompressDocumentEpubOptions {
+  image_quality?: number;
+  font_subsetting?: boolean;
+  strip_unused_css?: boolean;
+}

package/operations/convert.ts

@@ -0,0 +1,69 @@
+// Auto-generated from convert.yaml -- do not edit
+
+export enum ConvertImageOutputFormat {
+  Jpeg = 'jpeg',
+  Png = 'png',
+  Webp = 'webp',
+  Avif = 'avif',
+  Gif = 'gif',
+  Tiff = 'tiff',
+}
+
+export interface ConvertImageOptions {
+  output_format: ConvertImageOutputFormat;
+  quality?: number;
+  background?: string;
+}
+
+export enum ConvertVideoOutputFormat {
+  Mp4 = 'mp4',
+  Webm = 'webm',
+  Ogg = 'ogg',
+  Gif = 'gif',
+}
+
+export enum ConvertVideoCodec {
+  H264 = 'h264',
+  H265 = 'h265',
+  Vp9 = 'vp9',
+  Av1 = 'av1',
+}
+
+export interface ConvertVideoOptions {
+  output_format: ConvertVideoOutputFormat;
+  codec?: ConvertVideoCodec;
+  quality?: number;
+}
+
+export enum ConvertAudioOutputFormat {
+  Mp3 = 'mp3',
+  Aac = 'aac',
+  Ogg = 'ogg',
+  Flac = 'flac',
+  Wav = 'wav',
+}
+
+export enum ConvertAudioBitrate {
+  _64 = 64,
+  _96 = 96,
+  _128 = 128,
+  _192 = 192,
+  _256 = 256,
+  _320 = 320,
+}
+
+export interface ConvertAudioOptions {
+  output_format: ConvertAudioOutputFormat;
+  bitrate?: ConvertAudioBitrate;
+}
+
+export enum ConvertDocumentPdfOutputFormat {
+  Png = 'png',
+  Jpeg = 'jpeg',
+}
+
+export interface ConvertDocumentPdfOptions {
+  output_format: ConvertDocumentPdfOutputFormat;
+  pages?: string;
+  dpi?: number;
+}

package/operations/index.ts

@@ -0,0 +1,7 @@
+// Auto-generated -- do not edit
+
+export * from './archive';
+export * from './compress';
+export * from './convert';
+export * from './merge';
+export * from './thumbnail';

package/operations/merge.ts

@@ -0,0 +1,95 @@
+// Auto-generated from merge.yaml -- do not edit
+
+export enum MergeImageOutputType {
+  Image = 'image',
+  Gif = 'gif',
+  Video = 'video',
+}
+
+export enum MergeImageLayout {
+  Grid = 'grid',
+  Horizontal = 'horizontal',
+  Vertical = 'vertical',
+}
+
+export enum MergeImageResizeMode {
+  Fit = 'fit',
+  Fill = 'fill',
+  None = 'none',
+}
+
+export enum MergeImageImageFormat {
+  Jpeg = 'jpeg',
+  Png = 'png',
+  Webp = 'webp',
+}
+
+export enum MergeImageTransition {
+  None = 'none',
+  Fade = 'fade',
+  Slide = 'slide',
+}
+
+export enum MergeImageVideoFormat {
+  Mp4 = 'mp4',
+  Webm = 'webm',
+}
+
+export interface MergeImageOptions {
+  output_type?: MergeImageOutputType;
+  layout?: MergeImageLayout;
+  columns?: number;
+  resize_mode?: MergeImageResizeMode;
+  spacing?: number;
+  background?: string;
+  image_format?: MergeImageImageFormat;
+  delay?: number;
+  loop_count?: number;
+  duration_per_image?: number;
+  transition?: MergeImageTransition;
+  transition_duration?: number;
+  fps?: number;
+  video_format?: MergeImageVideoFormat;
+}
+
+export enum MergeVideoTransition {
+  None = 'none',
+  Crossfade = 'crossfade',
+}
+
+export interface MergeVideoOptions {
+  transition?: MergeVideoTransition;
+  crossfade_duration?: number;
+  normalize_audio?: boolean;
+}
+
+export interface MergeVideoPerInputOptions {
+  transition?: MergeVideoTransition;
+  crossfade_duration?: number;
+}
+
+export enum MergeAudioTransition {
+  None = 'none',
+  Crossfade = 'crossfade',
+}
+
+export interface MergeAudioOptions {
+  transition?: MergeAudioTransition;
+  crossfade_duration?: number;
+  gap_duration?: number;
+  normalize_audio?: boolean;
+}
+
+export interface MergeAudioPerInputOptions {
+  transition?: MergeAudioTransition;
+  crossfade_duration?: number;
+  gap_duration?: number;
+}
+
+export interface MergeDocumentOptions {
+  page_range?: string;
+}
+
+export interface MergeDocumentPerInputOptions {
+  page_range?: string;
+}

package/operations/thumbnail.ts

@@ -0,0 +1,66 @@
+// Auto-generated from thumbnail.yaml -- do not edit
+
+export enum ThumbnailImageFit {
+  Max = 'max',
+  Crop = 'crop',
+  Scale = 'scale',
+}
+
+export enum ThumbnailImageFormat {
+  Jpg = 'jpg',
+  Png = 'png',
+  Webp = 'webp',
+}
+
+export interface ThumbnailImageOptions {
+  width: number;
+  height: number;
+  fit?: ThumbnailImageFit;
+  format?: ThumbnailImageFormat;
+}
+
+export enum ThumbnailVideoFit {
+  Max = 'max',
+  Crop = 'crop',
+  Scale = 'scale',
+}
+
+export enum ThumbnailVideoFormat {
+  Jpg = 'jpg',
+  Png = 'png',
+  Webp = 'webp',
+}
+
+export interface ThumbnailVideoOptions {
+  timestamp?: string;
+  width: number;
+  height: number;
+  fit?: ThumbnailVideoFit;
+  format?: ThumbnailVideoFormat;
+}
+
+export enum ThumbnailDocumentSource {
+  Page = 'page',
+  Cover = 'cover',
+}
+
+export enum ThumbnailDocumentFit {
+  Max = 'max',
+  Crop = 'crop',
+  Scale = 'scale',
+}
+
+export enum ThumbnailDocumentFormat {
+  Jpg = 'jpg',
+  Png = 'png',
+  Webp = 'webp',
+}
+
+export interface ThumbnailDocumentOptions {
+  source?: ThumbnailDocumentSource;
+  page?: number;
+  width: number;
+  height: number;
+  fit?: ThumbnailDocumentFit;
+  format?: ThumbnailDocumentFormat;
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@giveitsmaller/contracts",
+  "version": "0.1.0",
+  "description": "Generated contract types for GISL (Give It Smaller)",
+  "license": "MIT",
+  "types": "index.ts",
+  "exports": {
+    ".": "./index.ts",
+    "./openapi": "./openapi/index.ts",
+    "./asyncapi": "./asyncapi/index.ts",
+    "./operations": "./operations/index.ts"
+  },
+  "files": [
+    "openapi/",
+    "asyncapi/",
+    "operations/",
+    "index.ts"
+  ]
+}