@giveitsmaller/contracts 0.1.0

package/asyncapi/ErrorCode.ts

@@ -0,0 +1,19 @@
+
+enum ErrorCode {
+  S3_DOWNLOAD_FAILED = "s3_download_failed",
+  S3_UPLOAD_FAILED = "s3_upload_failed",
+  S3_ACCESS_DENIED = "s3_access_denied",
+  OUT_OF_MEMORY = "out_of_memory",
+  TIMEOUT = "timeout",
+  INVALID_FORMAT = "invalid_format",
+  FORMAT_MISMATCH = "format_mismatch",
+  DECODE_FAILED = "decode_failed",
+  PROCESSING_FAILED = "processing_failed",
+  OUTPUT_TOO_LARGE = "output_too_large",
+  INVALID_OPTIONS = "invalid_options",
+  MISSING_SOURCE = "missing_source",
+  INVALID_KEY = "invalid_key",
+  INVALID_REQUEST = "invalid_request",
+  UNKNOWN = "unknown",
+}
+export default ErrorCode;

package/asyncapi/MergeOutputType.ts

@@ -0,0 +1,9 @@
+
+enum MergeOutputType {
+  RESERVED_IMAGE = "image",
+  GIF = "gif",
+  VIDEO = "video",
+  AUDIO = "audio",
+  RESERVED_DOCUMENT = "document",
+}
+export default MergeOutputType;

package/asyncapi/NotificationsOperationsQueue.ts

@@ -0,0 +1,4 @@
+import OperationProgress from './OperationProgress';
+import OperationResult from './OperationResult';
+type NotificationsOperationsQueue = OperationProgress | OperationResult;
+export default NotificationsOperationsQueue;

package/asyncapi/OperationMetrics.ts

@@ -0,0 +1,12 @@
+
+interface OperationMetrics {
+  'original_size_bytes'?: number;
+  'output_size_bytes'?: number;
+  'compression_ratio'?: number;
+  'duration_ms'?: number;
+  'input_count'?: number;
+  'file_count'?: number;
+  'total_input_size_bytes'?: number;
+  'additionalProperties'?: Record<string, any>;
+}
+export default OperationMetrics;

package/asyncapi/OperationProgress.ts

@@ -0,0 +1,12 @@
+import OperationType from './OperationType';
+import ProgressStatus from './ProgressStatus';
+interface OperationProgress {
+  'job_id': string;
+  'operation_id': string;
+  'operation_type': OperationType;
+  'status': ProgressStatus;
+  'progress': number;
+  'stage'?: string;
+  'additionalProperties'?: Record<string, any>;
+}
+export default OperationProgress;

package/asyncapi/OperationRequest.ts

@@ -0,0 +1,21 @@
+import OperationType from './OperationType';
+import SourceEntry from './SourceEntry';
+import MergeOutputType from './MergeOutputType';
+interface OperationRequest {
+  'job_id': string;
+  'operation_id': string;
+  'operation_type': OperationType;
+  'workflow_id'?: string;
+  'file_type'?: string;
+  'source_bucket'?: string;
+  'source_key'?: string;
+  'sources'?: SourceEntry[];
+  'output_bucket': string;
+  'output_key_prefix': string;
+  'output_type'?: MergeOutputType;
+  'options'?: Record<string, any>;
+  'source_credentials'?: Record<string, any>;
+  'export'?: Record<string, any>;
+  'additionalProperties'?: Record<string, any>;
+}
+export default OperationRequest;

package/asyncapi/OperationResult.ts

@@ -0,0 +1,20 @@
+import OperationType from './OperationType';
+import ResultStatus from './ResultStatus';
+import OperationMetrics from './OperationMetrics';
+import ErrorCode from './ErrorCode';
+interface OperationResult {
+  'job_id': string;
+  'operation_id': string;
+  'operation_type': OperationType;
+  'status': ResultStatus;
+  'output_bucket'?: string;
+  'output_key'?: string;
+  'output_size_bytes'?: number;
+  'metrics'?: OperationMetrics;
+  'error_code'?: ErrorCode;
+  'error_message'?: string;
+  'is_retryable'?: boolean;
+  'last_progress'?: number;
+  'additionalProperties'?: Record<string, any>;
+}
+export default OperationResult;

package/asyncapi/OperationType.ts

@@ -0,0 +1,10 @@
+
+enum OperationType {
+  COMPRESS = "compress",
+  THUMBNAIL = "thumbnail",
+  WATERMARK = "watermark",
+  CONVERT = "convert",
+  MERGE = "merge",
+  ARCHIVE = "archive",
+}
+export default OperationType;

package/asyncapi/ProgressStatus.ts

@@ -0,0 +1,8 @@
+
+enum ProgressStatus {
+  STARTED = "started",
+  DOWNLOADING = "downloading",
+  PROCESSING = "processing",
+  UPLOADING = "uploading",
+}
+export default ProgressStatus;

package/asyncapi/README.md

@@ -0,0 +1,16 @@
+# TypeScript -- AsyncAPI Event 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/asyncapi/events.yaml` (AsyncAPI 3.0)
+- **Generator:** [asyncapi/cli](https://www.asyncapi.com/tools/cli) 6.0.0
+  (Docker image: `asyncapi/cli:6.0.0`)
+- **Files:** 12
+
+## Contents
+
+TypeScript interfaces and enum types for async event models (operation requests, progress updates, results).

package/asyncapi/ResultStatus.ts

@@ -0,0 +1,6 @@
+
+enum ResultStatus {
+  COMPLETED = "completed",
+  FAILED = "failed",
+}
+export default ResultStatus;

package/asyncapi/SourceEntry.ts

@@ -0,0 +1,9 @@
+
+interface SourceEntry {
+  'bucket': string;
+  'key': string;
+  'transition'?: string;
+  'page_range'?: string;
+  'additionalProperties'?: Record<string, any>;
+}
+export default SourceEntry;

package/asyncapi/index.ts

@@ -0,0 +1,11 @@
+export { default as ErrorCode } from './ErrorCode';
+export { default as MergeOutputType } from './MergeOutputType';
+export { default as NotificationsOperationsQueue } from './NotificationsOperationsQueue';
+export { default as OperationMetrics } from './OperationMetrics';
+export { default as OperationProgress } from './OperationProgress';
+export { default as OperationRequest } from './OperationRequest';
+export { default as OperationResult } from './OperationResult';
+export { default as OperationType } from './OperationType';
+export { default as ProgressStatus } from './ProgressStatus';
+export { default as ResultStatus } from './ResultStatus';
+export { default as SourceEntry } from './SourceEntry';

package/index.ts

@@ -0,0 +1,5 @@
+// Auto-generated -- do not edit
+
+export * as openapi from './openapi/index';
+export * as asyncapi from './asyncapi/index';
+export * as operations from './operations/index';

package/openapi/.openapi-generator-ignore

@@ -0,0 +1,26 @@
+# Ignore everything except models and required supporting files
+docs/**
+test/**
+tests/**
+.travis.yml
+.gitlab-ci.yml
+.github/**
+git_push.sh
+tox.ini
+setup.cfg
+setup.py
+pyproject.toml
+requirements.txt
+test-requirements.txt
+README.md
+.gitignore
+.openapi-generator/**
+# PHP-specific junk
+.php-cs-fixer.dist.php
+phpunit.xml.dist
+# Package manifests (unified manifest generated separately)
+composer.json
+# No API clients needed (models only)
+**/api/**
+**/apis/**
+**/Api/**

package/openapi/README.md

@@ -0,0 +1,17 @@
+# TypeScript -- OpenAPI 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/openapi/api.yaml` (OpenAPI 3.1)
+- **Generator:** [openapi-generator-cli](https://openapi-generator.tech/) v7.13.0
+  (Docker image: `openapitools/openapi-generator-cli:v7.13.0`)
+- **Generator preset:** `typescript-fetch`, models only
+- **Files:** 65
+
+## Contents
+
+TypeScript interfaces and enum types for the REST API, generated with the `typescript-fetch` generator.

package/openapi/index.ts

@@ -0,0 +1,4 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './models/index';

package/openapi/models/CallbackEventType.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GISL Compression API
+ * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Events that can trigger a webhook callback:
+ * - workflow.completed: All jobs done successfully
+ * - workflow.failed: At least one job failed, none in progress
+ * - workflow.partially_failed: Some succeeded, some failed
+ * - operation.completed: Individual operation done (opt-in for granular progress)
+ * 
+ * @export
+ */
+export const CallbackEventType = {
+    workflow_completed: 'workflow.completed',
+    workflow_failed: 'workflow.failed',
+    workflow_partially_failed: 'workflow.partially_failed',
+    operation_completed: 'operation.completed'
+} as const;
+export type CallbackEventType = typeof CallbackEventType[keyof typeof CallbackEventType];
+
+
+export function instanceOfCallbackEventType(value: any): boolean {
+    for (const key in CallbackEventType) {
+        if (Object.prototype.hasOwnProperty.call(CallbackEventType, key)) {
+            if (CallbackEventType[key as keyof typeof CallbackEventType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function CallbackEventTypeFromJSON(json: any): CallbackEventType {
+    return CallbackEventTypeFromJSONTyped(json, false);
+}
+
+export function CallbackEventTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): CallbackEventType {
+    return json as CallbackEventType;
+}
+
+export function CallbackEventTypeToJSON(value?: CallbackEventType | null): any {
+    return value as any;
+}
+
+export function CallbackEventTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): CallbackEventType {
+    return value as CallbackEventType;
+}
+

package/openapi/models/ContactRequest.ts

@@ -0,0 +1,113 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GISL Compression API
+ * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ContactSubject } from './ContactSubject';
+import {
+    ContactSubjectFromJSON,
+    ContactSubjectFromJSONTyped,
+    ContactSubjectToJSON,
+    ContactSubjectToJSONTyped,
+} from './ContactSubject';
+
+/**
+ * 
+ * @export
+ * @interface ContactRequest
+ */
+export interface ContactRequest {
+    /**
+     * Sender's name (optional)
+     * @type {string}
+     * @memberof ContactRequest
+     */
+    name?: string;
+    /**
+     * Sender's email address
+     * @type {string}
+     * @memberof ContactRequest
+     */
+    email: string;
+    /**
+     * 
+     * @type {ContactSubject}
+     * @memberof ContactRequest
+     */
+    subject: ContactSubject;
+    /**
+     * Message body
+     * @type {string}
+     * @memberof ContactRequest
+     */
+    message: string;
+    /**
+     * Honeypot field for bot detection. Hidden from real users via CSS.
+     * Legitimate submissions must omit this field or send an empty string.
+     * The API rejects any request where this field is non-empty.
+     * 
+     * @type {string}
+     * @memberof ContactRequest
+     */
+    website?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the ContactRequest interface.
+ */
+export function instanceOfContactRequest(value: object): value is ContactRequest {
+    if (!('email' in value) || value['email'] === undefined) return false;
+    if (!('subject' in value) || value['subject'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    return true;
+}
+
+export function ContactRequestFromJSON(json: any): ContactRequest {
+    return ContactRequestFromJSONTyped(json, false);
+}
+
+export function ContactRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'] == null ? undefined : json['name'],
+        'email': json['email'],
+        'subject': ContactSubjectFromJSON(json['subject']),
+        'message': json['message'],
+        'website': json['website'] == null ? undefined : json['website'],
+    };
+}
+
+export function ContactRequestToJSON(json: any): ContactRequest {
+    return ContactRequestToJSONTyped(json, false);
+}
+
+export function ContactRequestToJSONTyped(value?: ContactRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'email': value['email'],
+        'subject': ContactSubjectToJSON(value['subject']),
+        'message': value['message'],
+        'website': value['website'],
+    };
+}
+

package/openapi/models/ContactSubject.ts

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GISL Compression API
+ * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Subject category:
+ * - general_enquiry: General questions
+ * - bug_report: Report a bug or issue
+ * - suggestion: Feature suggestion or improvement idea
+ * - complaint: Complaint about the service
+ * - business_enquiry: Business or partnership enquiry
+ * 
+ * @export
+ */
+export const ContactSubject = {
+    general_enquiry: 'general_enquiry',
+    bug_report: 'bug_report',
+    suggestion: 'suggestion',
+    complaint: 'complaint',
+    business_enquiry: 'business_enquiry'
+} as const;
+export type ContactSubject = typeof ContactSubject[keyof typeof ContactSubject];
+
+
+export function instanceOfContactSubject(value: any): boolean {
+    for (const key in ContactSubject) {
+        if (Object.prototype.hasOwnProperty.call(ContactSubject, key)) {
+            if (ContactSubject[key as keyof typeof ContactSubject] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ContactSubjectFromJSON(json: any): ContactSubject {
+    return ContactSubjectFromJSONTyped(json, false);
+}
+
+export function ContactSubjectFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactSubject {
+    return json as ContactSubject;
+}
+
+export function ContactSubjectToJSON(value?: ContactSubject | null): any {
+    return value as any;
+}
+
+export function ContactSubjectToJSONTyped(value: any, ignoreDiscriminator: boolean): ContactSubject {
+    return value as ContactSubject;
+}
+

package/openapi/models/ContactValidationErrorResponse.ts

@@ -0,0 +1,67 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GISL Compression API
+ * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ContactValidationErrorResponse
+ */
+export interface ContactValidationErrorResponse {
+    /**
+     * Map of field names to arrays of validation error messages.
+     * 
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof ContactValidationErrorResponse
+     */
+    errors: { [key: string]: Array<string>; };
+}
+
+/**
+ * Check if a given object implements the ContactValidationErrorResponse interface.
+ */
+export function instanceOfContactValidationErrorResponse(value: object): value is ContactValidationErrorResponse {
+    if (!('errors' in value) || value['errors'] === undefined) return false;
+    return true;
+}
+
+export function ContactValidationErrorResponseFromJSON(json: any): ContactValidationErrorResponse {
+    return ContactValidationErrorResponseFromJSONTyped(json, false);
+}
+
+export function ContactValidationErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ContactValidationErrorResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'errors': json['errors'],
+    };
+}
+
+export function ContactValidationErrorResponseToJSON(json: any): ContactValidationErrorResponse {
+    return ContactValidationErrorResponseToJSONTyped(json, false);
+}
+
+export function ContactValidationErrorResponseToJSONTyped(value?: ContactValidationErrorResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'errors': value['errors'],
+    };
+}
+

package/openapi/models/ErrorEnvelope.ts

@@ -0,0 +1,85 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * GISL Compression API
+ * REST API for the GISL (Give It Smaller) file compression and processing service.  **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, watermark, merge, archive, convert) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output  **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (CDN-cacheable), health probes return flat objects, and `POST /api/contact` returns 204 with no body. 
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Error response envelope
+ * @export
+ * @interface ErrorEnvelope
+ */
+export interface ErrorEnvelope {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ErrorEnvelope
+     */
+    success: ErrorEnvelopeSuccessEnum;
+    /**
+     * Human-readable error message
+     * @type {string}
+     * @memberof ErrorEnvelope
+     */
+    error: string;
+}
+
+
+/**
+ * @export
+ */
+export const ErrorEnvelopeSuccessEnum = {
+    false: false
+} as const;
+export type ErrorEnvelopeSuccessEnum = typeof ErrorEnvelopeSuccessEnum[keyof typeof ErrorEnvelopeSuccessEnum];
+
+
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('error' in value) || value['error'] === undefined) return false;
+    return true;
+}
+
+export function ErrorEnvelopeFromJSON(json: any): ErrorEnvelope {
+    return ErrorEnvelopeFromJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'error': json['error'],
+    };
+}
+
+export function ErrorEnvelopeToJSON(json: any): ErrorEnvelope {
+    return ErrorEnvelopeToJSONTyped(json, false);
+}
+
+export function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+    };
+}
+