@giveitsmaller/sdk 0.2.0 → 0.2.2

package/dist/client.d.ts

@@ -1,5 +1,6 @@
 import type { UploadResponse, WorkflowCreateResponse, WorkflowStatusResponse, WorkflowDownloadResponse, MetadataResponse, OperationsSchemaResponse, RetryResponse } from '@giveitsmaller/contracts/openapi';
 import type { GislClientConfig, GislSseEvent, UploadOptions, WaitOptions, WorkflowCreatePayload } from './types.js';
+export declare const DEFAULT_MULTIPART_FIRST_CHUNK_SIZE: number;
 export declare class GislClient {
     private readonly baseUrl;
     private readonly headers;

package/dist/client.js

@@ -6,6 +6,12 @@ import { parseSseStream } from './sse.js';
 const DEFAULT_TIMEOUT_MS = 30_000;
 const DEFAULT_MULTIPART_THRESHOLD = 10 * 1024 * 1024; // 10 MB
 const DEFAULT_MULTIPART_CONCURRENCY = 4;
+// Fixed per contract (compression_contracts/openapi/api.yaml:134). The server
+// uses the first chunk for MIME detection + throughput measurement and stores
+// it as S3 multipart part 1. Must NOT be derived from multipartThreshold —
+// that is the "use multipart above this size" routing threshold, a separate
+// concept. Conflating them caused the /api/uploads/multipart/initiate 413.
+export const DEFAULT_MULTIPART_FIRST_CHUNK_SIZE = 8 * 1024 * 1024; // 8 MB
 const DEFAULT_POLL_INTERVAL_MS = 2_000;
 const DEFAULT_POLL_TIMEOUT_MS = 300_000; // 5 min
 const TERMINAL_STATUSES = new Set([
@@ -22,7 +28,10 @@ export class GislClient {
     constructor(config) {
         this.baseUrl = config.baseUrl.replace(/\/+$/, '');
         this.timeoutMs = config.timeout ?? DEFAULT_TIMEOUT_MS;
-        this.multipartThreshold = config.multipartThreshold ?? DEFAULT_MULTIPART_THRESHOLD;
+        // Floor the threshold at the first-chunk size: the multipart initiate
+        // must always carry an 8MB chunk, so routing a sub-8MB file into the
+        // multipart path would violate the contract.
+        this.multipartThreshold = Math.max(config.multipartThreshold ?? DEFAULT_MULTIPART_THRESHOLD, DEFAULT_MULTIPART_FIRST_CHUNK_SIZE);
         this.multipartConcurrency = config.multipartConcurrency ?? DEFAULT_MULTIPART_CONCURRENCY;
         this.headers = { ...config.headers };
         if (config.apiKey) {
@@ -136,12 +145,12 @@ export class GislClient {
     }
     async multipartUpload(blob, fileName, totalSize, options) {
         // Step 1: Initiate with first chunk
-        const firstChunkSize = Math.min(totalSize, this.multipartThreshold);
+        const firstChunkSize = Math.min(totalSize, DEFAULT_MULTIPART_FIRST_CHUNK_SIZE);
         const firstChunk = blob.slice(0, firstChunkSize);
         const initiateForm = new FormData();
-        initiateForm.append('chunk', firstChunk, fileName);
-        initiateForm.append('original_name', fileName);
-        initiateForm.append('total_size_bytes', totalSize.toString());
+        initiateForm.append('file', firstChunk, fileName);
+        initiateForm.append('filename', fileName);
+        initiateForm.append('total_size', totalSize.toString());
         const initResponse = await this.request('POST', '/api/uploads/multipart/initiate', {
             body: initiateForm,
             json: false,
@@ -236,7 +245,7 @@ export class GislClient {
      * Get download URLs for a completed workflow.
      */
     async getWorkflowDownloads(workflowId) {
-        return this.request('GET', `/api/workflows/${encodeURIComponent(workflowId)}/download`, {
+        return this.request('GET', `/api/workflows/${encodeURIComponent(workflowId)}/downloads`, {
             deserialize: WorkflowDownloadResponseFromJSON,
         });
     }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { GislClient } from './client.js';
+export { GislClient, DEFAULT_MULTIPART_FIRST_CHUNK_SIZE } from './client.js';
 export { verifyWebhook } from './webhook.js';
 export { parseSseStream } from './sse.js';
 export type { GislClientConfig, GislSseEvent, UploadOptions, WaitOptions, WorkflowCreatePayload, OperationDef, FileJobPayload, SourceJobPayload, InputsJobPayload, JobDefinitionPayload, } from './types.js';

package/dist/index.js

@@ -1,5 +1,5 @@
 // SDK classes and functions
-export { GislClient } from './client.js';
+export { GislClient, DEFAULT_MULTIPART_FIRST_CHUNK_SIZE } from './client.js';
 export { verifyWebhook } from './webhook.js';
 export { parseSseStream } from './sse.js';
 export { fileJob, sourceJob, inputsJob } from './types.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@giveitsmaller/sdk",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Node.js SDK for the GISL (Give It Smaller) file compression and processing API",
   "license": "MIT",
   "type": "module",
@@ -24,7 +24,8 @@
   "devDependencies": {
     "@types/node": "^22",
     "typescript": "^5.7",
-    "vitest": "^3.1"
+    "vitest": "^3.1",
+    "yaml": "^2.6"
   },
   "scripts": {
     "build": "tsc",