@giveitsmaller/contracts 0.2.3 → 0.4.0

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

@@ -1,63 +0,0 @@
-/**
- * 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.
- */
-/**
- * Export configuration. When set, all operation outputs are copied to the
- * customer's destination in addition to GISL's own S3 storage.
- * Currently supports AWS S3 via cross-account AssumeRole.
- *
- * @export
- * @interface ExportConfig
- */
-export interface ExportConfig {
-    /**
-     * Destination service
-     * @type {string}
-     * @memberof ExportConfig
-     */
-    service: ExportConfigServiceEnum;
-    /**
-     * Destination bucket name
-     * @type {string}
-     * @memberof ExportConfig
-     */
-    bucket: string;
-    /**
-     * Key prefix for exported files
-     * @type {string}
-     * @memberof ExportConfig
-     */
-    keyPrefix?: string;
-    /**
-     * IAM role ARN in the customer's AWS account. GISL's Lambda assumes this
-     * role to write to the customer's bucket. The customer must configure a
-     * trust policy allowing GISL's execution role to assume it.
-     *
-     * @type {string}
-     * @memberof ExportConfig
-     */
-    roleArn: string;
-}
-/**
- * @export
- */
-export declare const ExportConfigServiceEnum: {
-    readonly s3: "s3";
-};
-export type ExportConfigServiceEnum = typeof ExportConfigServiceEnum[keyof typeof ExportConfigServiceEnum];
-/**
- * Check if a given object implements the ExportConfig interface.
- */
-export declare function instanceOfExportConfig(value: object): value is ExportConfig;
-export declare function ExportConfigFromJSON(json: any): ExportConfig;
-export declare function ExportConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ExportConfig;
-export declare function ExportConfigToJSON(json: any): ExportConfig;
-export declare function ExportConfigToJSONTyped(value?: ExportConfig | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/ExportConfig.js

@@ -1,59 +0,0 @@
-/* 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.
- */
-/**
- * @export
- */
-export const ExportConfigServiceEnum = {
-    s3: 's3'
-};
-/**
- * Check if a given object implements the ExportConfig interface.
- */
-export function instanceOfExportConfig(value) {
-    if (!('service' in value) || value['service'] === undefined)
-        return false;
-    if (!('bucket' in value) || value['bucket'] === undefined)
-        return false;
-    if (!('roleArn' in value) || value['roleArn'] === undefined)
-        return false;
-    return true;
-}
-export function ExportConfigFromJSON(json) {
-    return ExportConfigFromJSONTyped(json, false);
-}
-export function ExportConfigFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'service': json['service'],
-        'bucket': json['bucket'],
-        'keyPrefix': json['key_prefix'] == null ? undefined : json['key_prefix'],
-        'roleArn': json['role_arn'],
-    };
-}
-export function ExportConfigToJSON(json) {
-    return ExportConfigToJSONTyped(json, false);
-}
-export function ExportConfigToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'service': value['service'],
-        'bucket': value['bucket'],
-        'key_prefix': value['keyPrefix'],
-        'role_arn': value['roleArn'],
-    };
-}

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

@@ -1,53 +0,0 @@
-/**
- * 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.
- */
-/**
- * Single input reference for multi-input operations. Each references a
- * specific job and optionally a specific operation output from that job.
- *
- * @export
- * @interface JobInput
- */
-export interface JobInput {
-    /**
-     * Reference label of the upstream job
-     * @type {string}
-     * @memberof JobInput
-     */
-    ref: string;
-    /**
-     * Specific operation output to use. If omitted, uses the last
-     * operation's output.
-     *
-     * @type {string}
-     * @memberof JobInput
-     */
-    operation?: string;
-    /**
-     * Per-input option overrides. For merge operations, individual inputs
-     * can override global transition settings for the join point preceding
-     * this input. Keys are option names, values are the override values.
-     *
-     * @type {{ [key: string]: any; }}
-     * @memberof JobInput
-     */
-    perInputOptions?: {
-        [key: string]: any;
-    };
-}
-/**
- * Check if a given object implements the JobInput interface.
- */
-export declare function instanceOfJobInput(value: object): value is JobInput;
-export declare function JobInputFromJSON(json: any): JobInput;
-export declare function JobInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobInput;
-export declare function JobInputToJSON(json: any): JobInput;
-export declare function JobInputToJSONTyped(value?: JobInput | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/JobInput.js

@@ -1,47 +0,0 @@
-/* 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.
- */
-/**
- * Check if a given object implements the JobInput interface.
- */
-export function instanceOfJobInput(value) {
-    if (!('ref' in value) || value['ref'] === undefined)
-        return false;
-    return true;
-}
-export function JobInputFromJSON(json) {
-    return JobInputFromJSONTyped(json, false);
-}
-export function JobInputFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'ref': json['ref'],
-        'operation': json['operation'] == null ? undefined : json['operation'],
-        'perInputOptions': json['per_input_options'] == null ? undefined : json['per_input_options'],
-    };
-}
-export function JobInputToJSON(json) {
-    return JobInputToJSONTyped(json, false);
-}
-export function JobInputToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'ref': value['ref'],
-        'operation': value['operation'],
-        'per_input_options': value['perInputOptions'],
-    };
-}

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

@@ -1,43 +0,0 @@
-/**
- * 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.
- */
-/**
- * Reference to another job's output for single-input downstream jobs.
- * The input is the referenced job's output, resolved via the incoming
- * workflow edge.
- *
- * @export
- * @interface JobSource
- */
-export interface JobSource {
-    /**
-     * Reference label of the upstream job
-     * @type {string}
-     * @memberof JobSource
-     */
-    ref: string;
-    /**
-     * Specific operation output to use from the upstream job.
-     * If omitted, uses the last operation's output.
-     *
-     * @type {string}
-     * @memberof JobSource
-     */
-    operation?: string;
-}
-/**
- * Check if a given object implements the JobSource interface.
- */
-export declare function instanceOfJobSource(value: object): value is JobSource;
-export declare function JobSourceFromJSON(json: any): JobSource;
-export declare function JobSourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobSource;
-export declare function JobSourceToJSON(json: any): JobSource;
-export declare function JobSourceToJSONTyped(value?: JobSource | null, ignoreDiscriminator?: boolean): any;

package/dist/openapi/models/JobSource.js

@@ -1,45 +0,0 @@
-/* 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.
- */
-/**
- * Check if a given object implements the JobSource interface.
- */
-export function instanceOfJobSource(value) {
-    if (!('ref' in value) || value['ref'] === undefined)
-        return false;
-    return true;
-}
-export function JobSourceFromJSON(json) {
-    return JobSourceFromJSONTyped(json, false);
-}
-export function JobSourceFromJSONTyped(json, ignoreDiscriminator) {
-    if (json == null) {
-        return json;
-    }
-    return {
-        'ref': json['ref'],
-        'operation': json['operation'] == null ? undefined : json['operation'],
-    };
-}
-export function JobSourceToJSON(json) {
-    return JobSourceToJSONTyped(json, false);
-}
-export function JobSourceToJSONTyped(value, ignoreDiscriminator = false) {
-    if (value == null) {
-        return value;
-    }
-    return {
-        'ref': value['ref'],
-        'operation': value['operation'],
-    };
-}

package/dist/operations/watermark.d.ts

@@ -1,28 +0,0 @@
-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

@@ -1,19 +0,0 @@
-// 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/operations/schemas/watermark.yaml

@@ -1,87 +0,0 @@
-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."