@beam-network/sdk 0.8.0 → 0.9.0

package/README.md

@@ -169,7 +169,9 @@ Constraints, all of them the Hub's rather than Beam's — see
   Hub file, set `allow_source_rehash: true` to let the SDK read the source once to
   compute it.
 - **One source per Hugging Face destination**, because the Hub dictates the part
-  size and a plan carries a single chunk size.
+  size and a plan carries a single chunk size. The SDK sends that part size to
+  Beam as `provider_part_size`; Beam chooses the chunk size of every other
+  transfer.
 - If you do not call `waitForTransfer`, call `finalizeHuggingFaceUploads(transferId)`
   yourself once the transfer completes — without it the parts are uploaded but no
   commit is made and the file does not appear in the repo.

package/dist/client.d.ts

@@ -60,7 +60,6 @@ type TransferPrepareInput = {
     signedUrlFlow?: SignedUrlFlow;
     idempotencyKey?: string;
     routeGenerationId?: string;
-    chunkSize?: number;
 };
 export declare class BeamClient {
     readonly apiKey: string;
@@ -126,7 +125,6 @@ export declare class BeamClient {
         name?: string;
         urlsExpiresAt?: string;
         signedUrlFlow?: SignedUrlFlow;
-        chunkSize?: number;
     }): Promise<TransferPlanResponse>;
     /**
      * Prepares a transfer from already-signed HTTP sources and destinations (`transfer.prepare`).
@@ -168,7 +166,8 @@ export declare class BeamClient {
      * Negotiate every Hugging Face destination before the plan exists.
      *
      * The Hub will not issue upload URLs without the object's sha256, and it chooses the part
-     * size itself, so this runs first and the plan is then requested at the Hub's chunk size.
+     * size itself, so this runs first and the prepare request then carries the Hub's part size
+     * as `provider_part_size`.
      */
     private planHuggingFaceUploads;
     /** Fail before any byte moves if BeamCore did not adopt the Hub's part layout. */

package/dist/client.js

@@ -157,7 +157,6 @@ export class BeamClient {
             sources: input.sources,
             destinations: input.destinations,
             total_size: input.totalSize,
-            chunk_size: input.chunkSize,
             name: input.name,
             merkle_root: input.merkleRoot,
             chunk_hashes: input.chunkHashes,
@@ -244,7 +243,6 @@ export class BeamClient {
             sources: input.sources,
             destinations: input.destinations,
             name: input.name,
-            chunk_size: input.chunkSize,
             urls_expires_at: input.urlsExpiresAt,
             signed_url_flow: input.signedUrlFlow ?? "signed_url"
         }));
@@ -263,10 +261,10 @@ export class BeamClient {
     prepareTransfer(input) {
         return this.prepareTransferWithRequestKey(input);
     }
-    async prepareTransferWithRequestKey(input, requestKey) {
+    async prepareTransferWithRequestKey(input, options = {}) {
         const transferId = input.transferId ?? await transferIdForIdempotencyKey(input.idempotencyKey);
         validateId(transferId, "transferId");
-        const prepareIdempotencyKey = requestKey ?? `transfer:${transferId}:prepare`;
+        const prepareIdempotencyKey = options.requestKey ?? `transfer:${transferId}:prepare`;
         const routeGenerationId = input.routeGenerationId ?? await routeGenerationIdForPrepareIdempotencyKey(prepareIdempotencyKey);
         const result = await this.control.request("transfer.prepare", compact({
             transfer_id: transferId,
@@ -274,7 +272,7 @@ export class BeamClient {
             sources: input.sources,
             destinations: input.destinations,
             name: input.name,
-            chunk_size: input.chunkSize,
+            provider_part_size: options.providerPartSize,
             urls_expires_at: input.urlsExpiresAt,
             signed_url_flow: input.signedUrlFlow ?? "signed_url"
         }), {
@@ -411,13 +409,13 @@ export class BeamClient {
             sources: preparedSources,
             destinations: preparedDestinations,
             name: input.name,
-            chunkSize: huggingFace.chunkSize ?? input.chunkSize,
             signedUrlFlow: requestedSignedUrlFlow,
             ...(resume ? { transferId: resume.transferId } : { idempotencyKey: input.idempotencyKey, routeGenerationId: input.routeGenerationId })
         };
-        const prepared = resume
-            ? await this.prepareTransferWithRequestKey(prepareInput, `transfer:${resume.transferId}:prepare:resume:${randomUuid()}`)
-            : await this.prepareTransfer(prepareInput);
+        const prepared = await this.prepareTransferWithRequestKey(prepareInput, {
+            requestKey: resume ? `transfer:${resume.transferId}:prepare:resume:${randomUuid()}` : undefined,
+            providerPartSize: huggingFace.providerPartSize
+        });
         if (resume && prepared.transfer_id !== resume.transferId)
             throw new Error("resumed provider transfer id mismatch");
         input.signal?.throwIfAborted();
@@ -704,7 +702,8 @@ export class BeamClient {
      * Negotiate every Hugging Face destination before the plan exists.
      *
      * The Hub will not issue upload URLs without the object's sha256, and it chooses the part
-     * size itself, so this runs first and the plan is then requested at the Hub's chunk size.
+     * size itself, so this runs first and the prepare request then carries the Hub's part size
+     * as `provider_part_size`.
      */
     async planHuggingFaceUploads(input) {
         const targets = input.destinations
@@ -723,7 +722,7 @@ export class BeamClient {
             ? typeof preparedSource.metadata?.sha256 === "string" ? preparedSource.metadata.sha256 : undefined
             : undefined;
         const states = [];
-        let chunkSize;
+        let providerPartSize;
         for (const { destination, index } of targets) {
             const preparedDestination = input.preparedDestinations[index];
             if ((destination.repo_type ?? "model") === "bucket") {
@@ -761,11 +760,11 @@ export class BeamClient {
                 size: preparedSource.size
             });
             if (plan.upload?.chunkSize !== undefined) {
-                if (chunkSize !== undefined && chunkSize !== plan.upload.chunkSize) {
-                    throw new Error(`huggingface destinations disagree on part size (${chunkSize} vs ${plan.upload.chunkSize}); `
+                if (providerPartSize !== undefined && providerPartSize !== plan.upload.chunkSize) {
+                    throw new Error(`huggingface destinations disagree on part size (${providerPartSize} vs ${plan.upload.chunkSize}); `
                         + "the plan carries a single chunk size");
                 }
-                chunkSize = plan.upload.chunkSize;
+                providerPartSize = plan.upload.chunkSize;
             }
             states.push({
                 destination: config,
@@ -786,7 +785,7 @@ export class BeamClient {
                     }).then((hashed) => hashed.partEtags)
             });
         }
-        return { states, chunkSize };
+        return { states, providerPartSize };
     }
     /** Fail before any byte moves if BeamCore did not adopt the Hub's part layout. */
     assertHuggingFacePlan(prepared, states) {

package/dist/models.d.ts

@@ -84,7 +84,6 @@ export interface TransferCreateRequest {
     sources: SourceConfig[];
     destinations: DestConfig[];
     total_size: number;
-    chunk_size?: number;
     name?: string;
     merkle_root?: string;
     chunk_hashes?: string[];
@@ -96,7 +95,6 @@ export interface RawTransferCreateInput {
     sources: SourceConfig[];
     destinations: DestConfig[];
     totalSize: number;
-    chunkSize?: number;
     name?: string;
     merkleRoot?: string;
     chunkHashes?: string[];
@@ -443,8 +441,6 @@ export interface ProviderTransferCreateInput {
     idempotencyKey?: string;
     /** Internal recovery generation; callers normally omit this. */
     routeGenerationId?: string;
-    /** Requested plan chunk size. BeamCore may raise it; the response carries the effective value. */
-    chunkSize?: number;
 }
 export interface ProviderMultipartGroupIdentity {
     transferId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@beam-network/sdk",
-    "version": "0.8.0",
+    "version": "0.9.0",
     "description": "TypeScript SDK for BEAM transfer creation and management.",
     "type": "module",
     "license": "MIT",