@liqhtworks/sophon-sdk 0.1.0

package/dist/esm/models/ErrorBody.js

@@ -0,0 +1,74 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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
+* @enum {string}
+*/
+export var ErrorBodyCodeEnum;
+(function (ErrorBodyCodeEnum) {
+    ErrorBodyCodeEnum["VALIDATION_ERROR"] = "validation_error";
+    ErrorBodyCodeEnum["UNAUTHORIZED"] = "unauthorized";
+    ErrorBodyCodeEnum["FORBIDDEN"] = "forbidden";
+    ErrorBodyCodeEnum["NOT_FOUND"] = "not_found";
+    ErrorBodyCodeEnum["CONFLICT"] = "conflict";
+    ErrorBodyCodeEnum["RATE_LIMITED"] = "rate_limited";
+    ErrorBodyCodeEnum["QUOTA_EXCEEDED"] = "quota_exceeded";
+    ErrorBodyCodeEnum["CAPACITY_EXCEEDED"] = "capacity_exceeded";
+    ErrorBodyCodeEnum["SOURCE_INVALID"] = "source_invalid";
+    ErrorBodyCodeEnum["SOURCE_UNSUPPORTED"] = "source_unsupported";
+    ErrorBodyCodeEnum["JOB_NOT_CANCELABLE"] = "job_not_cancelable";
+    ErrorBodyCodeEnum["OUTPUT_NOT_READY"] = "output_not_ready";
+    ErrorBodyCodeEnum["OUTPUT_PERSISTENCE_FAILED"] = "output_persistence_failed";
+    ErrorBodyCodeEnum["INTERNAL_ERROR"] = "internal_error";
+})(ErrorBodyCodeEnum || (ErrorBodyCodeEnum = {}));
+/**
+ * Check if a given object implements the ErrorBody interface.
+ */
+export function instanceOfErrorBody(value) {
+    if (!('code' in value) || value['code'] === undefined)
+        return false;
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    if (!('retryable' in value) || value['retryable'] === undefined)
+        return false;
+    return true;
+}
+export function ErrorBodyFromJSON(json) {
+    return ErrorBodyFromJSONTyped(json, false);
+}
+export function ErrorBodyFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'code': json['code'],
+        'message': json['message'],
+        'retryable': json['retryable'],
+        'request_id': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+export function ErrorBodyToJSON(json) {
+    return ErrorBodyToJSONTyped(json, false);
+}
+export function ErrorBodyToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'code': value['code'],
+        'message': value['message'],
+        'retryable': value['retryable'],
+        'request_id': value['request_id'],
+    };
+}

package/dist/esm/models/ErrorEnvelope.d.ts

@@ -0,0 +1,33 @@
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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 type { ErrorBody } from './ErrorBody';
+/**
+ *
+ * @export
+ * @interface ErrorEnvelope
+ */
+export interface ErrorEnvelope {
+    /**
+     *
+     * @type {ErrorBody}
+     * @memberof ErrorEnvelope
+     */
+    error: ErrorBody;
+}
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export declare function instanceOfErrorEnvelope(value: object): value is ErrorEnvelope;
+export declare function ErrorEnvelopeFromJSON(json: any): ErrorEnvelope;
+export declare function ErrorEnvelopeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorEnvelope;
+export declare function ErrorEnvelopeToJSON(json: any): ErrorEnvelope;
+export declare function ErrorEnvelopeToJSONTyped(value?: ErrorEnvelope | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/ErrorEnvelope.js

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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 { ErrorBodyFromJSON, ErrorBodyToJSON, } from './ErrorBody';
+/**
+ * Check if a given object implements the ErrorEnvelope interface.
+ */
+export function instanceOfErrorEnvelope(value) {
+    if (!('error' in value) || value['error'] === undefined)
+        return false;
+    return true;
+}
+export function ErrorEnvelopeFromJSON(json) {
+    return ErrorEnvelopeFromJSONTyped(json, false);
+}
+export function ErrorEnvelopeFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'error': ErrorBodyFromJSON(json['error']),
+    };
+}
+export function ErrorEnvelopeToJSON(json) {
+    return ErrorEnvelopeToJSONTyped(json, false);
+}
+export function ErrorEnvelopeToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'error': ErrorBodyToJSON(value['error']),
+    };
+}

package/dist/esm/models/JobOutputInfo.d.ts

@@ -0,0 +1,95 @@
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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
+ * @interface JobOutputInfo
+ */
+export interface JobOutputInfo {
+    /**
+     *
+     * @type {JobOutputInfoStateEnum}
+     * @memberof JobOutputInfo
+     */
+    state: JobOutputInfoStateEnum;
+    /**
+     * Output container format ("mp4" or "mkv").
+     * @type {string}
+     * @memberof JobOutputInfo
+     */
+    container: string;
+    /**
+     * Whether the output file actually contains audio.
+     * Reflects the muxed result, not the request flag — a
+     * video-only source with audio requested will report false.
+     *
+     * @type {boolean}
+     * @memberof JobOutputInfo
+     */
+    audio: boolean;
+    /**
+     * Customer-requested output height, echoed back. Null when the
+     * job ran at source dimensions (passthrough).
+     *
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    target_height?: number;
+    /**
+     * Actual encoded output width in pixels (post-ffprobe). Null until
+     * the job completes or if the probe failed.
+     *
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    width?: number;
+    /**
+     * Actual encoded output height in pixels. See `width`.
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    height?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof JobOutputInfo
+     */
+    bytes?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof JobOutputInfo
+     */
+    sha256?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof JobOutputInfo
+     */
+    retention_expires_at?: Date;
+}
+/**
+* @export
+* @enum {string}
+*/
+export declare enum JobOutputInfoStateEnum {
+    PENDING = "pending",
+    AVAILABLE = "available"
+}
+/**
+ * Check if a given object implements the JobOutputInfo interface.
+ */
+export declare function instanceOfJobOutputInfo(value: object): value is JobOutputInfo;
+export declare function JobOutputInfoFromJSON(json: any): JobOutputInfo;
+export declare function JobOutputInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobOutputInfo;
+export declare function JobOutputInfoToJSON(json: any): JobOutputInfo;
+export declare function JobOutputInfoToJSONTyped(value?: JobOutputInfo | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/JobOutputInfo.js

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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
+* @enum {string}
+*/
+export var JobOutputInfoStateEnum;
+(function (JobOutputInfoStateEnum) {
+    JobOutputInfoStateEnum["PENDING"] = "pending";
+    JobOutputInfoStateEnum["AVAILABLE"] = "available";
+})(JobOutputInfoStateEnum || (JobOutputInfoStateEnum = {}));
+/**
+ * Check if a given object implements the JobOutputInfo interface.
+ */
+export function instanceOfJobOutputInfo(value) {
+    if (!('state' in value) || value['state'] === undefined)
+        return false;
+    if (!('container' in value) || value['container'] === undefined)
+        return false;
+    if (!('audio' in value) || value['audio'] === undefined)
+        return false;
+    return true;
+}
+export function JobOutputInfoFromJSON(json) {
+    return JobOutputInfoFromJSONTyped(json, false);
+}
+export function JobOutputInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'state': json['state'],
+        'container': json['container'],
+        'audio': json['audio'],
+        'target_height': json['target_height'] == null ? undefined : json['target_height'],
+        'width': json['width'] == null ? undefined : json['width'],
+        'height': json['height'] == null ? undefined : json['height'],
+        'bytes': json['bytes'] == null ? undefined : json['bytes'],
+        'sha256': json['sha256'] == null ? undefined : json['sha256'],
+        'retention_expires_at': json['retention_expires_at'] == null ? undefined : (new Date(json['retention_expires_at'])),
+    };
+}
+export function JobOutputInfoToJSON(json) {
+    return JobOutputInfoToJSONTyped(json, false);
+}
+export function JobOutputInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'state': value['state'],
+        'container': value['container'],
+        'audio': value['audio'],
+        'target_height': value['target_height'],
+        'width': value['width'],
+        'height': value['height'],
+        'bytes': value['bytes'],
+        'sha256': value['sha256'],
+        'retention_expires_at': value['retention_expires_at'] == null ? value['retention_expires_at'] : value['retention_expires_at'].toISOString(),
+    };
+}

package/dist/esm/models/JobProfile.d.ts

@@ -0,0 +1,49 @@
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+/**
+ * Encoding profile ID. Coffee-themed naming: prep time maps to encode speed,
+ * bare name is the 8-bit default (universal decoder compatibility),
+ * `-10bit` suffix opts into HEVC Main10 for higher-quality playback on
+ * newer decoders.
+ *
+ * **8-bit (default):**
+ * - `sophon-espresso` — fastest, lowest compression
+ * - `sophon-cortado` — balanced speed and quality
+ * - `sophon-americano` — slowest, highest compression
+ *
+ * **10-bit (HEVC Main10):**
+ * - `sophon-espresso-10bit`
+ * - `sophon-cortado-10bit`
+ * - `sophon-americano-10bit`
+ *
+ * **Adaptive dispatcher:**
+ * - `sophon-auto` — public opt-in profile. The worker classifies
+ *   the source and records the concrete `effective_profile_id` on
+ *   the job once dispatch resolves.
+ *
+ * @export
+ * @enum {string}
+ */
+export declare enum JobProfile {
+    SOPHON_ESPRESSO = "sophon-espresso",
+    SOPHON_CORTADO = "sophon-cortado",
+    SOPHON_AMERICANO = "sophon-americano",
+    SOPHON_ESPRESSO_10BIT = "sophon-espresso-10bit",
+    SOPHON_CORTADO_10BIT = "sophon-cortado-10bit",
+    SOPHON_AMERICANO_10BIT = "sophon-americano-10bit",
+    SOPHON_AUTO = "sophon-auto"
+}
+export declare function instanceOfJobProfile(value: any): boolean;
+export declare function JobProfileFromJSON(json: any): JobProfile;
+export declare function JobProfileFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobProfile;
+export declare function JobProfileToJSON(value?: JobProfile | null): any;
+export declare function JobProfileToJSONTyped(value: any, ignoreDiscriminator: boolean): JobProfile;

package/dist/esm/models/JobProfile.js

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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.
+ */
+/**
+ * Encoding profile ID. Coffee-themed naming: prep time maps to encode speed,
+ * bare name is the 8-bit default (universal decoder compatibility),
+ * `-10bit` suffix opts into HEVC Main10 for higher-quality playback on
+ * newer decoders.
+ *
+ * **8-bit (default):**
+ * - `sophon-espresso` — fastest, lowest compression
+ * - `sophon-cortado` — balanced speed and quality
+ * - `sophon-americano` — slowest, highest compression
+ *
+ * **10-bit (HEVC Main10):**
+ * - `sophon-espresso-10bit`
+ * - `sophon-cortado-10bit`
+ * - `sophon-americano-10bit`
+ *
+ * **Adaptive dispatcher:**
+ * - `sophon-auto` — public opt-in profile. The worker classifies
+ *   the source and records the concrete `effective_profile_id` on
+ *   the job once dispatch resolves.
+ *
+ * @export
+ * @enum {string}
+ */
+export var JobProfile;
+(function (JobProfile) {
+    JobProfile["SOPHON_ESPRESSO"] = "sophon-espresso";
+    JobProfile["SOPHON_CORTADO"] = "sophon-cortado";
+    JobProfile["SOPHON_AMERICANO"] = "sophon-americano";
+    JobProfile["SOPHON_ESPRESSO_10BIT"] = "sophon-espresso-10bit";
+    JobProfile["SOPHON_CORTADO_10BIT"] = "sophon-cortado-10bit";
+    JobProfile["SOPHON_AMERICANO_10BIT"] = "sophon-americano-10bit";
+    JobProfile["SOPHON_AUTO"] = "sophon-auto";
+})(JobProfile || (JobProfile = {}));
+export function instanceOfJobProfile(value) {
+    for (const key in JobProfile) {
+        if (Object.prototype.hasOwnProperty.call(JobProfile, key)) {
+            if (JobProfile[key] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+export function JobProfileFromJSON(json) {
+    return JobProfileFromJSONTyped(json, false);
+}
+export function JobProfileFromJSONTyped(json, ignoreDiscriminator) {
+    return json;
+}
+export function JobProfileToJSON(value) {
+    return value;
+}
+export function JobProfileToJSONTyped(value, ignoreDiscriminator) {
+    return value;
+}

package/dist/esm/models/JobProgress.d.ts

@@ -0,0 +1,75 @@
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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 type { JobStatus } from './JobStatus';
+/**
+ *
+ * @export
+ * @interface JobProgress
+ */
+export interface JobProgress {
+    /**
+     * Current processing stage label (e.g. "probing", "encoding", "muxing").
+     * @type {string}
+     * @memberof JobProgress
+     */
+    stage?: string;
+    /**
+     * Canonical pipeline phase used for progress semantics.
+     * @type {JobStatus}
+     * @memberof JobProgress
+     */
+    phase: JobStatus;
+    /**
+     *
+     * @type {number}
+     * @memberof JobProgress
+     */
+    percent: number;
+    /**
+     * Progress within the current phase. Null before active processing.
+     * @type {number}
+     * @memberof JobProgress
+     */
+    phase_percent?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof JobProgress
+     */
+    fps?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof JobProgress
+     */
+    eta_seconds?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof JobProgress
+     */
+    frames_done?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof JobProgress
+     */
+    frames_total?: number;
+}
+/**
+ * Check if a given object implements the JobProgress interface.
+ */
+export declare function instanceOfJobProgress(value: object): value is JobProgress;
+export declare function JobProgressFromJSON(json: any): JobProgress;
+export declare function JobProgressFromJSONTyped(json: any, ignoreDiscriminator: boolean): JobProgress;
+export declare function JobProgressToJSON(json: any): JobProgress;
+export declare function JobProgressToJSONTyped(value?: JobProgress | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/JobProgress.js

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * SOPHON Encoding API
+ * REST API for submitting, monitoring, and retrieving SOPHON encoding jobs.  Authentication is via Bearer API key or session cookie. All POST endpoints require an Idempotency-Key header. List endpoints use opaque cursor-based pagination.
+ *
+ * The version of the OpenAPI document: 1.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 { JobStatusFromJSON, JobStatusToJSON, } from './JobStatus';
+/**
+ * Check if a given object implements the JobProgress interface.
+ */
+export function instanceOfJobProgress(value) {
+    if (!('phase' in value) || value['phase'] === undefined)
+        return false;
+    if (!('percent' in value) || value['percent'] === undefined)
+        return false;
+    return true;
+}
+export function JobProgressFromJSON(json) {
+    return JobProgressFromJSONTyped(json, false);
+}
+export function JobProgressFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'stage': json['stage'] == null ? undefined : json['stage'],
+        'phase': JobStatusFromJSON(json['phase']),
+        'percent': json['percent'],
+        'phase_percent': json['phase_percent'] == null ? undefined : json['phase_percent'],
+        'fps': json['fps'] == null ? undefined : json['fps'],
+        'eta_seconds': json['eta_seconds'] == null ? undefined : json['eta_seconds'],
+        'frames_done': json['frames_done'] == null ? undefined : json['frames_done'],
+        'frames_total': json['frames_total'] == null ? undefined : json['frames_total'],
+    };
+}
+export function JobProgressToJSON(json) {
+    return JobProgressToJSONTyped(json, false);
+}
+export function JobProgressToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'stage': value['stage'],
+        'phase': JobStatusToJSON(value['phase']),
+        'percent': value['percent'],
+        'phase_percent': value['phase_percent'],
+        'fps': value['fps'],
+        'eta_seconds': value['eta_seconds'],
+        'frames_done': value['frames_done'],
+        'frames_total': value['frames_total'],
+    };
+}