@giveitsmaller/sdk 0.4.0 → 0.6.0

package/dist/_audit.js

@@ -54,4 +54,11 @@ export function _runAudit() {
     accept();
     accept();
     accept();
+    // SDK-3 (Wb6ebOMM) public-API surface for the 3 resume-support endpoints.
+    accept();
+    accept();
+    accept();
+    accept();
+    accept();
+    accept();
 }

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import type { AudioWatermarkDecodeRequest, AudioWatermarkDecodeResponse, ExternalImportCreatedResponse, ExternalImportRequest, LoginUserRequest, LoginUser200ResponseData, ContactRequest, CreditsBalanceResponse, CreditsUsageResponse, UploadResponse, UploadProbeResponse, WorkflowCancelResponse, WorkflowCreateResponse, WorkflowResumeResponse, WorkflowStatusResponse, WorkflowDownloadResponse, MetadataResponse, RetryResponse } from '@giveitsmaller/contracts/openapi';
-import type { CreditsUsageOptions, GetSchemaOptions, GetSchemaResult, GislClientConfig, GislSseEvent, PreflightClipsResult, UploadOptions, WaitOptions, WorkflowCreatePayload } from './types.js';
+import type { CreditsUsageOptions, GetSchemaOptions, GetSchemaResult, GislClientConfig, GislSseEvent, PreflightClipsResult, UploadOptions, WaitOptions, WorkflowCreatePayload, _Sdk3HandCodedKeepaliveResult, _Sdk3HandCodedMultipartStatusResult, _Sdk3HandCodedPresignPartsResult } from './types.js';
 export declare const MULTIPART_CONCURRENCY_DEFAULT: 4;
 export declare const DEFAULT_MULTIPART_FIRST_CHUNK_SIZE: number;
 export interface ValidationDetail {
@@ -45,6 +45,88 @@ export declare class GislClient {
      * post-upload metadata callers should use getMetadata(fileId).
      */
     private multipartUpload;
+    /**
+     * SDK-3 (Wb6ebOMM): resume an in-progress multipart upload.
+     *
+     * Skips `/multipart/initiate` entirely (the original initiate happened in a
+     * prior process). Walks `/status` for the authoritative list of recorded
+     * parts, re-presigns the missing ones in batches of <=100, PUTs only those,
+     * and finalises with `/complete`. Caller's `source` MUST be byte-identical
+     * to the originally-uploaded file at the same offsets (parts whose etags
+     * don't match server state will fail `/complete`).
+     *
+     * Re-runs the same `uploadId` / `chunkSize` / `totalParts` / plan-consistency
+     * guards as the fresh-upload path (`multipartUpload`), using the /status
+     * envelope as the equivalent of the initiate envelope. Reuses the same
+     * `failureController` sibling-wake + `drainResponseBody` cleanup discipline
+     * as the fresh-upload PUT loop. `onProgress` fires on entry seeded from
+     * (uploadedPartNumbers.length * chunkSize) and again after every successful
+     * PUT. `onCheckpoint` fires OUTSIDE the retry-scoped path after every
+     * successful PUT — a callback-throw must not trigger a duplicate PUT.
+     *
+     * TODO(HxUmVr3Y): replace inline hand-coded request body marshalling on regen.
+     */
+    private multipartResume;
+    /**
+     * Fetch the durable status of an in-progress multipart upload session.
+     *
+     * Walks every page of `GET /api/uploads/multipart/{uploadId}/status`
+     * (paginated via `next_part_number_marker` + `is_truncated`) and returns
+     * the aggregated state. Callers see the complete set of recorded parts
+     * across pages without driving the cursor themselves.
+     *
+     * Anonymous-initiated sessions return 403 → `GislMultipartSessionAuthRequiredError`.
+     * Non-existent / expired sessions return 404 → `GislMultipartSessionNotFoundError`.
+     * Authed-but-non-owning callers return 403 → `GislMultipartSessionOwnershipError`.
+     *
+     * TODO(HxUmVr3Y): replace hand-coded response shape on regen.
+     */
+    getUploadStatus(uploadId: string, opts?: {
+        signal?: AbortSignal;
+    }): Promise<_Sdk3HandCodedMultipartStatusResult>;
+    /**
+     * Re-presign a batch of missing part numbers on an in-progress multipart
+     * session.
+     *
+     * Validates client-side BEFORE the HTTP round-trip:
+     * - `partNumbers` non-empty
+     * - length <=100 (server raw-body cap is 8 KiB before json_decode)
+     * - every entry an integer in `[2, totalParts]` — part 1 is sealed at
+     *   initiate (re-presigning it would break the etag recorded server-side
+     *   for /complete)
+     * - entries unique
+     * - `totalParts` <=10 000 (S3 hard limit; mirrors the SDK-1 ceiling guard)
+     *
+     * TODO(HxUmVr3Y): replace hand-coded request/response shapes on regen.
+     */
+    presignParts(uploadId: string, partNumbers: readonly number[], totalParts: number, opts?: {
+        signal?: AbortSignal;
+    }): Promise<_Sdk3HandCodedPresignPartsResult>;
+    /**
+     * Extend the manifest TTL of an in-progress multipart upload session.
+     *
+     * The durable session manifest defaults to a 48 h TTL (decoupled from the
+     * shorter presigned-URL TTL). For a long-running resume that spans days
+     * (e.g. an upload paused overnight on flaky Wi-Fi), callers SHOULD invoke
+     * `keepaliveUpload` every **12-24 h** while resuming — the 12-24 h band
+     * leaves >=24 h of slack against the 48 h ceiling even with worst-case
+     * clock skew between client and server. The server atomically refreshes
+     * the Redis EXPIRE for the manifest key; the call is idempotent.
+     *
+     * TODO(HxUmVr3Y): replace hand-coded response shape on regen.
+     */
+    keepaliveUpload(uploadId: string, opts?: {
+        signal?: AbortSignal;
+    }): Promise<_Sdk3HandCodedKeepaliveResult>;
+    /**
+     * Private walk-pagination helper for /status. Aggregates every page into
+     * a single `_Sdk3HandCodedMultipartStatusResult`. AbortSignal short-circuits
+     * the loop between page fetches AND propagates into each fetch.
+     *
+     * Limit pinned to 1000 (max per page) so we make the minimum number of
+     * round-trips even for the worst-case ~10 pages on a 10 000-part upload.
+     */
+    private walkUploadStatus;
     /**
      * Create a new workflow.
      */
@@ -99,7 +181,9 @@ export declare class GislClient {
     /**
      * Stream SSE events for a workflow. Returns an async iterable.
      */
-    streamEvents(workflowId: string): Promise<AsyncGenerator<GislSseEvent>>;
+    streamEvents(workflowId: string, opts?: {
+        signal?: AbortSignal;
+    }): Promise<AsyncGenerator<GislSseEvent>>;
     /**
      * Get metadata for an uploaded file.
      */