@aws-sdk/lib-transfer-manager 0.0.0-stage → 0.1.0

package/dist-types/ts3.4/submodules/transfer-manager/types.d.ts

@@ -0,0 +1,184 @@
+import {
+  _Object as S3Object,
+  CompleteMultipartUploadCommandOutput,
+  CreateMultipartUploadCommandInput,
+  GetObjectCommandInput,
+  GetObjectCommandOutput,
+  PutObjectCommandInput,
+  PutObjectCommandOutput,
+  S3Client,
+} from "@aws-sdk/client-s3";
+import { HttpHandlerOptions, Logger } from "@smithy/types";
+import {
+  AddEventListenerOptions,
+  EventListener,
+  RemoveEventListenerOptions,
+} from "./event-listener-types";
+export interface S3TransferManagerConfig {
+  s3?: S3Client;
+  targetPartSizeBytes?: number;
+  multipartUploadThresholdBytes?: number;
+  requestChecksumCalculation?: "WHEN_SUPPORTED" | "WHEN_REQUIRED";
+  responseChecksumValidation?: "WHEN_SUPPORTED" | "WHEN_REQUIRED";
+  multipartDownloadType?: "RANGE" | "PART";
+  eventListeners?: TransferEventListeners;
+  maxConcurrentDownloads?: number;
+  maxConcurrentUploads?: number;
+  workerThreadCount?: number;
+  useODirect?: boolean;
+  logger?: Logger;
+}
+export type UploadRequest = PutObjectCommandInput & CreateMultipartUploadCommandInput;
+export type UploadResponse = PutObjectCommandOutput | CompleteMultipartUploadCommandOutput;
+export type DownloadRequest = GetObjectCommandInput;
+export type DownloadResponse = GetObjectCommandOutput;
+export interface DownloadToFileRequest extends DownloadRequest {
+  destination: string;
+  failIfExists?: boolean;
+}
+export interface DownloadToFileResponse extends Pick<
+  DownloadResponse,
+  Exclude<keyof DownloadResponse, "Body">
+> {
+  bytesWritten: number;
+}
+export type TransferOptions = HttpHandlerOptions & {
+  eventListeners?: TransferEventListeners;
+};
+export interface IS3TransferManager {
+  upload(request: UploadRequest, transferOptions?: TransferOptions): Promise<UploadResponse>;
+  download(request: DownloadRequest, transferOptions?: TransferOptions): Promise<DownloadResponse>;
+  downloadToFile(
+    request: DownloadToFileRequest,
+    transferOptions?: TransferOptions,
+  ): Promise<DownloadToFileResponse>;
+  uploadDirectory(
+    request: UploadDirectoryRequest,
+    transferOptions?: TransferOptions,
+  ): Promise<UploadDirectoryResponse>;
+  downloadDirectory(
+    request: DownloadDirectoryRequest,
+    transferOptions?: TransferOptions,
+  ): Promise<DownloadDirectoryResponse>;
+  addEventListener(
+    type: "transferInitiated",
+    callback: EventListener<TransferEvent>,
+    options?: AddEventListenerOptions | boolean,
+  ): void;
+  addEventListener(
+    type: "bytesTransferred",
+    callback: EventListener<TransferEvent>,
+    options?: AddEventListenerOptions | boolean,
+  ): void;
+  addEventListener(
+    type: "transferComplete",
+    callback: EventListener<TransferCompleteEvent>,
+    options?: AddEventListenerOptions | boolean,
+  ): void;
+  addEventListener(
+    type: "transferFailed",
+    callback: EventListener<TransferEvent>,
+    options?: AddEventListenerOptions | boolean,
+  ): void;
+  addEventListener(
+    type: string,
+    callback: EventListener,
+    options?: AddEventListenerOptions | boolean,
+  ): void;
+  dispatchEvent(event: Event & TransferEvent): boolean;
+  dispatchEvent(event: Event & TransferCompleteEvent): boolean;
+  dispatchEvent(event: Event): boolean;
+  removeEventListener(
+    type: "transferInitiated",
+    callback: EventListener<TransferEvent>,
+    options?: RemoveEventListenerOptions | boolean,
+  ): void;
+  removeEventListener(
+    type: "bytesTransferred",
+    callback: EventListener<TransferEvent>,
+    options?: RemoveEventListenerOptions | boolean,
+  ): void;
+  removeEventListener(
+    type: "transferComplete",
+    callback: EventListener<TransferCompleteEvent>,
+    options?: RemoveEventListenerOptions | boolean,
+  ): void;
+  removeEventListener(
+    type: "transferFailed",
+    callback: EventListener<TransferEvent>,
+    options?: RemoveEventListenerOptions | boolean,
+  ): void;
+  removeEventListener(
+    type: string,
+    callback: EventListener,
+    options?: RemoveEventListenerOptions | boolean,
+  ): void;
+}
+export interface SingleObjectProgressSnapshot {
+  transferredBytes: number;
+  totalBytes?: number;
+  response?: UploadResponse | DownloadResponse;
+}
+export interface DirectoryProgressSnapshot {
+  transferredBytes: number;
+  totalBytes?: number;
+  transferredFiles: number;
+  totalFiles?: number;
+}
+export type TransferProgressSnapshot = SingleObjectProgressSnapshot | DirectoryProgressSnapshot;
+export interface TransferEvent extends Event {
+  request: UploadRequest | DownloadRequest;
+  snapshot: TransferProgressSnapshot;
+}
+export interface TransferCompleteEvent extends TransferEvent {
+  response: UploadResponse | DownloadResponse;
+}
+export interface TransferEventListeners {
+  transferInitiated?: EventListener<TransferEvent>[];
+  bytesTransferred?: EventListener<TransferEvent>[];
+  transferComplete?: EventListener<TransferCompleteEvent>[];
+  transferFailed?: EventListener<TransferEvent>[];
+}
+export interface JoinStreamIterationEvents {
+  onBytes?: (byteLength: number, index: number) => void;
+  onCompletion?: (byteLength: number, index: number) => void;
+  onFailure?: (error: unknown, index: number) => void;
+  onStreamConsumed?: (index: number) => void;
+}
+export type CannedFailurePolicy = "terminate" | "continue";
+export interface DirectoryTransferFailureContext {
+  request: UploadDirectoryRequest | DownloadDirectoryRequest;
+  objectRequest: PutObjectCommandInput | GetObjectCommandInput;
+  error: unknown;
+}
+export type FailurePolicy =
+  | CannedFailurePolicy
+  | ((context: DirectoryTransferFailureContext) => Promise<CannedFailurePolicy>);
+export interface UploadDirectoryRequest {
+  bucket: string;
+  source: string;
+  followSymbolicLinks?: boolean;
+  recursive?: boolean;
+  s3Prefix?: string;
+  filter?: ((filePath: string) => boolean) | RegExp;
+  uploadObjectRequestModifier?: (request: PutObjectCommandInput) => PutObjectCommandInput;
+  failurePolicy?: FailurePolicy;
+  maxConcurrency?: number;
+}
+export interface UploadDirectoryResponse {
+  objectsUploaded: number;
+  objectsFailed: number;
+}
+export interface DownloadDirectoryRequest {
+  bucket: string;
+  destination: string;
+  s3Prefix?: string;
+  filter?: ((object: S3Object) => boolean) | RegExp;
+  downloadObjectRequestModifier?: (request: GetObjectCommandInput) => GetObjectCommandInput;
+  failurePolicy?: FailurePolicy;
+  maxConcurrency?: number;
+}
+export interface DownloadDirectoryResponse {
+  objectsDownloaded: number;
+  objectsFailed: number;
+}

package/dist-types/ts3.4/submodules/transfer-manager/worker-http-handler.browser.d.ts

@@ -0,0 +1,17 @@
+export type DataSource = any;
+export declare function defaultWorkerCount(): number;
+export declare function createEmptyReadable(): any;
+export declare class WorkerHttpHandler {
+  constructor();
+  handle(): Promise<any>;
+  updateHttpClientConfig(): void;
+  httpHandlerConfigs(): Record<string, unknown>;
+  getDownloadResult():
+    | {
+        bytesWritten: number;
+        checksum?: string;
+      }
+    | undefined;
+  getStreamDownloadResult(): any;
+  destroy(): void;
+}

package/dist-types/ts3.4/submodules/transfer-manager/worker-http-handler.d.ts

@@ -0,0 +1,241 @@
+import { HttpResponse } from "@smithy/core/protocols";
+import {
+  HttpHandlerOptions,
+  HttpRequest,
+  HttpResponse as HttpResponseShape,
+  Logger,
+} from "@smithy/types";
+import { ChecksumAlgorithm } from "@aws-sdk/client-s3";
+import { Readable } from "node:stream";
+export declare function createEmptyReadable(): Readable;
+export interface WorkerHttpRequest extends Pick<HttpRequest, Exclude<keyof HttpRequest, "body">> {
+  body?: Uint8Array;
+}
+export interface WorkerHttpResponse extends Pick<
+  HttpResponseShape,
+  Exclude<keyof HttpResponseShape, "body">
+> {
+  body?: Uint8Array;
+}
+interface BaseHttpWorkerRequestMessage {
+  id: number;
+  request: WorkerHttpRequest;
+}
+export interface HttpWorkerFileRequestMessage extends BaseHttpWorkerRequestMessage {
+  type: "httpRequestFromFile";
+  filePath: string;
+  offset: number;
+  length: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+  checksumHeader?: string;
+}
+export interface HttpWorkerRAMRequestMessage extends BaseHttpWorkerRequestMessage {
+  type: "httpRequestFromRAM";
+  sharedBuffer: SharedArrayBuffer;
+  offset: number;
+  length: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+  checksumHeader?: string;
+}
+export type HttpWorkerRequestMessage = HttpWorkerFileRequestMessage | HttpWorkerRAMRequestMessage;
+export interface HttpWorkerDownloadToFileMessage extends BaseHttpWorkerRequestMessage {
+  type: "httpDownloadToFile";
+  filePath: string;
+  offset: number;
+  expectedLength: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+}
+export interface HttpWorkerDownloadStreamMessage extends BaseHttpWorkerRequestMessage {
+  type: "httpDownloadStream";
+  expectedSize: number;
+  rangeIndex: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+}
+export interface HttpWorkerReturnBufferMessage {
+  type: "returnBuffer";
+  buffer: ArrayBuffer;
+}
+export interface HttpWorkerConfigMessage {
+  type: "config";
+  maxSockets: number;
+  useODirect?: boolean;
+}
+export interface HttpWorkerDoneMessage {
+  type: "done";
+}
+export type HttpWorkerInboundMessage =
+  | HttpWorkerRequestMessage
+  | HttpWorkerDownloadToFileMessage
+  | HttpWorkerDownloadStreamMessage
+  | HttpWorkerReturnBufferMessage
+  | HttpWorkerConfigMessage
+  | HttpWorkerDoneMessage;
+export interface HttpWorkerResponseMessage {
+  type: "httpResponse";
+  id: number;
+  response: WorkerHttpResponse;
+}
+export interface HttpWorkerErrorMessage {
+  type: "httpError";
+  id: number;
+  error: string;
+  code?: string;
+  name?: string;
+}
+export interface HttpWorkerReadyMessage {
+  type: "ready";
+}
+export interface HttpWorkerLogMessage {
+  type: "workerLog";
+  level: "warn" | "debug" | "trace";
+  message: string;
+}
+export interface HttpWorkerDownloadResultMessage {
+  type: "httpDownloadResult";
+  id: number;
+  statusCode: number;
+  headers: Record<string, string>;
+  bytesWritten: number;
+  checksum?: string;
+}
+export interface HttpWorkerDownloadErrorMessage {
+  type: "httpDownloadError";
+  id: number;
+  error: string;
+  code?: string;
+  name?: string;
+}
+export interface HttpWorkerDownloadHttpErrorMessage {
+  type: "httpDownloadHttpError";
+  id: number;
+  statusCode: number;
+  headers: Record<string, string>;
+  body?: Uint8Array;
+}
+export interface HttpWorkerDownloadStreamResultMessage {
+  type: "httpDownloadStreamResult";
+  id: number;
+  rangeIndex: number;
+  buffer: ArrayBuffer;
+  byteLength: number;
+  statusCode: number;
+  headers: Record<string, string>;
+  checksum?: string;
+}
+export type HttpWorkerOutboundMessage =
+  | HttpWorkerResponseMessage
+  | HttpWorkerErrorMessage
+  | HttpWorkerReadyMessage
+  | HttpWorkerLogMessage
+  | HttpWorkerDownloadResultMessage
+  | HttpWorkerDownloadErrorMessage
+  | HttpWorkerDownloadHttpErrorMessage
+  | HttpWorkerDownloadStreamResultMessage;
+export declare function defaultWorkerCount(): number;
+export interface FileSource {
+  type: "file";
+  filePath: string;
+  partSize: number;
+  totalFileSize: number;
+  startOffset?: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+  checksumHeader?: string;
+}
+export interface SharedBufferSource {
+  type: "sharedBuffer";
+  sharedBuffer: SharedArrayBuffer;
+  startOffset?: number;
+  partSize: number;
+  totalSize: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+  checksumHeader?: string;
+}
+export type DataSource = FileSource | SharedBufferSource;
+export interface WorkerHttpHandlerOptions extends HttpHandlerOptions {
+  dataSource?: DataSource;
+}
+export interface DownloadDataToFile {
+  filePath: string;
+  offset: number;
+  expectedLength: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+  resultToken?: string;
+}
+export interface DownloadStreamOptions {
+  expectedSize: number;
+  rangeIndex: number;
+  checksumAlgorithm?: ChecksumAlgorithm;
+  resultToken?: string;
+}
+export interface WorkerHttpHandlerDownloadOptions extends HttpHandlerOptions {
+  downloadDataToFile?: DownloadDataToFile;
+  downloadStream?: DownloadStreamOptions;
+}
+export interface DownloadToFileResult {
+  statusCode: number;
+  headers: Record<string, string>;
+  bytesWritten: number;
+  checksum?: string;
+  errorBody?: Uint8Array;
+}
+export interface DownloadStreamResult {
+  rangeIndex: number;
+  buffer: ArrayBuffer;
+  byteLength: number;
+  statusCode: number;
+  headers: Record<string, string>;
+  checksum?: string;
+  errorBody?: Uint8Array;
+}
+export declare class WorkerHttpHandler {
+  private workers;
+  private inflightRequests;
+  private inflightDownloads;
+  private inflightStreamDownloads;
+  private nextRequestId;
+  private workerInflightCounts;
+  private workerThreadCount;
+  private maxConcurrentUploads;
+  private maxConcurrentDownloads;
+  private useODirect;
+  private logger;
+  private initialized;
+  private initPromise;
+  private fallbackHandler;
+  private completedDownloads;
+  private completedTransfers;
+  readonly metadata: {
+    handlerProtocol: string;
+  };
+  constructor(options?: {
+    workerThreadCount?: number;
+    maxConcurrentUploads?: number;
+    maxConcurrentDownloads?: number;
+    useODirect?: boolean;
+    logger?: Logger;
+  });
+  getDownloadResult(token: string):
+    | {
+        bytesWritten: number;
+        checksum?: string;
+      }
+    | undefined;
+  getStreamDownloadResult(token: string): DownloadStreamResult | undefined;
+  private resolveWorkerConfig;
+  private ensureInitialized;
+  private pickWorkerIndex;
+  private dispatchToWorker;
+  private dispatchDownloadToWorker;
+  private extractPartNumber;
+  returnBuffer(buffer: ArrayBuffer, workerIndex?: number): void;
+  handle(
+    request: HttpRequest,
+    options?: WorkerHttpHandlerOptions | WorkerHttpHandlerDownloadOptions,
+  ): Promise<{
+    response: HttpResponse;
+  }>;
+  updateHttpClientConfig(_key: string, _value: unknown): void;
+  httpHandlerConfigs(): Record<string, unknown>;
+  destroy(): void;
+}
+export {};

package/dist-types/ts3.4/submodules/worker/http-request-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/dist-types/ts3.4/submodules/worker/index.d.ts

@@ -0,0 +1 @@
+import "./http-request-worker";

package/package.json

@@ -1,6 +1,110 @@
 {
   "name": "@aws-sdk/lib-transfer-manager",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "S3 Transfer Manager for AWS SDK JS v3",
+  "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/preview/lib-transfer-manager",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "AWS SDK for JavaScript Team",
+    "url": "https://aws.amazon.com/javascript/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aws/aws-sdk-js-v3.git",
+    "directory": "preview/lib-transfer-manager"
+  },
+  "files": [
+    "./transfer-manager.d.ts",
+    "./transfer-manager.js",
+    "./worker.d.ts",
+    "./worker.js",
+    "dist-*/**"
+  ],
+  "main": "./dist-cjs/index.js",
+  "module": "./dist-es/index.js",
+  "browser": {
+    "./dist-es/submodules/transfer-manager/index.js": "./dist-es/submodules/transfer-manager/index.browser.js"
+  },
+  "types": "./dist-types/index.d.ts",
+  "typesVersions": {
+    "<4.5": {
+      "dist-types/*": [
+        "dist-types/ts3.4/*"
+      ],
+      "*": [
+        "dist-types/ts3.4/submodules/*/index.d.ts"
+      ]
+    }
+  },
+  "react-native": {
+    "./dist-es/submodules/transfer-manager/index.js": "./dist-es/submodules/transfer-manager/index.browser.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist-types/index.d.ts",
+      "module": "./dist-es/index.js",
+      "node": "./dist-cjs/index.js",
+      "import": "./dist-es/index.js",
+      "require": "./dist-cjs/index.js"
+    },
+    "./worker": {
+      "types": "./dist-types/submodules/worker/index.d.ts",
+      "module": "./dist-es/submodules/worker/index.js",
+      "node": "./dist-cjs/submodules/worker/index.js",
+      "import": "./dist-es/submodules/worker/index.js",
+      "require": "./dist-cjs/submodules/worker/index.js"
+    },
+    "./transfer-manager": {
+      "types": "./dist-types/submodules/transfer-manager/index.d.ts",
+      "react-native": "./dist-es/submodules/transfer-manager/index.browser.js",
+      "browser": "./dist-es/submodules/transfer-manager/index.browser.js",
+      "module": "./dist-es/submodules/transfer-manager/index.js",
+      "node": "./dist-cjs/submodules/transfer-manager/index.js",
+      "import": "./dist-es/submodules/transfer-manager/index.js",
+      "require": "./dist-cjs/submodules/transfer-manager/index.js"
+    }
+  },
+  "publishConfig": {
+    "tag": "preview"
+  },
+  "scripts": {
+    "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
+    "build:cjs": "node ../../scripts/compilation/inline lib-transfer-manager",
+    "build:es": "premove dist-es && tsc -p tsconfig.es.json",
+    "build:include:deps": "yarn g:turbo run build -F=\"$npm_package_name\"",
+    "build:types": "premove dist-types && tsc -p tsconfig.types.json",
+    "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
+    "clean": "premove dist-cjs dist-es dist-types",
+    "lint": "node ../../scripts/validation/submodules-linter",
+    "prebuild": "yarn lint",
+    "test": "yarn g:vitest run",
+    "test:watch": "yarn g:vitest watch",
+    "test:e2e": "yarn g:vitest run -c vitest.config.e2e.mts --mode development",
+    "test:e2e:watch": "yarn g:vitest watch -c vitest.config.e2e.mts",
+    "test:browser": "yarn g:vitest run -c vitest.config.browser.mts",
+    "test:browser:watch": "yarn g:vitest watch -c vitest.config.browser.mts"
+  },
+  "dependencies": {
+    "@aws-sdk/checksums": "^3.1001.3",
+    "@smithy/core": "^3.35.2",
+    "@smithy/node-http-handler": "^4.12.1",
+    "@smithy/types": "^4.19.0",
+    "tslib": "^2.6.2"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "3.1152.0",
+    "@aws-sdk/xhr-http-handler": "3.1152.0",
+    "@tsconfig/recommended": "1.0.1",
+    "@types/node": "^20.14.8",
+    "concurrently": "7.0.0",
+    "downlevel-dts": "0.10.1",
+    "premove": "4.0.0",
+    "typescript": "~7.0.2"
+  },
+  "peerDependencies": {
+    "@aws-sdk/client-s3": "^3.1152.0"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}

package/transfer-manager.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Do not edit:
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
+ */
+export * from "./dist-types/submodules/transfer-manager/index";

package/transfer-manager.js

@@ -0,0 +1,5 @@
+/**
+ * Do not edit:
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
+ */
+module.exports = require("./dist-cjs/submodules/transfer-manager/index.js");

package/worker.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Do not edit:
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
+ */
+export * from "./dist-types/submodules/worker/index";

package/worker.js

@@ -0,0 +1,5 @@
+/**
+ * Do not edit:
+ * This is a compatibility redirect for contexts that do not understand package.json exports field.
+ */
+module.exports = require("./dist-cjs/submodules/worker/index.js");