transloadit 6.4.0 → 6.6.0

package/dist/cli/types.d.ts

@@ -1,5 +1,71 @@
 import type { Steps } from '../alphalib/types/template.ts';
 import { z } from 'zod';
+/** Project unchecked API responses to CLI diagnostics without nested request metadata. */
+export declare const assemblySummarySchema: z.ZodObject<{
+    assembly_id: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    assembly_url: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    assembly_ssl_url: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    ok: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+    error: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    message: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    ignored_error_count: z.ZodCatch<z.ZodDefault<z.ZodNumber>>;
+    ignored_errors: z.ZodCatch<z.ZodDefault<z.ZodArray<z.ZodCatch<z.ZodObject<{
+        step: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
+        phase: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        error: z.ZodCatch<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+            code: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+            message: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+        }, "strip", z.ZodTypeAny, {
+            code?: string | undefined;
+            message?: string | undefined;
+        }, {
+            code?: unknown;
+            message?: unknown;
+        }>]>>>;
+        message: z.ZodCatch<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        error?: string | {
+            code?: string | undefined;
+            message?: string | undefined;
+        } | undefined;
+        message?: string | undefined;
+        step?: string | null | undefined;
+        phase?: string | undefined;
+    }, {
+        error?: unknown;
+        message?: unknown;
+        step?: unknown;
+        phase?: unknown;
+    }>>, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    ignored_errors: {
+        error?: string | {
+            code?: string | undefined;
+            message?: string | undefined;
+        } | undefined;
+        message?: string | undefined;
+        step?: string | null | undefined;
+        phase?: string | undefined;
+    }[];
+    ignored_error_count: number;
+    error?: string | undefined;
+    message?: string | undefined;
+    ok?: string | null | undefined;
+    assembly_id?: string | undefined;
+    assembly_url?: string | null | undefined;
+    assembly_ssl_url?: string | null | undefined;
+}, {
+    error?: unknown;
+    message?: unknown;
+    ok?: unknown;
+    assembly_id?: unknown;
+    assembly_url?: unknown;
+    assembly_ssl_url?: unknown;
+    ignored_errors?: unknown;
+    ignored_error_count?: unknown;
+}>;
+/** Public diagnostics from one Assembly, excluding instructions and request internals. */
+export type AssemblySummary = z.infer<typeof assemblySummarySchema>;
 declare const APIErrorSchema: z.ZodObject<{
     error: z.ZodString;
     message: z.ZodString;

package/dist/cli/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/cli/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,QAAA,MAAM,cAAc;;;;;;;;;EAGlB,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAErD,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAe7B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAG3E,MAAM,WAAW,gBAAgB;IAC/B,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,gBAAgB,CAAA;CACvB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAKjD;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAE5D;AAGD,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF;AAGD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,cAAc,CAE/E"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/cli/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAA;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAsBvB,0FAA0F;AAC1F,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAShC,CAAA;AAEF,0FAA0F;AAC1F,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAGnE,QAAA,MAAM,cAAc;;;;;;;;;EAGlB,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAErD,QAAA,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAe7B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AAG3E,MAAM,WAAW,gBAAgB;IAC/B,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,gBAAgB,CAAA;CACvB;AAGD,wBAAgB,WAAW,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CAKjD;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,QAAQ,CAE5D;AAGD,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,mBAAmB,CAElF;AAGD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,cAAc,CAE/E"}

package/dist/cli/types.js

@@ -1,4 +1,33 @@
 import { z } from 'zod';
+const ignoredErrorDetailsSchema = z
+    .union([
+    z.string(),
+    z.object({
+        code: z.string().optional().catch(undefined),
+        message: z.string().optional().catch(undefined),
+    }),
+])
+    .optional()
+    .catch(undefined);
+const ignoredErrorSummarySchema = z
+    .object({
+    step: z.string().nullable().optional().catch(undefined),
+    phase: z.string().optional().catch(undefined),
+    error: ignoredErrorDetailsSchema,
+    message: z.string().optional().catch(undefined),
+})
+    .catch({});
+/** Project unchecked API responses to CLI diagnostics without nested request metadata. */
+export const assemblySummarySchema = z.object({
+    assembly_id: z.string().optional().catch(undefined),
+    assembly_url: z.string().nullable().optional().catch(undefined),
+    assembly_ssl_url: z.string().nullable().optional().catch(undefined),
+    ok: z.string().nullable().optional().catch(undefined),
+    error: z.string().optional().catch(undefined),
+    message: z.string().optional().catch(undefined),
+    ignored_error_count: z.number().finite().int().nonnegative().default(0).catch(0),
+    ignored_errors: z.array(ignoredErrorSummarySchema).default([]).catch([]),
+});
 // Zod schemas for runtime validation
 const APIErrorSchema = z.object({
     error: z.string(),

package/dist/cli/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/cli/types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,qCAAqC;AACrC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAGF,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,IAAI,EAAE,CAAC;aACJ,MAAM,CAAC;YACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC7B,CAAC;aACD,QAAQ,EAAE;QACb,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAA;AAeF,uCAAuC;AACvC,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAC5D,CAAC;AAED,0BAA0B;AAC1B,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AAChD,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,qBAAqB,CAAC,KAAc;IAClD,OAAO,yBAAyB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AAC3D,CAAC;AAED,uCAAuC;AACvC,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,CAAA;AAClD,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/cli/types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,yBAAyB,GAAG,CAAC;KAChC,KAAK,CAAC;IACL,CAAC,CAAC,MAAM,EAAE;IACV,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;QAC5C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;KAChD,CAAC;CACH,CAAC;KACD,QAAQ,EAAE;KACV,KAAK,CAAC,SAAS,CAAC,CAAA;AAEnB,MAAM,yBAAyB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IACvD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IAC7C,KAAK,EAAE,yBAAyB;IAChC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;CAChD,CAAC;KACD,KAAK,CAAC,EAAE,CAAC,CAAA;AAEZ,0FAA0F;AAC1F,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IACnD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IAC/D,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IACnE,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IACrD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IAC7C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;IAC/C,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IAChF,cAAc,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;CACzE,CAAC,CAAA;AAKF,qCAAqC;AACrC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAGF,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3B,oBAAoB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC;QACN,IAAI,EAAE,CAAC;aACJ,MAAM,CAAC;YACN,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC7B,CAAC;aACD,QAAQ,EAAE;QACb,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAA;AAeF,uCAAuC;AACvC,MAAM,UAAU,WAAW,CAAC,KAAc;IACxC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,OAAO,IAAI,KAAK,CAAC,yBAAyB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAC5D,CAAC;AAED,0BAA0B;AAC1B,MAAM,UAAU,UAAU,CAAC,KAAc;IACvC,OAAO,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AAChD,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,qBAAqB,CAAC,KAAc;IAClD,OAAO,yBAAyB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAA;AAC3D,CAAC;AAED,uCAAuC;AACvC,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,CAAA;AAClD,CAAC"}

package/dist/tus.d.ts

@@ -1,6 +1,7 @@
 import type { Readable } from 'node:stream';
 import type { AssemblyStatus } from './alphalib/types/assemblyStatus.ts';
 import type { UploadProgress } from './Transloadit.ts';
+import { ReadStream } from 'node:fs';
 export type UploadBehavior = 'await' | 'background' | 'none';
 export interface Stream {
     path?: string;
@@ -15,9 +16,13 @@ interface SendTusRequestOptions {
     signal?: AbortSignal;
     uploadUrls?: Record<string, string>;
     uploadBehavior?: UploadBehavior;
+    onFileStreamOpened?: (stream: ReadStream) => void;
+    onFileSliceStarted?: (slice: Promise<unknown>) => void;
 }
-export declare function sendTusRequest({ streamsMap, assembly, requestedChunkSize, uploadConcurrency, onProgress, signal, uploadUrls, uploadBehavior, }: SendTusRequestOptions): Promise<{
+interface SendTusRequestResult {
     uploadUrls: Record<string, string>;
-}>;
+    uploadsComplete?: Promise<unknown>;
+}
+export declare function sendTusRequest({ streamsMap, assembly, requestedChunkSize, uploadConcurrency, onProgress, signal, uploadUrls, uploadBehavior, onFileStreamOpened, onFileSliceStarted, }: SendTusRequestOptions): Promise<SendTusRequestResult>;
 export {};
 //# sourceMappingURL=tus.d.ts.map

package/dist/tus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tus.d.ts","sourceRoot":"","sources":["../src/tus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAI3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAA;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAYtD,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAA;AAE5D,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,QAAQ,CAAA;CACjB;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,QAAQ,EAAE,cAAc,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,UAAU,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAA;IAC7C,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACnC,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,UAAU,EACV,cAAwB,GACzB,EAAE,qBAAqB;;GA8NvB"}
+{"version":3,"file":"tus.d.ts","sourceRoot":"","sources":["../src/tus.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAW3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAA;AACxE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEtD,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAWpC,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAA;AAE5D,MAAM,WAAW,MAAM;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,QAAQ,CAAA;CACjB;AAED,UAAU,qBAAqB;IAC7B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,QAAQ,EAAE,cAAc,CAAA;IACxB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,iBAAiB,EAAE,MAAM,CAAA;IACzB,UAAU,EAAE,CAAC,OAAO,EAAE,cAAc,KAAK,IAAI,CAAA;IAC7C,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACnC,cAAc,CAAC,EAAE,cAAc,CAAA;IAC/B,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,IAAI,CAAA;IACjD,kBAAkB,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;CACvD;AAED,UAAU,oBAAoB;IAC5B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,eAAe,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;CACnC;AAED,wBAAsB,cAAc,CAAC,EACnC,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,UAAU,EACV,cAAwB,EACxB,kBAAkB,EAClB,kBAAkB,GACnB,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAgRvD"}

package/dist/tus.js

@@ -1,11 +1,12 @@
+import { ReadStream } from 'node:fs';
 import { stat } from 'node:fs/promises';
 import { basename } from 'node:path';
 import debug from 'debug';
 import pMap from 'p-map';
-import { Upload } from 'tus-js-client';
+import { defaultOptions, Upload } from 'tus-js-client';
 const log = debug('transloadit');
 const logWarn = debug('transloadit:warn');
-export async function sendTusRequest({ streamsMap, assembly, requestedChunkSize, uploadConcurrency, onProgress, signal, uploadUrls, uploadBehavior = 'await', }) {
+export async function sendTusRequest({ streamsMap, assembly, requestedChunkSize, uploadConcurrency, onProgress, signal, uploadUrls, uploadBehavior = 'await', onFileStreamOpened, onFileSliceStarted, }) {
     const streamLabels = Object.keys(streamsMap);
     let totalBytes = 0;
     let lastEmittedProgress = 0;
@@ -143,6 +144,25 @@ export async function sendTusRequest({ streamsMap, assembly, requestedChunkSize,
                     fieldname: label,
                     filename,
                 },
+                httpStack: {
+                    createRequest(method, url) {
+                        const request = defaultOptions.httpStack.createRequest(method, url);
+                        const send = request.send.bind(request);
+                        request.send = (body) => {
+                            // tus awaits pre-request hooks, so queued aborts must be checked at send itself.
+                            if (signal?.aborted) {
+                                // File setup can finish after abort() and reset tus's aborted state.
+                                tusUpload.abort();
+                                return Promise.reject(new Error('Upload aborted'));
+                            }
+                            return send(body);
+                        };
+                        return request;
+                    },
+                    getName() {
+                        return defaultOptions.httpStack.getName();
+                    },
+                },
                 onError: reject,
                 onProgress: onTusProgress,
                 onSuccess: resolve,
@@ -158,6 +178,39 @@ export async function sendTusRequest({ streamsMap, assembly, requestedChunkSize,
                     }
                 },
             };
+            if (onFileStreamOpened) {
+                // tus opens a separate ReadStream for each chunk; abort() leaves those streams open.
+                // Track those chunks even when the original file stream belongs to the caller.
+                tusOptions.fileReader = {
+                    async openFile(input, chunkSize) {
+                        const source = await defaultOptions.fileReader.openFile(input, chunkSize);
+                        return {
+                            size: source.size,
+                            async slice(start, end) {
+                                if (signal?.aborted)
+                                    throw new Error('Upload aborted');
+                                const reading = source.slice(start, end).then((chunk) => {
+                                    // tus-js-client declares platform-specific chunk values as any.
+                                    const value = chunk.value;
+                                    if (value instanceof ReadStream)
+                                        onFileStreamOpened(value);
+                                    if (signal?.aborted)
+                                        throw new Error('Upload aborted');
+                                    return chunk;
+                                });
+                                // A file slice can open its stream before the promise resolves.
+                                if (input instanceof ReadStream && input.path != null) {
+                                    onFileSliceStarted?.(reading);
+                                }
+                                return await reading;
+                            },
+                            close() {
+                                source.close();
+                            },
+                        };
+                    },
+                };
+            }
             // tus-js-client doesn't like undefined/null
             if (size != null)
                 tusOptions.uploadSize = size;
@@ -189,14 +242,15 @@ export async function sendTusRequest({ streamsMap, assembly, requestedChunkSize,
     }
     await pMap(streamLabels, uploadSingleStream, { concurrency: uploadConcurrency, signal });
     await Promise.all(uploadUrlPromises);
+    const uploadsComplete = Promise.allSettled(completionPromises);
     if (uploadBehavior === 'await') {
         await Promise.all(completionPromises);
     }
     else {
-        Promise.allSettled(completionPromises).catch((err) => {
+        uploadsComplete.catch((err) => {
             logWarn('Background upload failed', err);
         });
     }
-    return { uploadUrls: uploadUrlsResult };
+    return { uploadUrls: uploadUrlsResult, uploadsComplete };
 }
 //# sourceMappingURL=tus.js.map

package/dist/tus.js.map

@@ -1 +1 @@
-{"version":3,"file":"tus.js","sourceRoot":"","sources":["../src/tus.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAEpC,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,IAAI,MAAM,OAAO,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtC,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC,CAAA;AAChC,MAAM,OAAO,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAA;AAoBzC,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,UAAU,EACV,cAAc,GAAG,OAAO,GACF;IACtB,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAE5C,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,IAAI,mBAAmB,GAAG,CAAC,CAAA;IAE3B,MAAM,KAAK,GAA2B,EAAE,CAAA;IACxC,MAAM,gBAAgB,GAA2B,EAAE,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAA;IAE1E,MAAM,wBAAwB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;IAEvF,uBAAuB;IACvB,MAAM,IAAI,CACR,YAAY,EACZ,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,yCAAyC;QACzC,IAAI,MAAM,EAAE,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAEtD,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAA;QAE3B,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAA;YACjC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YACnB,UAAU,IAAI,IAAI,CAAA;QACpB,CAAC;IACH,CAAC,EACD,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,CAC3B,CAAA;IAED,MAAM,gBAAgB,GAA2B,EAAE,CAAA;IAEnD,MAAM,kBAAkB,GAAyB,EAAE,CAAA;IACnD,MAAM,iBAAiB,GAAyB,EAAE,CAAA;IAElD,KAAK,UAAU,kBAAkB,CAAC,KAAa;QAC7C,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAE3B,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAA;QACnC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;QAEzB,IAAI,SAAS,GAAG,kBAAkB,CAAA;QAClC,IAAI,oBAA6B,CAAA;QACjC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAA;QAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,0EAA0E;YAC1E,oFAAoF;YACpF,oBAAoB,GAAG,IAAI,CAAA;YAC3B,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB;gBAAE,SAAS,GAAG,IAAI,CAAA;QAC9D,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,aAAqB,EAAQ,EAAE;YACpD,gBAAgB,CAAC,KAAK,CAAC,GAAG,aAAa,CAAA;YAEvC,uCAAuC;YACvC,IAAI,aAAa,GAAG,CAAC,CAAA;YACrB,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC;gBAC7B,aAAa,IAAI,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC3C,CAAC;YAED,gCAAgC;YAChC,IAAI,mBAAmB,GAAG,aAAa,EAAE,CAAC;gBACxC,mBAAmB,GAAG,aAAa,CAAA;gBACnC,oEAAoE;gBACpE,yEAAyE;gBACzE,UAAU,CAAC;oBACT,aAAa;oBACb,UAAU,EAAE,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU;iBAC9D,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAA;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAE9C,IAAI,cAAc,KAAK,MAAM,IAAI,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,gBAAgB,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;YAC3C,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YACzC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YAC1C,OAAM;QACR,CAAC;QAED,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,IAAI,UAAU,GAAe,GAAG,EAAE,GAAE,CAAC,CAAA;QACrC,IAAI,SAAS,GAAyB,GAAG,EAAE,GAAE,CAAC,CAAA;QAC9C,MAAM,gBAAgB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7D,UAAU,GAAG,GAAG,EAAE;gBAChB,IAAI,WAAW;oBAAE,OAAM;gBACvB,WAAW,GAAG,IAAI,CAAA;gBAClB,OAAO,EAAE,CAAA;YACX,CAAC,CAAA;YACD,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE;gBAClB,IAAI,WAAW;oBAAE,OAAM;gBACvB,WAAW,GAAG,IAAI,CAAA;gBAClB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,iBAAiB,GAAe,GAAG,EAAE,GAAE,CAAC,CAAA;QAC5C,IAAI,gBAAgB,GAAyB,GAAG,EAAE,GAAE,CAAC,CAAA;QACrD,MAAM,iBAAiB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9D,iBAAiB,GAAG,OAAO,CAAA;YAC3B,gBAAgB,GAAG,MAAM,CAAA;QAC3B,CAAC,CAAC,CAAA;QAEF,gGAAgG;QAChG,8FAA8F;QAC9F,4BAA4B;QAC5B,gBAAgB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAChC,iBAAiB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAEjC,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACxC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAE1C,IAAI,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,gBAAgB,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;YAC3C,UAAU,EAAE,CAAA;QACd,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,OAAO,CAAO,CAAC,cAAc,EAAE,aAAa,EAAE,EAAE;YACvE,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;gBAC/B,aAAa,CAAC,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC,CAAA;gBAClF,OAAM;YACR,CAAC;YAED,2CAA2C;YAC3C,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;gBACpB,aAAa,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;gBAC1C,OAAM;YACR,CAAC;YAED,iDAAiD;YACjD,IAAI,YAAsC,CAAA;YAC1C,MAAM,OAAO,GAAG,CAAC,QAA0B,EAAE,EAAE;gBAC7C,IAAI,YAAY;oBAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;gBACpE,iBAAiB,EAAE,CAAA;gBACnB,UAAU,EAAE,CAAA;gBACZ,cAAc,EAAE,CAAA;YAClB,CAAC,CAAA;YACD,MAAM,MAAM,GAAG,CAAC,GAAY,EAAE,EAAE;gBAC9B,IAAI,YAAY;oBAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;gBACpE,gBAAgB,CAAC,GAAY,CAAC,CAAA;gBAC9B,SAAS,CAAC,GAAY,CAAC,CAAA;gBACvB,aAAa,CAAC,GAAG,CAAC,CAAA;YACpB,CAAC,CAAA;YAED,IAAI,SAAiB,CAAA;YACrB,MAAM,UAAU,GAAkB;gBAChC,QAAQ,EAAE,QAAQ,CAAC,OAAO;gBAC1B,SAAS,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC;gBAC9B,QAAQ,EAAE;oBACR,YAAY,EAAE,QAAQ,CAAC,gBAAgB;oBACvC,SAAS,EAAE,KAAK;oBAChB,QAAQ;iBACT;gBACD,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,aAAa;gBACzB,SAAS,EAAE,OAAO;gBAClB,oBAAoB,EAAE,GAAG,EAAE;oBACzB,MAAM,GAAG,GAAG,SAAS,EAAE,GAAG,CAAA;oBAC1B,IAAI,GAAG,EAAE,CAAC;wBACR,gBAAgB,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;oBAC/B,CAAC;oBACD,UAAU,EAAE,CAAA;oBACZ,IAAI,cAAc,KAAK,MAAM,EAAE,CAAC;wBAC9B,SAAS,CAAC,KAAK,EAAE,CAAA;wBACjB,iBAAiB,EAAE,CAAA;oBACrB,CAAC;gBACH,CAAC;aACF,CAAA;YACD,4CAA4C;YAC5C,IAAI,IAAI,IAAI,IAAI;gBAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAA;YAC9C,IAAI,SAAS;gBAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;YAC/C,IAAI,oBAAoB;gBAAE,UAAU,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;YAEhF,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YAE1C,sBAAsB;YACtB,IAAI,MAAM,EAAE,CAAC;gBACX,YAAY,GAAG,GAAG,EAAE;oBAClB,SAAS,CAAC,KAAK,EAAE,CAAA;oBACjB,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;gBACrC,CAAC,CAAA;gBACD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;YAChE,CAAC;YAED,SAAS,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC,CAAC,CAAA;QAEF,IAAI,cAAc,KAAK,OAAO,EAAE,CAAC;YAC/B,MAAM,YAAY,CAAA;YAClB,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;YACzB,OAAM;QACR,CAAC;QAED,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACzB,OAAO,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,MAAM,gBAAgB,CAAA;QACtB,GAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;IAC9B,CAAC;IAED,MAAM,IAAI,CAAC,YAAY,EAAE,kBAAkB,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAA;IAExF,MAAM,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAEpC,IAAI,cAAc,KAAK,OAAO,EAAE,CAAC;QAC/B,MAAM,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IACvC,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACnD,OAAO,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,CAAA;AACzC,CAAC"}
+{"version":3,"file":"tus.js","sourceRoot":"","sources":["../src/tus.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAA;AAEpC,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,IAAI,MAAM,OAAO,CAAA;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtD,MAAM,GAAG,GAAG,KAAK,CAAC,aAAa,CAAC,CAAA;AAChC,MAAM,OAAO,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAA;AA2BzC,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,UAAU,EACV,cAAc,GAAG,OAAO,EACxB,kBAAkB,EAClB,kBAAkB,GACI;IACtB,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;IAE5C,IAAI,UAAU,GAAG,CAAC,CAAA;IAClB,IAAI,mBAAmB,GAAG,CAAC,CAAA;IAE3B,MAAM,KAAK,GAA2B,EAAE,CAAA;IACxC,MAAM,gBAAgB,GAA2B,EAAE,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC,EAAE,CAAA;IAE1E,MAAM,wBAAwB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAA;IAEvF,uBAAuB;IACvB,MAAM,IAAI,CACR,YAAY,EACZ,KAAK,EAAE,KAAK,EAAE,EAAE;QACd,yCAAyC;QACzC,IAAI,MAAM,EAAE,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;QAEtD,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAA;QAE3B,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAA;YACjC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;YACnB,UAAU,IAAI,IAAI,CAAA;QACpB,CAAC;IACH,CAAC,EACD,EAAE,WAAW,EAAE,CAAC,EAAE,MAAM,EAAE,CAC3B,CAAA;IAED,MAAM,gBAAgB,GAA2B,EAAE,CAAA;IAEnD,MAAM,kBAAkB,GAAyB,EAAE,CAAA;IACnD,MAAM,iBAAiB,GAAyB,EAAE,CAAA;IAElD,KAAK,UAAU,kBAAkB,CAAC,KAAa;QAC7C,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAE3B,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;QACpC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,KAAK,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,UAAU,CAAA;QACnC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;QAEzB,IAAI,SAAS,GAAG,kBAAkB,CAAA;QAClC,IAAI,oBAA6B,CAAA;QACjC,MAAM,mBAAmB,GAAG,CAAC,CAAC,IAAI,CAAA;QAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,0EAA0E;YAC1E,oFAAoF;YACpF,oBAAoB,GAAG,IAAI,CAAA;YAC3B,IAAI,SAAS,KAAK,MAAM,CAAC,iBAAiB;gBAAE,SAAS,GAAG,IAAI,CAAA;QAC9D,CAAC;QAED,MAAM,aAAa,GAAG,CAAC,aAAqB,EAAQ,EAAE;YACpD,gBAAgB,CAAC,KAAK,CAAC,GAAG,aAAa,CAAA;YAEvC,uCAAuC;YACvC,IAAI,aAAa,GAAG,CAAC,CAAA;YACrB,KAAK,MAAM,CAAC,IAAI,YAAY,EAAE,CAAC;gBAC7B,aAAa,IAAI,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC3C,CAAC;YAED,gCAAgC;YAChC,IAAI,mBAAmB,GAAG,aAAa,EAAE,CAAC;gBACxC,mBAAmB,GAAG,aAAa,CAAA;gBACnC,oEAAoE;gBACpE,yEAAyE;gBACzE,UAAU,CAAC;oBACT,aAAa;oBACb,UAAU,EAAE,wBAAwB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU;iBAC9D,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAA;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAA;QAE9C,IAAI,cAAc,KAAK,MAAM,IAAI,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;YACrD,gBAAgB,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;YAC3C,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YACzC,kBAAkB,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAA;YAC1C,OAAM;QACR,CAAC;QAED,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,IAAI,UAAU,GAAe,GAAG,EAAE,GAAE,CAAC,CAAA;QACrC,IAAI,SAAS,GAAyB,GAAG,EAAE,GAAE,CAAC,CAAA;QAC9C,MAAM,gBAAgB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC7D,UAAU,GAAG,GAAG,EAAE;gBAChB,IAAI,WAAW;oBAAE,OAAM;gBACvB,WAAW,GAAG,IAAI,CAAA;gBAClB,OAAO,EAAE,CAAA;YACX,CAAC,CAAA;YACD,SAAS,GAAG,CAAC,GAAG,EAAE,EAAE;gBAClB,IAAI,WAAW;oBAAE,OAAM;gBACvB,WAAW,GAAG,IAAI,CAAA;gBAClB,MAAM,CAAC,GAAG,CAAC,CAAA;YACb,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,iBAAiB,GAAe,GAAG,EAAE,GAAE,CAAC,CAAA;QAC5C,IAAI,gBAAgB,GAAyB,GAAG,EAAE,GAAE,CAAC,CAAA;QACrD,MAAM,iBAAiB,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YAC9D,iBAAiB,GAAG,OAAO,CAAA;YAC3B,gBAAgB,GAAG,MAAM,CAAA;QAC3B,CAAC,CAAC,CAAA;QAEF,gGAAgG;QAChG,8FAA8F;QAC9F,4BAA4B;QAC5B,gBAAgB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAChC,iBAAiB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAEjC,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACxC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;QAE1C,IAAI,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,gBAAgB,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;YAC3C,UAAU,EAAE,CAAA;QACd,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,OAAO,CAAO,CAAC,cAAc,EAAE,aAAa,EAAE,EAAE;YACvE,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,CAAC;gBAC/B,aAAa,CAAC,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC,CAAA;gBAClF,OAAM;YACR,CAAC;YAED,2CAA2C;YAC3C,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;gBACpB,aAAa,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;gBAC1C,OAAM;YACR,CAAC;YAED,iDAAiD;YACjD,IAAI,YAAsC,CAAA;YAC1C,MAAM,OAAO,GAAG,CAAC,QAA0B,EAAE,EAAE;gBAC7C,IAAI,YAAY;oBAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;gBACpE,iBAAiB,EAAE,CAAA;gBACnB,UAAU,EAAE,CAAA;gBACZ,cAAc,EAAE,CAAA;YAClB,CAAC,CAAA;YACD,MAAM,MAAM,GAAG,CAAC,GAAY,EAAE,EAAE;gBAC9B,IAAI,YAAY;oBAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;gBACpE,gBAAgB,CAAC,GAAY,CAAC,CAAA;gBAC9B,SAAS,CAAC,GAAY,CAAC,CAAA;gBACvB,aAAa,CAAC,GAAG,CAAC,CAAA;YACpB,CAAC,CAAA;YAED,IAAI,SAAiB,CAAA;YACrB,MAAM,UAAU,GAAkB;gBAChC,QAAQ,EAAE,QAAQ,CAAC,OAAO;gBAC1B,SAAS,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC;gBAC9B,QAAQ,EAAE;oBACR,YAAY,EAAE,QAAQ,CAAC,gBAAgB;oBACvC,SAAS,EAAE,KAAK;oBAChB,QAAQ;iBACT;gBACD,SAAS,EAAE;oBACT,aAAa,CAAC,MAAc,EAAE,GAAW;wBACvC,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;wBACnE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;wBACvC,OAAO,CAAC,IAAI,GAAG,CAAC,IAAa,EAAyB,EAAE;4BACtD,iFAAiF;4BACjF,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;gCACpB,qEAAqE;gCACrE,SAAS,CAAC,KAAK,EAAE,CAAA;gCACjB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;4BACpD,CAAC;4BACD,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;wBACnB,CAAC,CAAA;wBACD,OAAO,OAAO,CAAA;oBAChB,CAAC;oBACD,OAAO;wBACL,OAAO,cAAc,CAAC,SAAS,CAAC,OAAO,EAAE,CAAA;oBAC3C,CAAC;iBACF;gBACD,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,aAAa;gBACzB,SAAS,EAAE,OAAO;gBAClB,oBAAoB,EAAE,GAAG,EAAE;oBACzB,MAAM,GAAG,GAAG,SAAS,EAAE,GAAG,CAAA;oBAC1B,IAAI,GAAG,EAAE,CAAC;wBACR,gBAAgB,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;oBAC/B,CAAC;oBACD,UAAU,EAAE,CAAA;oBACZ,IAAI,cAAc,KAAK,MAAM,EAAE,CAAC;wBAC9B,SAAS,CAAC,KAAK,EAAE,CAAA;wBACjB,iBAAiB,EAAE,CAAA;oBACrB,CAAC;gBACH,CAAC;aACF,CAAA;YACD,IAAI,kBAAkB,EAAE,CAAC;gBACvB,qFAAqF;gBACrF,+EAA+E;gBAC/E,UAAU,CAAC,UAAU,GAAG;oBACtB,KAAK,CAAC,QAAQ,CAAC,KAAc,EAAE,SAAiB;wBAC9C,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,UAAU,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;wBACzE,OAAO;4BACL,IAAI,EAAE,MAAM,CAAC,IAAI;4BACjB,KAAK,CAAC,KAAK,CAAC,KAAa,EAAE,GAAW;gCACpC,IAAI,MAAM,EAAE,OAAO;oCAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;gCACtD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;oCACtD,gEAAgE;oCAChE,MAAM,KAAK,GAAY,KAAK,CAAC,KAAK,CAAA;oCAClC,IAAI,KAAK,YAAY,UAAU;wCAAE,kBAAkB,CAAC,KAAK,CAAC,CAAA;oCAC1D,IAAI,MAAM,EAAE,OAAO;wCAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAA;oCACtD,OAAO,KAAK,CAAA;gCACd,CAAC,CAAC,CAAA;gCACF,gEAAgE;gCAChE,IAAI,KAAK,YAAY,UAAU,IAAI,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oCACtD,kBAAkB,EAAE,CAAC,OAAO,CAAC,CAAA;gCAC/B,CAAC;gCACD,OAAO,MAAM,OAAO,CAAA;4BACtB,CAAC;4BACD,KAAK;gCACH,MAAM,CAAC,KAAK,EAAE,CAAA;4BAChB,CAAC;yBACF,CAAA;oBACH,CAAC;iBACF,CAAA;YACH,CAAC;YACD,4CAA4C;YAC5C,IAAI,IAAI,IAAI,IAAI;gBAAE,UAAU,CAAC,UAAU,GAAG,IAAI,CAAA;YAC9C,IAAI,SAAS;gBAAE,UAAU,CAAC,SAAS,GAAG,SAAS,CAAA;YAC/C,IAAI,oBAAoB;gBAAE,UAAU,CAAC,oBAAoB,GAAG,oBAAoB,CAAA;YAEhF,SAAS,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;YAE1C,sBAAsB;YACtB,IAAI,MAAM,EAAE,CAAC;gBACX,YAAY,GAAG,GAAG,EAAE;oBAClB,SAAS,CAAC,KAAK,EAAE,CAAA;oBACjB,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAA;gBACrC,CAAC,CAAA;gBACD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAA;YAChE,CAAC;YAED,SAAS,CAAC,KAAK,EAAE,CAAA;QACnB,CAAC,CAAC,CAAA;QAEF,IAAI,cAAc,KAAK,OAAO,EAAE,CAAC;YAC/B,MAAM,YAAY,CAAA;YAClB,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;YACzB,OAAM;QACR,CAAC;QAED,YAAY,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACzB,OAAO,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,MAAM,gBAAgB,CAAA;QACtB,GAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;IAC9B,CAAC;IAED,MAAM,IAAI,CAAC,YAAY,EAAE,kBAAkB,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAA;IAExF,MAAM,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;IAEpC,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAA;IAC9D,IAAI,cAAc,KAAK,OAAO,EAAE,CAAC;QAC/B,MAAM,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAA;IACvC,CAAC;SAAM,CAAC;QACN,eAAe,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YAC5B,OAAO,CAAC,0BAA0B,EAAE,GAAG,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAA;AAC1D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "transloadit",
-  "version": "6.4.0",
+  "version": "6.6.0",
   "description": "Node.js SDK for Transloadit",
   "homepage": "https://github.com/transloadit/node-sdk/tree/main/packages/node",
   "bugs": {

package/src/Transloadit.ts

@@ -1,3 +1,4 @@
+import type { ReadStream } from 'node:fs'
 import type { Readable } from 'node:stream'
 
 import type {
@@ -72,9 +73,11 @@ import type { Stream, UploadBehavior } from './tus.ts'
 
 import * as assert from 'node:assert'
 import { randomUUID } from 'node:crypto'
+import { addAbortListener, setMaxListeners } from 'node:events'
 import { constants, createReadStream } from 'node:fs'
 import { access, stat } from 'node:fs/promises'
 import { basename } from 'node:path'
+import { finished } from 'node:stream/promises'
 import { setTimeout as delay } from 'node:timers/promises'
 
 import { compileAssemblyInstructionsFromPrompt } from '@transloadit/utils'
@@ -241,11 +244,15 @@ const toReadableUpload = (label: string, value: Readable | IntoStreamInput): Rea
   return readable ? value : intoStream(value)
 }
 
-const buildStreamsMap = (descriptors: UploadDescriptor[]): Record<string, Stream> =>
+const buildStreamsMap = (
+  descriptors: UploadDescriptor[],
+  onFileStreamOpened?: (stream: ReadStream) => void,
+): Record<string, Stream> =>
   Object.fromEntries(
     descriptors.map((descriptor) => {
       if (descriptor.path) {
         const stream = createReadStream(descriptor.path)
+        onFileStreamOpened?.(stream)
         return [descriptor.label, { stream, path: descriptor.path }]
       }
 
@@ -705,7 +712,7 @@ export class Transloadit {
       assemblyId,
       expectedUploads,
       onAssemblyCreated,
-      signal,
+      signal: callerSignal,
       uploadBehavior = 'await',
     } = opts
 
@@ -722,6 +729,34 @@ export class Transloadit {
       effectiveAssemblyId = randomUUID().replace(/-/g, '')
     }
     const urlSuffix = `/assemblies/${effectiveAssemblyId}`
+    const uploadAbort = new AbortController()
+    const signal = uploadAbort.signal
+    // This private signal coordinates every concurrent upload and its queue.
+    setMaxListeners(0, signal)
+    if (callerSignal?.aborted) uploadAbort.abort(callerSignal.reason)
+    // Older supported Node releases retain AbortSignal.any() dependencies indefinitely.
+    const callerAbort =
+      callerSignal && !callerSignal.aborted
+        ? addAbortListener(callerSignal, () => uploadAbort.abort(callerSignal.reason))
+        : undefined
+    const detachCallerAbort = (): void => {
+      callerAbort?.[Symbol.dispose]()
+    }
+    let backgroundUploadsComplete: Promise<unknown> | undefined
+    const openedFileStreams = new Set<ReadStream>()
+    const pendingFileSlices = new Set<Promise<unknown>>()
+    const onFileStreamOpened = (stream: ReadStream): void => {
+      // Register before I/O can emit close, so cleanup cannot miss that event.
+      openedFileStreams.add(stream)
+      stream.once('close', () => openedFileStreams.delete(stream))
+    }
+    const onFileSliceStarted = (slice: Promise<unknown>): void => {
+      pendingFileSlices.add(slice)
+      const remove = (): void => {
+        pendingFileSlices.delete(slice)
+      }
+      slice.then(remove, remove)
+    }
 
     // We want to be able to return the promise immediately with custom data
     const promise = (async () => {
@@ -746,7 +781,7 @@ export class Transloadit {
         })),
       ]
 
-      const allStreamsMap = buildStreamsMap(descriptors)
+      const allStreamsMap = buildStreamsMap(descriptors, onFileStreamOpened)
 
       const allStreams = Object.values(allStreamsMap)
 
@@ -779,7 +814,7 @@ export class Transloadit {
         onAssemblyCreated?.(result)
 
         if (Object.keys(allStreamsMap).length > 0) {
-          const { uploadUrls } = await sendTusRequest({
+          const { uploadUrls, uploadsComplete } = await sendTusRequest({
             streamsMap: allStreamsMap,
             assembly: result,
             onProgress: onUploadProgress,
@@ -787,7 +822,10 @@ export class Transloadit {
             uploadConcurrency,
             signal,
             uploadBehavior,
+            onFileStreamOpened,
+            onFileSliceStarted,
           })
+          if (uploadBehavior === 'background') backgroundUploadsComplete = uploadsComplete
           if (uploadBehavior !== 'await' && Object.keys(uploadUrls).length > 0) {
             result.upload_urls = uploadUrls
           }
@@ -813,6 +851,29 @@ export class Transloadit {
 
       return Promise.race([createAssemblyAndUpload(), streamErrorPromise])
     })()
+      .catch(async (error: unknown) => {
+        uploadAbort.abort()
+        // File descriptors must be closed before callers can remove their temporary files.
+        // Destroyed, unread streams reject finished(); cleanup must preserve the creation error.
+        while (openedFileStreams.size > 0 || pendingFileSlices.size > 0) {
+          await Promise.allSettled(pendingFileSlices)
+          await Promise.allSettled(
+            [...openedFileStreams].map((stream) => {
+              const closed = finished(stream, { cleanup: true })
+              stream.destroy()
+              return closed
+            }),
+          )
+        }
+        throw error
+      })
+      .finally(() => {
+        if (backgroundUploadsComplete && !signal.aborted) {
+          backgroundUploadsComplete.then(detachCallerAbort, detachCallerAbort)
+          return
+        }
+        detachCallerAbort()
+      })
 
     // This allows the user to use or log the assemblyId even before it has been created for easier debugging
     return Object.assign(promise, { assemblyId: effectiveAssemblyId })

package/src/alphalib/renderSimpleValue.ts

@@ -0,0 +1,120 @@
+import { truncateCodePointsWithEllipsis, truncateStringWithEllipsis } from './truncateString.ts'
+
+/** A safe scalar rendering policy for one customer-visible validation reason. */
+export interface SimpleValueReason {
+  readonly message: string
+  readonly suffix?: string
+  readonly value: 'integer-prefix' | 'string' | 'trimmed-string'
+}
+
+type SimpleArrayItem = string | number | boolean | bigint | null | Date
+
+function isSimpleArrayItem(value: unknown): value is SimpleArrayItem {
+  return (
+    value === null ||
+    value instanceof Date ||
+    typeof value === 'string' ||
+    typeof value === 'number' ||
+    typeof value === 'boolean' ||
+    typeof value === 'bigint'
+  )
+}
+
+function isSimpleValueArray(value: unknown): value is SimpleArrayItem[] {
+  return Array.isArray(value) && value.every(isSimpleArrayItem)
+}
+
+function renderSimpleArrayItem(value: SimpleArrayItem): string {
+  return value === null ? '' : String(value)
+}
+
+function* renderSimpleArrayCharacters(
+  values: readonly SimpleArrayItem[],
+  trim: boolean,
+): Generator<string, void, undefined> {
+  for (let index = 0; index < values.length; index += 1) {
+    if (index > 0) {
+      yield ','
+    }
+    let renderedItem = renderSimpleArrayItem(values[index])
+    if (trim && index === 0) {
+      renderedItem = renderedItem.trimStart()
+    }
+    if (trim && index === values.length - 1) {
+      renderedItem = renderedItem.trimEnd()
+    }
+    yield* renderedItem
+  }
+}
+
+/**
+ * Renders a scalar, Date, or flat scalar array without traversing arbitrary objects. Semantic
+ * predicates use the complete string; customer-facing reasons use the bounded formatter below.
+ */
+export function renderSimpleValueAsString(value: unknown): string | undefined {
+  if (
+    typeof value === 'string' ||
+    typeof value === 'number' ||
+    typeof value === 'boolean' ||
+    typeof value === 'bigint'
+  ) {
+    return String(value)
+  }
+  if (value === null) {
+    return 'null'
+  }
+  if (value instanceof Date) {
+    return Date.prototype.toString.call(value)
+  }
+  if (isSimpleValueArray(value)) {
+    return value.map(renderSimpleArrayItem).join(',')
+  }
+  return undefined
+}
+
+/** Formats a bounded validation reason without traversing or stringifying arbitrary objects. */
+export function formatSimpleValueReason(
+  reason: SimpleValueReason,
+  value: unknown,
+  maxCharacters: number,
+): string {
+  const suffix = reason.suffix ?? ''
+  if (reason.value === 'integer-prefix') {
+    const renderedValue = renderSimpleValueAsString(value)
+    if (renderedValue == null) {
+      return `${reason.message}${suffix}`
+    }
+
+    const parsedValue = Number.parseInt(renderedValue, 10)
+    const normalizedValue = Number.isFinite(parsedValue) ? String(parsedValue) : renderedValue
+    if (normalizedValue === '') {
+      return `${reason.message}${suffix}`
+    }
+    return `${reason.message}: ${truncateStringWithEllipsis(normalizedValue, maxCharacters)}${suffix}`
+  }
+
+  if (Array.isArray(value)) {
+    if (!isSimpleValueArray(value)) {
+      return `${reason.message}${suffix}`
+    }
+    const renderedValue = truncateCodePointsWithEllipsis(
+      renderSimpleArrayCharacters(value, reason.value === 'trimmed-string'),
+      maxCharacters,
+    )
+    return renderedValue === ''
+      ? `${reason.message}${suffix}`
+      : `${reason.message}: ${renderedValue}${suffix}`
+  }
+
+  const renderedValue = renderSimpleValueAsString(value)
+  if (renderedValue == null) {
+    return `${reason.message}${suffix}`
+  }
+
+  const normalizedValue = reason.value === 'trimmed-string' ? renderedValue.trim() : renderedValue
+  if (normalizedValue === '') {
+    return `${reason.message}${suffix}`
+  }
+
+  return `${reason.message}: ${truncateStringWithEllipsis(normalizedValue, maxCharacters)}${suffix}`
+}

package/src/alphalib/truncateString.ts

@@ -0,0 +1,23 @@
+/** Lazily truncates Unicode code points and marks a truncated value with an ellipsis. */
+export function truncateCodePointsWithEllipsis(
+  codePoints: Iterable<string>,
+  maxCharacters: number,
+): string {
+  if (!Number.isSafeInteger(maxCharacters) || maxCharacters < 0) {
+    throw new Error('String truncation requires a nonnegative safe character limit')
+  }
+
+  const characters: string[] = []
+  for (const character of codePoints) {
+    if (characters.length === maxCharacters) {
+      return `${characters.join('')}…`
+    }
+    characters.push(character)
+  }
+  return characters.join('')
+}
+
+/** Truncates a string by Unicode code points and marks a truncated value with an ellipsis. */
+export function truncateStringWithEllipsis(value: string, maxCharacters: number): string {
+  return truncateCodePointsWithEllipsis(value, maxCharacters)
+}

package/src/alphalib/types/builtinTemplates.ts

@@ -27,12 +27,14 @@ export type BuiltinTemplateDoc = z.infer<typeof builtinTemplateDocSchema>
 export const builtinTemplateFieldsSchema = z.record(z.string(), z.unknown()).nullable()
 
 /**
- * Runtime catalog projection used by Builtin clients. API2 supplies descriptions, field schemas
- * and defaults; absent and null schemas remain distinct, and neither declares a usable contract.
+ * Runtime catalog projection used by Builtin clients. API2 supplies descriptions, tool-ready
+ * summaries, field schemas and defaults; absent and null schemas remain distinct, and neither
+ * declares a usable contract.
  */
 export const builtinTemplateCatalogItemSchema = z.object({
   id: z.string(),
   description: z.string().optional(),
+  summary: z.string().optional(),
   fields_schema: builtinTemplateFieldsSchema.optional(),
   content: z.object({ fields: z.record(z.string(), z.unknown()).default({}) }),
 })
@@ -43,7 +45,8 @@ export type BuiltinTemplateCatalogItem = z.infer<typeof builtinTemplateCatalogIt
 /**
  * MCP channel approvals: exact reviewed versions and temporarily excluded field values.
  * Membership is explicit; a catalog schema, a new Builtin version, or Storage eligibility does
- * not grant MCP approval. Keep runtime descriptions, schemas and defaults in API2's catalog.
+ * not grant MCP approval. Keep runtime descriptions, summaries, schemas and defaults in API2's
+ * catalog.
  */
 export const mcpBuiltinTemplateManifest: Readonly<
   Record<string, Readonly<Record<string, readonly string[]>>>
@@ -76,3 +79,30 @@ export const mcpBuiltinInputUrlMaxCounts: Readonly<Record<string, number>> = {
   'builtin/transcribe@0.0.1': 10,
   'builtin/video-covers@0.0.1': 10,
 }
+
+/**
+ * Static summaries of the MCP-approved Builtins, for clients that describe them before reading
+ * API2's catalog, such as server cards and directory listings. API2 authors each `summary` beside
+ * its Builtin definition and serves the same text in the Template list; its tests keep this copy
+ * equal to those definitions, so edit the definition first.
+ */
+export const mcpBuiltinTemplateSummaries: Readonly<Record<string, string>> = {
+  'builtin/caption-video@0.0.1':
+    'Transcribe the speech in videos and burn plain captions into each original video. Returns the captioned video and its SRT captions. Fields set the caption font_size (default 16), position, font_color and border_color. The automatic provider detects the spoken language; target_language (such as french) hints it, and source_language (default en-US) sets it for provider aws or gcp. Captions are never translated.',
+  'builtin/capture-webpage@0.0.1':
+    'Capture a public HTTP(S) webpage (url) or an uploaded HTML file as a PNG, JPEG or PDF. Returns one image or PDF per captured page. Defaults to a full-page PNG 1024 pixels wide; set fullpage to false for a fixed width × height viewport, and use delay or wait_until for late-loading pages. A url takes precedence over uploaded HTML. No custom headers, credentials or browser actions are sent.',
+  'builtin/convert-to-pdf@0.0.1':
+    'Convert Office documents, HTML, Markdown and plain text files to PDF. Returns one PDF per input. Fields set the paper size (pdf_format, default Letter), pdf_margin, background printing, and the Markdown flavor and theme. Paper and margin fields apply to HTML and Markdown; Office and text files keep the converter’s native layout.',
+  'builtin/encode-video@0.0.1':
+    'Encode videos for web playback with an MP4 or WebM preset. Returns one encoded video per input. Defaults to the 720p MP4 preset with turbo encoding; width or height override that preset dimension. Output size depends on the source and preset.',
+  'builtin/extract-text@0.0.1':
+    'Extract text from images, PDFs and Office documents as plain text (default) or JSON. Returns one text result per input by default. Images use OCR; documents try embedded text before OCR, and Office files are converted to PDF first. Fields set text_method, the OCR provider (AWS or GCP), page_range, password and text_granularity, where page returns one result per page; those last three need native extraction. Unsupported formats are skipped.',
+  'builtin/prepare-image@0.0.1':
+    'Prepare images for a website: auto-orient, fit within 1600×1600 pixels without enlarging, encode as WebP at quality 75, strip metadata and keep transparency. Returns one image per input. Fields set width and height (w, h), format (f), quality (q), resize strategy (r), background color (bg) and metadata stripping (strip). JPEG output needs an opaque background.',
+  'builtin/remove-background@0.0.1':
+    'Remove the background from photos. Returns the foreground of each image as a transparent PNG. Fields set the provider (automatic by default); only provider transloadit also allows GIF or WebP output, or keeping the background instead of the foreground.',
+  'builtin/transcribe@0.0.1':
+    'Transcribe the speech in audio or video files. Returns one transcript per input as timestamped JSON (default), plain text, SRT or WebVTT. The automatic provider detects the spoken language; target_language (such as french) hints it, and source_language (default en-US) sets it for provider aws or gcp. Transcripts are never translated.',
+  'builtin/video-covers@0.0.1':
+    'Extract cover images from videos. Returns 8 JPEG frames per video by default, taken at regular intervals, or frames at exact offsets in seconds or percentages. Set smart to true to have AI scoring pick the strongest count frames from up to three candidates per frame, capped by smart_max_candidates but never fewer than count. Fields also set format (JPEG or PNG), width and height, which default to the video’s dimensions.',
+}