@liqhtworks/sophon-sdk 0.1.0

package/dist/esm/runtime.js

@@ -0,0 +1,348 @@
+/* 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 const BASE_PATH = "https://api.liqhtworks.xyz".replace(/\/+$/, "");
+export class Configuration {
+    configuration;
+    constructor(configuration = {}) {
+        this.configuration = configuration;
+    }
+    set config(configuration) {
+        this.configuration = configuration;
+    }
+    get basePath() {
+        return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
+    }
+    get fetchApi() {
+        return this.configuration.fetchApi;
+    }
+    get middleware() {
+        return this.configuration.middleware || [];
+    }
+    get queryParamsStringify() {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+    get username() {
+        return this.configuration.username;
+    }
+    get password() {
+        return this.configuration.password;
+    }
+    get apiKey() {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+    get accessToken() {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
+        }
+        return undefined;
+    }
+    get headers() {
+        return this.configuration.headers;
+    }
+    get credentials() {
+        return this.configuration.credentials;
+    }
+}
+export const DefaultConfig = new Configuration();
+/**
+ * This is the base class for all generated API classes.
+ */
+export class BaseAPI {
+    configuration;
+    static jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+    middleware;
+    constructor(configuration = DefaultConfig) {
+        this.configuration = configuration;
+        this.middleware = configuration.middleware;
+    }
+    withMiddleware(...middlewares) {
+        const next = this.clone();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+    withPreMiddleware(...preMiddlewares) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware(...middlewares);
+    }
+    withPostMiddleware(...postMiddlewares) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware(...middlewares);
+    }
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime) {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+    async request(context, initOverrides) {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+    async createFetchParams(context, initOverrides) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+        const initOverrideFn = typeof initOverrides === "function"
+            ? initOverrides
+            : async () => initOverrides;
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+        const overriddenInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context,
+            }))
+        };
+        let body;
+        if (isFormData(overriddenInit.body)
+            || (overriddenInit.body instanceof URLSearchParams)
+            || isBlob(overriddenInit.body)) {
+            body = overriddenInit.body;
+        }
+        else if (this.isJsonMime(headers['Content-Type'])) {
+            body = JSON.stringify(overriddenInit.body);
+        }
+        else {
+            body = overriddenInit.body;
+        }
+        const init = {
+            ...overriddenInit,
+            body
+        };
+        return { url, init };
+    }
+    fetchApi = async (url, init) => {
+        let fetchParams = { url, init };
+        for (const middleware of this.middleware) {
+            if (middleware.pre) {
+                fetchParams = await middleware.pre({
+                    fetch: this.fetchApi,
+                    ...fetchParams,
+                }) || fetchParams;
+            }
+        }
+        let response = undefined;
+        try {
+            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+        }
+        catch (e) {
+            for (const middleware of this.middleware) {
+                if (middleware.onError) {
+                    response = await middleware.onError({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        error: e,
+                        response: response ? response.clone() : undefined,
+                    }) || response;
+                }
+            }
+            if (response === undefined) {
+                if (e instanceof Error) {
+                    throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+                }
+                else {
+                    throw e;
+                }
+            }
+        }
+        for (const middleware of this.middleware) {
+            if (middleware.post) {
+                response = await middleware.post({
+                    fetch: this.fetchApi,
+                    url: fetchParams.url,
+                    init: fetchParams.init,
+                    response: response.clone(),
+                }) || response;
+            }
+        }
+        return response;
+    };
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    clone() {
+        const constructor = this.constructor;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+}
+;
+function isBlob(value) {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+function isFormData(value) {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+export class ResponseError extends Error {
+    response;
+    name = "ResponseError";
+    constructor(response, msg) {
+        super(msg);
+        this.response = response;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+export class FetchError extends Error {
+    cause;
+    name = "FetchError";
+    constructor(cause, msg) {
+        super(msg);
+        this.cause = cause;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+export class RequiredError extends Error {
+    field;
+    name = "RequiredError";
+    constructor(field, msg) {
+        super(msg);
+        this.field = field;
+        // restore prototype chain
+        const actualProto = new.target.prototype;
+        if (Object.setPrototypeOf) {
+            Object.setPrototypeOf(this, actualProto);
+        }
+    }
+}
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+export function querystring(params, prefix = '') {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+function querystringSingleKey(key, value, keyPrefix = '') {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+export function exists(json, key) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+export function mapValues(data, fn) {
+    const result = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+export function canConsumeForm(consumes) {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+export class JSONApiResponse {
+    raw;
+    transformer;
+    constructor(raw, transformer = (jsonValue) => jsonValue) {
+        this.raw = raw;
+        this.transformer = transformer;
+    }
+    async value() {
+        return this.transformer(await this.raw.json());
+    }
+}
+export class VoidApiResponse {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return undefined;
+    }
+}
+export class BlobApiResponse {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.blob();
+    }
+    ;
+}
+export class TextApiResponse {
+    raw;
+    constructor(raw) {
+        this.raw = raw;
+    }
+    async value() {
+        return await this.raw.text();
+    }
+    ;
+}

package/dist/helpers/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./uploads";
+export * from "./jobs";
+export * from "./webhooks";

package/dist/helpers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./uploads"), exports);
+__exportStar(require("./jobs"), exports);
+__exportStar(require("./webhooks"), exports);

package/dist/helpers/jobs.d.ts

@@ -0,0 +1,48 @@
+export type JobTerminalStatus = "completed" | "failed" | "canceled";
+export type JobStatusLike = JobTerminalStatus | "queued" | "probing" | "encoding" | "muxing" | "uploading_output";
+export interface JobLike {
+    id: string;
+    status: JobStatusLike;
+    error?: string | null;
+}
+export interface JobsApiLike {
+    getJob(params: {
+        id: string;
+    }): Promise<JobLike>;
+}
+export interface WaitForJobParams<T extends JobLike = JobLike> {
+    api: {
+        getJob: (p: {
+            id: string;
+        }) => Promise<T>;
+    };
+    jobId: string;
+    /** Resolve only on these statuses. Default: the three terminal ones. */
+    until?: readonly JobStatusLike[];
+    /** Initial poll interval (ms). Default 1000. */
+    pollMinMs?: number;
+    /** Cap on poll interval (ms). Default 15000. */
+    pollMaxMs?: number;
+    /** Exponential backoff multiplier per poll. Default 1.5. */
+    pollBackoff?: number;
+    /** Abort and throw after this many ms. Default 3600000 (1h). */
+    timeoutMs?: number;
+    /** Called on every poll with the freshly fetched job. */
+    onProgress?: (job: T) => void;
+    signal?: AbortSignal;
+}
+export declare class JobTerminalError<T extends JobLike = JobLike> extends Error {
+    readonly job: T;
+    constructor(job: T);
+}
+export declare class JobTimeoutError extends Error {
+    readonly jobId: string;
+    constructor(jobId: string, waitedMs: number);
+}
+/**
+ * Polls `getJob` until the job hits a terminal status (or the requested
+ * `until` list), then returns the final job. Throws `JobTerminalError` on
+ * `failed` / `canceled` unless those are explicitly requested in `until`.
+ * Throws `JobTimeoutError` if the timeout elapses.
+ */
+export declare function waitForJob<T extends JobLike = JobLike>(params: WaitForJobParams<T>): Promise<T>;

package/dist/helpers/jobs.js

@@ -0,0 +1,67 @@
+"use strict";
+// Polling helper that resolves when a job hits a terminal state.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JobTimeoutError = exports.JobTerminalError = void 0;
+exports.waitForJob = waitForJob;
+class JobTerminalError extends Error {
+    job;
+    constructor(job) {
+        super(job.error ?? `job ${job.id} ended in status ${job.status}`);
+        this.name = "JobTerminalError";
+        this.job = job;
+    }
+}
+exports.JobTerminalError = JobTerminalError;
+class JobTimeoutError extends Error {
+    jobId;
+    constructor(jobId, waitedMs) {
+        super(`job ${jobId} did not finish within ${waitedMs}ms`);
+        this.name = "JobTimeoutError";
+        this.jobId = jobId;
+    }
+}
+exports.JobTimeoutError = JobTimeoutError;
+const DEFAULT_TERMINAL = ["completed", "failed", "canceled"];
+/**
+ * Polls `getJob` until the job hits a terminal status (or the requested
+ * `until` list), then returns the final job. Throws `JobTerminalError` on
+ * `failed` / `canceled` unless those are explicitly requested in `until`.
+ * Throws `JobTimeoutError` if the timeout elapses.
+ */
+async function waitForJob(params) {
+    const { api, jobId, until = DEFAULT_TERMINAL, pollMinMs = 1000, pollMaxMs = 15000, pollBackoff = 1.5, timeoutMs = 60 * 60 * 1000, onProgress, signal, } = params;
+    const start = Date.now();
+    let interval = pollMinMs;
+    while (true) {
+        if (signal?.aborted)
+            throw new DOMException("Aborted", "AbortError");
+        if (Date.now() - start > timeoutMs)
+            throw new JobTimeoutError(jobId, Date.now() - start);
+        const job = await api.getJob({ id: jobId });
+        onProgress?.(job);
+        if (until.some((s) => s === job.status)) {
+            // The caller opted into this status; only synthesize a JobTerminalError
+            // when they are waiting for the default-terminal set and we landed on a
+            // failed/canceled status.
+            if (until === DEFAULT_TERMINAL && (job.status === "failed" || job.status === "canceled")) {
+                throw new JobTerminalError(job);
+            }
+            return job;
+        }
+        await sleep(interval, signal);
+        interval = Math.min(Math.ceil(interval * pollBackoff), pollMaxMs);
+    }
+}
+function sleep(ms, signal) {
+    return new Promise((resolve, reject) => {
+        const t = setTimeout(() => {
+            signal?.removeEventListener("abort", onAbort);
+            resolve();
+        }, ms);
+        const onAbort = () => {
+            clearTimeout(t);
+            reject(new DOMException("Aborted", "AbortError"));
+        };
+        signal?.addEventListener("abort", onAbort, { once: true });
+    });
+}

package/dist/helpers/uploads.d.ts

@@ -0,0 +1,71 @@
+export interface UploadsApiLike {
+    createUpload(params: {
+        createUploadRequest: {
+            file_name: string;
+            file_size: number;
+            mime_type: string;
+        };
+        idempotencyKey: string;
+    }): Promise<{
+        id: string;
+        chunk_size: number;
+        total_chunks: number;
+        expires_at: string;
+    }>;
+    uploadPart(params: {
+        id: string;
+        partNumber: number;
+        body: Blob;
+    }): Promise<{
+        part_number: number;
+        received: boolean;
+    }>;
+    completeUpload(params: {
+        id: string;
+        idempotencyKey: string;
+    }): Promise<{
+        id: string;
+        status: string;
+        sha256: string;
+        bytes: number;
+    }>;
+    getUpload(params: {
+        id: string;
+    }): Promise<{
+        id: string;
+        status: string;
+        total_chunks: number;
+        received_chunks: number[];
+    }>;
+}
+export interface UploadProgress {
+    bytesUploaded: number;
+    bytesTotal: number;
+    partsDone: number;
+    partsTotal: number;
+}
+export interface UploadFileParams {
+    api: UploadsApiLike;
+    source: Blob;
+    fileName: string;
+    mimeType: string;
+    /** Resume a prior session instead of creating a new one. */
+    uploadId?: string;
+    /** Parallel in-flight chunks. Default 4. */
+    concurrency?: number;
+    /** Retries per chunk before aborting. Default 3. */
+    retries?: number;
+    /** Base backoff in ms; doubles each attempt. Default 500. */
+    retryBaseMs?: number;
+    /** Idempotency key reused for createUpload + completeUpload. Auto-generated if omitted. */
+    idempotencyKey?: string;
+    onProgress?: (p: UploadProgress) => void;
+    /** Abort the whole upload. Chunks in flight will still settle. */
+    signal?: AbortSignal;
+}
+export interface UploadFileResult {
+    uploadId: string;
+    sha256: string;
+    bytes: number;
+}
+export declare function uploadFile(params: UploadFileParams): Promise<UploadFileResult>;