@giveitsmaller/sdk 0.8.0 → 0.10.0

package/dist/file-first.d.ts

@@ -11,9 +11,12 @@
  */
 import { type ProgressEvent } from './builder.js';
 import type { GislClient } from './client.js';
+import type { OperationDownload, WorkflowStatusResponse } from '@giveitsmaller/contracts/openapi';
 import { OptimizeFor } from './generated/sdk_spec/enums.js';
 import type { PresetDefaults } from './ergonomic/presets/index.js';
 import type { WorkflowCreatePayload } from './types.js';
+import type { MergeOptions } from './merge.js';
+import { Handle } from './handle.js';
 /**
  * Streams a single output URL to a local path. The seam between the
  * file-first {@link RunResult} sinks and the SDK's HTTP/auth layer.
@@ -160,6 +163,92 @@ export declare class RunResult {
     };
     private requireDownloader;
 }
+/**
+ * Flatten the terminal workflow status + its downloads into a {@link RunResult}.
+ *
+ * Shared by {@link Recipe.run} (passes its recipe key) and the file-first
+ * {@link Handle} reattach surface (`Handle.wait()`/`Handle.result()`, FF5a —
+ * passes `null` because a reattached handle carries no recipe key).
+ *
+ * **Partition invariant (carries a prior codex-review fix — do NOT let it
+ * drift):** success is ONLY `state === 'completed'`. Every other terminal
+ * state — `failed`, `partially_failed`, `cancelled`, `expired`,
+ * `paused_insufficient_credits` — partitions into `failed[]` so a caller's
+ * `ok`/`succeeded` check can never treat a cancelled/expired/paused run as a
+ * clean result.
+ *
+ * @internal Exported for reuse by the file-first `Handle`; not part of the
+ *   caller-facing fluent surface.
+ */
+export declare function projectDownloadsToRunResult(workflowId: string, finalStatus: WorkflowStatusResponse, jobDownloads: readonly {
+    files: readonly OperationDownload[];
+}[], key: string | null, downloader?: Downloader): RunResult;
+/**
+ * Flatten a terminal multi-job workflow (the `client.files([...])` fan-out)
+ * into a partitioned {@link RunResult}. One job per input file, keyed by the
+ * `file-{i}` job ref the {@link FilesRecipe} lowering assigns; the result's
+ * `succeeded` / `failed` partition is PER JOB, so one bad input does not sink
+ * the rest.
+ *
+ * Join model: `finalStatus.jobs[]` carries the per-job {@link JobStatus} +
+ * `operations[]` (for the error message); `jobDownloads[]` carries the per-job
+ * output files. Both are joined on the job `ref` ("file-{i}"); the partition
+ * key is the index `"{i}"` parsed out of that ref. The flat `artifacts[]` is
+ * every job's outputs in job order (the order `finalStatus.jobs[]` lists them).
+ *
+ * **Partition invariant (mirrors {@link projectDownloadsToRunResult} PER JOB —
+ * do NOT let it drift):** a job is a SUCCESS only when its
+ * {@link JobResponse.status} `=== 'completed'`. Any other per-job status —
+ * `failed`, `pending`, `waiting`, `blocked_insufficient_credits`,
+ * `in_progress` — partitions that job into `failed[]` (with that job's first
+ * operation error message, scoped to THAT job only).
+ *
+ * @internal Exported for the file-first `client.files([...]).run()` producer;
+ *   not part of the caller-facing fluent surface.
+ */
+export declare function projectMultiJobToRunResult(workflowId: string, finalStatus: WorkflowStatusResponse, jobDownloads: readonly {
+    ref: string;
+    files: readonly OperationDownload[];
+}[], keyByRef: ReadonlyMap<string, string | null>, downloader?: Downloader): RunResult;
+/**
+ * True when a terminal status describes a homogeneous `files([...])` fan-out —
+ * i.e. it has at least one job and EVERY job ref is `file-{i}` (the ids the
+ * {@link FilesRecipe} lowering assigns). A single-file {@link Recipe} omits the
+ * job id, so its job carries a non-`file-N` ref (e.g. `op`) and this is false.
+ *
+ * This is the data-driven seam that lets {@link Handle.wait}/{@link Handle.result}
+ * pick the per-job producer ({@link projectMultiJobToRunResult}) over the
+ * single-output one for a fan-out — WITHOUT a construction-time marker, so a
+ * fan-out **reattached** via `client.workflow(id)` (which carries no marker)
+ * still partitions per job. Keys are recovered from the `file-{i}` refs.
+ *
+ * @internal Exported for the file-first `Handle`; not part of the public API.
+ */
+export declare function isFanoutStatus(finalStatus: WorkflowStatusResponse): boolean;
+/**
+ * True when a terminal status describes a fluent `files([...]).merge(...)`
+ * combine — at least one job ref `merge` and every OTHER job ref is `src_{i}`
+ * (the ids the {@link MergedRecipe} lowering assigns). The data-driven seam that
+ * lets {@link Handle.wait}/{@link Handle.result} project ONLY the merged output
+ * — filtering the `src_*` passthrough plumbing — even after a
+ * `client.workflow(id)` reattach (no construction-time marker), matching
+ * {@link MergedRecipe.run}'s `ref === 'merge'` filter. Mutually exclusive with
+ * {@link isFanoutStatus} (a fan-out's refs are all `file-{i}`).
+ *
+ * @internal Exported for the file-first `Handle`; not part of the public API.
+ */
+export declare function isMergeStatus(finalStatus: WorkflowStatusResponse): boolean;
+/**
+ * True when a terminal status describes a fluent `files([...]).archive(...)`
+ * bundle — at least one job ref `archive` and every OTHER job ref is `src_{i}`
+ * (the ids the {@link ArchivedRecipe} lowering assigns). Lets
+ * {@link Handle.wait}/{@link Handle.result} project ONLY the archive output —
+ * filtering the `src_*` passthrough plumbing — even after a `client.workflow(id)`
+ * reattach. Mutually exclusive with {@link isFanoutStatus} / {@link isMergeStatus}.
+ *
+ * @internal Exported for the file-first `Handle`; not part of the public API.
+ */
+export declare function isArchiveStatus(finalStatus: WorkflowStatusResponse): boolean;
 /**
  * The primary file a {@link Recipe} operates on — the "subject" of the
  * file-first surface. A discriminated union over the ways a caller names an
@@ -187,6 +276,19 @@ export type FileInput = {
 export declare const fileInput: {
     readonly path: (path: string) => FileInput;
     readonly blob: (blob: Blob) => FileInput;
+    /**
+     * Reference an already-uploaded file by its upload id, instead of
+     * re-uploading bytes.
+     *
+     * Auth-ownership: an upload created by an **authenticated** caller is owned
+     * by that caller. If you reuse the id from a client configured with a
+     * *different* auth context (a different `apiKey` / session), workflow-create
+     * returns `404 upload_not_found` — the server enforces ownership (api
+     * PqpD9ySv). Reference an upload id only under the SAME auth that created it.
+     * The normal upload-then-create-in-one-client flow is consistent by
+     * construction (the same `Authorization` rides every request). Ownerless
+     * (anonymous-intake) uploads are unaffected.
+     */
     readonly uploadId: (fileId: string) => FileInput;
 };
 /** One step in a {@link Recipe}'s chain — an op kind + captured ergonomic args. */
@@ -250,15 +352,25 @@ export declare class Recipe {
      * `operations[]`; the job `id` is omitted (a single job referenced by
      * nothing — the server auto-assigns `job_N`).
      *
-     * @internal Consumed by FF2b's `run()` (after a real upload) and by the
-     *   cross-language parity harness (with a fixed id). Not part of the
-     *   caller-facing fluent surface.
+     * When `callbackUrl` is given (the file-first `submit()` path), it is built
+     * INTO the payload at construction (`callback_url`) rather than spread onto an
+     * already-built readonly payload. `run()` passes no `callbackUrl`.
+     *
+     * @internal Consumed by FF2b's `run()` (after a real upload), FF5b's
+     *   `submit()` (with a webhook), and the cross-language parity harness (with a
+     *   fixed id). Not part of the caller-facing fluent surface.
      */
-    toWorkflowPayload(fileId: string): WorkflowCreatePayload;
+    toWorkflowPayload(fileId: string, callbackUrl?: string): WorkflowCreatePayload;
     /** The result-addressing key passed to `file()`, or undefined. */
     key(): string | undefined;
     /** The number of operations chained so far (introspection / tests). */
     get stepCount(): number;
+    /**
+     * The captured op chain. Read by {@link FilesRecipe} to compose a shared
+     * chain across many inputs without duplicating the chain-method validation.
+     * @internal
+     */
+    get recipeSteps(): readonly RecipeStep[];
     /**
      * Execute the recipe end-to-end: upload the input (when required), create
      * the workflow, await a terminal state (SSE with poll fallback), then
@@ -276,9 +388,349 @@ export declare class Recipe {
         signal?: AbortSignal;
         pollIntervalMs?: number;
     }): Promise<RunResult>;
+    /**
+     * Fire-and-forget the recipe: upload the input (when required), create the
+     * workflow (wiring `webhook` into `callback_url` when given), and return a
+     * client-bound {@link Handle} carrying the workflow id + webhook secret + the
+     * recipe key. Does NOT wait for terminal status — call `handle.wait()` /
+     * `handle.result()` later to collect the {@link RunResult}.
+     *
+     * Requires a client bound at construction time (same `no_client` guard as
+     * {@link run}). `webhook` is OPTIONAL: when omitted, no `callback_url` is
+     * sent. Mirrors the PHP `Recipe.submit()`.
+     *
+     * @param webhook Absolute callback URL the server POSTs lifecycle events to.
+     */
+    submit(webhook?: string): Promise<Handle>;
+    /**
+     * Resolve the upload id (verbatim for a pre-uploaded id; uploading a path /
+     * blob otherwise, emitting `{phase:'upload'}` progress), check the post-upload
+     * deadline, lower to the workflow-create payload (wiring `webhook` into
+     * `callback_url`), and create the workflow. Shared first half of
+     * {@link run} + {@link submit}.
+     *
+     * The post-upload deadline check carries a prior codex fix (9a117f04eb59): a
+     * slow upload must not proceed to createWorkflow past the deadline.
+     */
+    private _uploadAndCreate;
     private withStep;
     private lowerStep;
     private lowerCompressOptions;
     private compressMediaHint;
 }
+/**
+ * The homogeneous fan-out builder value (FF3a). `client.files([a, b, c])`
+ * returns a `FilesRecipe`; the op-chain methods (`compress`, `convert`,
+ * `thumbnail`, `textWatermark`) build ONE shared recipe (chain) that is applied
+ * to EVERY input file in ONE workflow. `run()` returns a partitioned
+ * {@link RunResult} — one `succeeded`/`failed` entry per input, keyed by its
+ * 0-based index ("0", "1", …) so one bad input does not sink the rest.
+ *
+ * **Immutable / clone-on-write**, exactly like {@link Recipe}: every op returns
+ * a NEW `FilesRecipe` carrying the appended step. The inputs are held as an
+ * ORDERED list (NOT a map) so the per-file index is the partition key.
+ *
+ * **Lowering composes {@link Recipe} per file** rather than duplicating
+ * `lowerStep`/`lowerCompressOptions`: for each input `i` it builds an internal
+ * single-file `Recipe(input_i, …, steps)`, calls its `toWorkflowPayload` to get
+ * that file's one-job payload, then merges all jobs into ONE
+ * {@link WorkflowCreatePayload} with `jobs[i].id = "file-{i}"`. This preserves
+ * each file's media-hint (different extensions per input resolve compress
+ * presets independently).
+ *
+ * Exposes both `run()` (blocking, returns a partitioned {@link RunResult}) and
+ * `submit(webhook?)` (fire-and-forget, returns a {@link Handle}). Mirrors the
+ * PHP `FilesRecipe`.
+ */
+export declare class FilesRecipe {
+    private readonly inputs;
+    private readonly steps;
+    private readonly presetDefaults?;
+    private readonly scopedPresetDefaults?;
+    private readonly client?;
+    constructor(inputs: readonly FileInput[], steps?: readonly RecipeStep[], presetDefaults?: PresetDefaults | undefined, scopedPresetDefaults?: PresetDefaults | undefined, client?: GislClient | undefined);
+    /**
+     * Reduce file size on every input. `optimize` selects a per-media preset
+     * (resolved per file at lower-time, so each input's extension picks its own
+     * preset). Reuses {@link Recipe}'s validation — a directly-constructed
+     * lowering builds an internal Recipe that throws the same `GislConfigError`.
+     */
+    compress(optimize?: OptimizeFor): FilesRecipe;
+    /** Change every input's format. `format` lowers verbatim to the `format` option. */
+    convert(format: string): FilesRecipe;
+    /** Generate a preview of every input. Omitted dimensions are dropped from the wire options. */
+    thumbnail(options?: {
+        width?: number;
+        height?: number;
+    }): FilesRecipe;
+    /** Apply the same text watermark to every input. */
+    textWatermark(text: string): FilesRecipe;
+    /**
+     * Combine the inputs into ONE output (N→1), in array order (FF3b). Returns a
+     * single-output {@link MergedRecipe} you chain further ops on
+     * (`files([...]).merge().compress()`). Reuses the operation-first
+     * {@link MergeOptions} for the merge-level options, so the wire shape matches
+     * `client.merge([...], options)`.
+     *
+     * `merge()` must be the FIRST op on `files([...])` — per-file ops before a
+     * combine (compress-each-then-merge) are a separate follow-up, rejected here
+     * with `GislConfigError` reason `pre_merge_ops_unsupported`.
+     */
+    merge(options?: MergeOptions): MergedRecipe;
+    /**
+     * Bundle the inputs into ONE archive (N→1, zip / tar.gz) — media-agnostic,
+     * inputs may mix types. Returns a terminal {@link ArchivedRecipe} (a zip is
+     * the final artefact — no post-bundle chain). `format` / `folderStructure` are
+     * optional; the server defaults to zip + flat.
+     *
+     * `archive()` must be the FIRST op on `files([...])` → `GislConfigError` reason
+     * `pre_archive_ops_unsupported` otherwise.
+     */
+    archive(options?: ArchiveRecipeOptions): ArchivedRecipe;
+    /** The number of inputs in this fan-out (introspection / tests). */
+    get inputCount(): number;
+    /** The number of operations chained so far (introspection / tests). */
+    get stepCount(): number;
+    /**
+     * Lower this fan-out to a single multi-job workflow-create payload against a
+     * list of resolved upload ids (one per input, in input order). Each input `i`
+     * becomes ONE job with `id = "file-{i}"`, its `source: upload(fileIds[i])`,
+     * and the SHARED lowered `operations[]`. Composes the single-file
+     * {@link Recipe.toWorkflowPayload} per file so per-file media-hints resolve
+     * independently and lowering logic is not duplicated.
+     *
+     * @internal Consumed by {@link run} (after uploading all inputs) and the
+     *   cross-language parity harness (with fixed ids). Not caller-facing.
+     */
+    toWorkflowPayload(fileIds: readonly string[], callbackUrl?: string): WorkflowCreatePayload;
+    /**
+     * Execute the fan-out end-to-end: upload EVERY input, create ONE workflow
+     * with one job per input, await a terminal state (SSE with poll fallback),
+     * then resolve the per-job downloads into a partitioned {@link RunResult}.
+     * `partially_failed` is a NORMAL terminal state here — its successful jobs
+     * land in `succeeded`, its failed jobs in `failed`.
+     *
+     * Requires a client bound at construction time — `gisl().files(...)` wires
+     * it; a directly-constructed `FilesRecipe` throws {@link GislConfigError}.
+     * Mirrors the single-file {@link Recipe.run}; see {@link submit} for the
+     * fire-and-forget arm.
+     */
+    run(options?: {
+        maxWait?: string | number;
+        onProgress?: (event: ProgressEvent) => void;
+        signal?: AbortSignal;
+        pollIntervalMs?: number;
+    }): Promise<RunResult>;
+    /**
+     * Fire-and-forget the fan-out: upload every input, create ONE multi-job
+     * workflow (wiring `webhook` into `callback_url` when given), and return a
+     * client-bound {@link Handle}. Does NOT wait for terminal status — call
+     * `handle.wait()` / `handle.result()` later to collect the partitioned
+     * {@link RunResult}. The Handle detects the fan-out from the wire `file-{i}`
+     * job refs, so per-file `byKey()` works even after a `client.workflow(id)`
+     * reattach (the keys are the input indices `"0"`, `"1"`, …).
+     *
+     * Requires a client bound at construction time (same `no_client` guard as
+     * {@link run}). `webhook` is OPTIONAL. Fire-and-forget, so NO whole-run
+     * deadline (a multi-GB upload is bounded by the HTTP client's own timeout).
+     * Mirrors the single-file {@link Recipe.submit}.
+     *
+     * @param webhook Absolute callback URL the server POSTs lifecycle events to.
+     */
+    submit(webhook?: string): Promise<Handle>;
+    /**
+     * Upload every input (verbatim for a pre-uploaded id; uploading a path /
+     * blob otherwise, emitting `{phase:'upload'}` progress) then create ONE
+     * multi-job workflow (one job per input, `callback_url` built in when
+     * `webhook` is given). Shared first half of {@link run} + {@link submit}.
+     *
+     * Uploads are sequential so progress events stay ordered and the abort
+     * signal is honoured promptly; a resource arm is impossible in TS (Blob).
+     * `run()` passes a whole-run deadline (a slow upload must not proceed to
+     * createWorkflow past maxWait); `submit()` passes `undefined`, so the
+     * deadline checks are skipped.
+     */
+    private _uploadAllAndCreate;
+    /**
+     * The shared single-file {@link Recipe} that captures the op chain (input is
+     * a placeholder — only the steps are read). Reuses Recipe's op-chain
+     * validation + coercion so a `FilesRecipe.compress(bad)` throws the identical
+     * `GislConfigError` as `Recipe.compress(bad)`.
+     */
+    private baseRecipe;
+    private withStep;
+}
+/**
+ * The single-output recipe you're in AFTER a fluent `files([...]).merge(...)`
+ * (FF3b). Merge collapses the N inputs into ONE output, so the per-file ops
+ * ({@link FilesRecipe.compress} etc.) no longer apply — instead this exposes the
+ * SAME chain ops as the single-file {@link Recipe}, applied to the merged
+ * result. `files([...]).merge().compress()` is the flagship case (example 14).
+ *
+ * **Lowering (one workflow):** each input is uploaded once and wrapped in its
+ * own single-input `passthrough` source job (`src_N`); the `merge` job consumes
+ * those via `job_output` inputs (array order = play order) and carries the merge
+ * op FIRST in its `operations[]`, followed by any post-combine ops (compress /
+ * convert / thumbnail) so they run on the merged output in the same job. The
+ * merge-level wire options reuse {@link wireMergeOptions} so a fluent merge
+ * lowers identically to the operation-first `client.merge()`.
+ *
+ * Immutable / clone-on-write like {@link Recipe} / {@link FilesRecipe}. Mirrors
+ * the PHP `MergedRecipe` in `packages/php/src/FileFirst/MergedRecipe.php`.
+ */
+export declare class MergedRecipe {
+    private readonly inputs;
+    private readonly mergeOptions;
+    private readonly postSteps;
+    private readonly presetDefaults?;
+    private readonly scopedPresetDefaults?;
+    private readonly client?;
+    constructor(inputs: readonly FileInput[], mergeOptions: MergeOptions, postSteps?: readonly RecipeStep[], presetDefaults?: PresetDefaults | undefined, scopedPresetDefaults?: PresetDefaults | undefined, client?: GislClient | undefined);
+    /** Reduce the merged output's size. See {@link Recipe.compress}. */
+    compress(optimize?: OptimizeFor): MergedRecipe;
+    /** Change the merged output's format. See {@link Recipe.convert}. */
+    convert(format: string): MergedRecipe;
+    /** Thumbnail the merged output. Omitted dimensions are dropped from the wire options. */
+    thumbnail(options?: {
+        width?: number;
+        height?: number;
+    }): MergedRecipe;
+    /**
+     * Lower to the merge DAG: one `passthrough` source job per input + one
+     * `merge` job whose `operations[]` is `[merge, ...post-combine ops]`. The
+     * merge job's `inputs[]` consume the source jobs via `job_output` in input
+     * (play) order.
+     *
+     * @internal Consumed by {@link run} (after uploading all inputs), {@link submit}
+     *   (with a webhook), and the cross-language parity harness (with fixed ids).
+     */
+    toWorkflowPayload(fileIds: readonly string[], callbackUrl?: string): WorkflowCreatePayload;
+    /** The number of inputs being combined (introspection / tests). */
+    get inputCount(): number;
+    /** The number of post-combine ops chained so far (introspection / tests). */
+    get stepCount(): number;
+    /**
+     * Execute end-to-end: upload every input, create the merge workflow, await a
+     * terminal state (SSE with poll fallback), then resolve ONLY the merged output
+     * into a {@link RunResult}. Throws {@link GislTimeoutError} on `maxWait`.
+     *
+     * Requires a client bound at construction time — `gisl().files(...).merge(...)`
+     * wires it; a directly-constructed `MergedRecipe` throws {@link GislConfigError}.
+     * Mirrors the single-file {@link Recipe.run}.
+     */
+    run(options?: {
+        maxWait?: string | number;
+        onProgress?: (event: ProgressEvent) => void;
+        signal?: AbortSignal;
+        pollIntervalMs?: number;
+    }): Promise<RunResult>;
+    /**
+     * Fire-and-forget: upload + create the merge workflow (wiring `webhook` into
+     * `callback_url` when given), return a client-bound {@link Handle}. Does NOT
+     * wait for terminal status. Mirrors {@link Recipe.submit}.
+     */
+    submit(webhook?: string): Promise<Handle>;
+    /**
+     * Upload every input (verbatim for a pre-uploaded id; uploading a path / blob
+     * otherwise, emitting `{phase:'upload'}` progress) then create ONE merge
+     * workflow. Rejects fewer than 2 inputs BEFORE any upload fires. Shared first
+     * half of {@link run} + {@link submit}.
+     */
+    private _uploadAllAndCreate;
+    /**
+     * Reject an invalid combine BEFORE any upload fires — mirrors the operation-
+     * first `MergeBuilder.planSequence()` bounds so a typo'd merge costs no
+     * bandwidth: 2–10 inputs (merge schema `min/max_inputs`), and an image merge
+     * must carry an explicit `output_type` (the server rejects image merges
+     * without one). Shared by {@link run} + {@link submit} via
+     * {@link _uploadAllAndCreate}.
+     */
+    private validatePreUpload;
+    /**
+     * Lower the post-combine chain by composing a single-file {@link Recipe} over a
+     * synthetic input whose extension matches the merged OUTPUT media — so
+     * `compress(optimize)` resolves the correct preset for the merged result (it
+     * needs a media hint, which a merge output carries no filename for). Reuses
+     * Recipe's `lowerStep` rather than duplicating it.
+     */
+    private lowerPostSteps;
+    /**
+     * The merged-output media. Honours an explicit {@link MergeOptions.mediaKind};
+     * otherwise infers from the first PATH input's extension (mirrors
+     * {@link MergeBuilder}); defaults to video.
+     */
+    private inferMediaKind;
+    private outputExtensionFor;
+    private withStep;
+}
+/**
+ * Options for a fluent `files([...]).archive(...)` bundle. Both fields are
+ * optional — the server defaults `format` to `zip` and `folderStructure` to
+ * `flat` (archive op schema). Mirrors the PHP `ArchivedRecipe` ctor params.
+ */
+export interface ArchiveRecipeOptions {
+    /** Archive container format. */
+    readonly format?: 'zip' | 'tar.gz';
+    /** `flat` = all files at the top level; `by_job` = a subfolder per source. */
+    readonly folderStructure?: 'flat' | 'by_job';
+}
+/**
+ * The single-output recipe you're in AFTER a fluent `files([...]).archive(...)`
+ * (FF3b). Archive bundles the N inputs into ONE downloadable archive (zip /
+ * tar.gz) — media-agnostic, inputs may mix types. Unlike {@link MergedRecipe},
+ * archive is TERMINAL: a zip is the final artefact, so there is no post-bundle
+ * chain — this exposes only `run()` / `submit()`.
+ *
+ * **Lowering (one workflow):** each input is uploaded once and wrapped in its
+ * own single-input `passthrough` source job (`src_N`); the `archive` job
+ * consumes those via `job_output` inputs (array order = entry order) and carries
+ * the single `archive` op. The archive job's id is `archive`, so {@link RunResult}
+ * projects ONLY its output. Mirrors the PHP `ArchivedRecipe`.
+ */
+export declare class ArchivedRecipe {
+    private readonly inputs;
+    private readonly options;
+    private readonly client?;
+    constructor(inputs: readonly FileInput[], options?: ArchiveRecipeOptions, client?: GislClient | undefined);
+    /** The number of inputs being bundled (introspection / tests). */
+    get inputCount(): number;
+    /**
+     * Lower to the archive DAG: one `passthrough` source job per input + one
+     * `archive` job consuming them via `job_output`.
+     *
+     * @internal Consumed by {@link run} / {@link submit} (after uploading) and the
+     *   cross-language parity harness (with fixed ids).
+     */
+    toWorkflowPayload(fileIds: readonly string[], callbackUrl?: string): WorkflowCreatePayload;
+    /**
+     * Execute end-to-end: upload every input, create the archive workflow, await a
+     * terminal state (SSE with poll fallback), then resolve ONLY the archive output
+     * into a {@link RunResult}. Throws {@link GislTimeoutError} on `maxWait`.
+     * Requires a client bound via `gisl().files(...).archive(...)`.
+     */
+    run(options?: {
+        maxWait?: string | number;
+        onProgress?: (event: ProgressEvent) => void;
+        signal?: AbortSignal;
+        pollIntervalMs?: number;
+    }): Promise<RunResult>;
+    /**
+     * Fire-and-forget: upload + create the archive workflow (wiring `webhook` into
+     * `callback_url` when given), return a client-bound {@link Handle}. Mirrors
+     * {@link MergedRecipe.submit}.
+     */
+    submit(webhook?: string): Promise<Handle>;
+    private _uploadAllAndCreate;
+    /**
+     * Reject an invalid bundle BEFORE any upload fires — the archive schema allows
+     * 2–50 inputs (`min/max_inputs`), so a typo'd bundle costs no bandwidth.
+     */
+    private validatePreUpload;
+    /**
+     * Project the archive options into the wire shape. Both fields are optional
+     * (the server defaults `format` to zip and `folder_structure` to flat), so an
+     * omitted option is dropped rather than sent.
+     */
+    private wireArchiveOptions;
+}
 export {};