lean-s3 0.6.3 → 0.7.0

package/dist/index.d.ts

@@ -39,8 +39,11 @@ interface S3ClientOptions {
     secretAccessKey: string;
     sessionToken?: string;
 }
-type OverridableS3ClientOptions = Pick<S3ClientOptions, "region" | "bucket" | "endpoint">;
-type CreateFileInstanceOptions = {};
+type OverridableS3ClientOptions = Partial<Pick<S3ClientOptions, "region" | "bucket" | "endpoint">>;
+type CreateFileInstanceOptions = {
+    /** Content-Type of the file. */
+    type?: string;
+};
 type DeleteObjectsOptions = {
     bucket?: string;
     signal?: AbortSignal;
@@ -55,13 +58,15 @@ type DeleteObjectsError = {
     versionId: string;
 };
 interface S3FilePresignOptions {
-    contentHash: Buffer;
+    contentHash?: Buffer;
     /** Seconds. */
-    expiresIn: number;
-    method: PresignableHttpMethod;
-    contentLength: number;
-    storageClass: StorageClass;
-    acl: Acl;
+    expiresIn?: number;
+    method?: PresignableHttpMethod;
+    contentLength?: number;
+    storageClass?: StorageClass;
+    acl?: Acl;
+    /** `Content-Type` of the file. */
+    type?: string;
 }
 type ListObjectsOptions = {
     bucket?: string;
@@ -261,11 +266,6 @@ declare class S3Client {
      * @param  options The default options to use for the S3 client.
      */
     constructor(options: S3ClientOptions);
-    cors: {
-        get: () => void;
-        set: () => void;
-        delete: () => void;
-    };
     /**
      * Creates an S3File instance for the given path.
      *
@@ -289,7 +289,6 @@ declare class S3Client {
      *
      * lean-s3 does not enforce these restrictions.
      *
-     * @param {Partial<CreateFileInstanceOptions>} [_options] TODO
      * @example
      * ```js
      * const file = client.file("image.jpg");
@@ -297,11 +296,10 @@ declare class S3Client {
      *
      * const configFile = client.file("config.json", {
      *   type: "application/json",
-     *   acl: "private"
      * });
      * ```
      */
-    file(path: string, _options?: Partial<CreateFileInstanceOptions>): S3File;
+    file(path: string, options?: CreateFileInstanceOptions): S3File;
     /**
      * Generate a presigned URL for temporary access to a file.
      * Useful for generating upload/download URLs without exposing credentials.
@@ -315,7 +313,7 @@ declare class S3Client {
      * ```
      */
     presign(path: string, { method, expiresIn, // TODO: Maybe rename this to expiresInSeconds
-    storageClass, contentLength, acl, region: regionOverride, bucket: bucketOverride, endpoint: endpointOverride, }?: Partial<S3FilePresignOptions & OverridableS3ClientOptions>): string;
+    storageClass, contentLength, type, acl, region: regionOverride, bucket: bucketOverride, endpoint: endpointOverride, }?: S3FilePresignOptions & OverridableS3ClientOptions): string;
     createMultipartUpload(key: string, options?: CreateMultipartUploadOptions): Promise<CreateMultipartUploadResult>;
     /**
      * @remarks Uses [`ListMultipartUploads`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html).
@@ -431,6 +429,10 @@ declare class S3Stat {
     static tryParseFromHeaders(headers: Record<string, string | string[] | undefined>): S3Stat | undefined;
 }
 
+type S3FileWriteOptions = {
+    /** Content-Type of the file. */
+    type?: string;
+};
 declare class S3File {
     #private;
     /** @internal */
@@ -443,20 +445,20 @@ declare class S3File {
      * @throws {S3Error} If the file does not exist or the server has some other issues.
      * @throws {Error} If the server returns an invalid response.
      */
-    stat(options?: Partial<S3StatOptions>): Promise<S3Stat>;
+    stat(options?: S3StatOptions): Promise<S3Stat>;
     /**
      * Check if a file exists in the bucket. Uses `HEAD` request to check existence.
      *
      * @remarks Uses [`HeadObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html).
      */
-    exists(options?: Partial<S3FileExistsOptions>): Promise<boolean>;
+    exists(options?: S3FileExistsOptions): Promise<boolean>;
     /**
      * Delete a file from the bucket.
      *
      * @remarks - Uses [`DeleteObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html).
      *          - `versionId` not supported.
      *
-     * @param {Partial<S3FileDeleteOptions>} [options]
+     * @param {S3FileDeleteOptions} [options]
      *
      * @example
      * ```js
@@ -472,7 +474,7 @@ declare class S3File {
      * }
      * ```
      */
-    delete(options?: Partial<S3FileDeleteOptions>): Promise<void>;
+    delete(options?: S3FileDeleteOptions): Promise<void>;
     toString(): string;
     json(): Promise<unknown>;
     bytes(): Promise<Uint8Array>;
@@ -483,18 +485,19 @@ declare class S3File {
     stream(): ReadableStream<Uint8Array>;
     /**
      * @param {ByteSource} data
+     * @param {S3FileWriteOptions} [options.type] Defaults to the Content-Type that was used to create the {@link S3File} instance.
      * @returns {Promise<void>}
      */
-    write(data: ByteSource): Promise<void>;
+    write(data: ByteSource, options?: S3FileWriteOptions): Promise<void>;
 }
 interface S3FileDeleteOptions extends OverridableS3ClientOptions {
-    signal: AbortSignal;
+    signal?: AbortSignal;
 }
 interface S3StatOptions extends OverridableS3ClientOptions {
-    signal: AbortSignal;
+    signal?: AbortSignal;
 }
 interface S3FileExistsOptions extends OverridableS3ClientOptions {
-    signal: AbortSignal;
+    signal?: AbortSignal;
 }
 
 declare class S3Error extends Error {
@@ -536,4 +539,4 @@ type BucketInfo = {
     type?: string;
 };
 
-export { type AbortMultipartUploadOptions, type Acl, type BucketCorsRule, type BucketCorsRules, type BucketCreationOptions, type BucketDeletionOptions, type BucketExistsOptions, type BucketInfo, type BucketLocationInfo, type ByteSource, type ChecksumAlgorithm, type ChecksumType, type CompleteMultipartUploadOptions, type CompleteMultipartUploadResult, type CreateFileInstanceOptions, type CreateMultipartUploadOptions, type CreateMultipartUploadResult, type DeleteObjectsError, type DeleteObjectsOptions, type DeleteObjectsResult, type GetBucketCorsOptions, type GetBucketCorsResult, type HttpMethod, type ListMultipartUploadsOptions, type ListMultipartUploadsResult, type ListObjectsIteratingOptions, type ListObjectsOptions, type ListObjectsResult, type ListPartsOptions, type ListPartsResult, type MultipartUpload, type MultipartUploadPart, type OverridableS3ClientOptions, type PresignableHttpMethod, type PutBucketCorsOptions, S3BucketEntry, S3Client, type S3ClientOptions, S3Error, type S3ErrorOptions, S3File, type S3FileDeleteOptions, type S3FileExistsOptions, type S3FilePresignOptions, S3Stat, type S3StatOptions, type StorageClass, type UndiciBodyInit, type UploadPartOptions, type UploadPartResult };
+export { type AbortMultipartUploadOptions, type Acl, type BucketCorsRule, type BucketCorsRules, type BucketCreationOptions, type BucketDeletionOptions, type BucketExistsOptions, type BucketInfo, type BucketLocationInfo, type ByteSource, type ChecksumAlgorithm, type ChecksumType, type CompleteMultipartUploadOptions, type CompleteMultipartUploadResult, type CreateFileInstanceOptions, type CreateMultipartUploadOptions, type CreateMultipartUploadResult, type DeleteBucketCorsOptions, type DeleteObjectsError, type DeleteObjectsOptions, type DeleteObjectsResult, type GetBucketCorsOptions, type GetBucketCorsResult, type HttpMethod, type ListMultipartUploadsOptions, type ListMultipartUploadsResult, type ListObjectsIteratingOptions, type ListObjectsOptions, type ListObjectsResult, type ListPartsOptions, type ListPartsResult, type MultipartUpload, type MultipartUploadPart, type OverridableS3ClientOptions, type PresignableHttpMethod, type PutBucketCorsOptions, S3BucketEntry, S3Client, type S3ClientOptions, S3Error, type S3ErrorOptions, S3File, type S3FileDeleteOptions, type S3FileExistsOptions, type S3FilePresignOptions, type S3FileWriteOptions, S3Stat, type S3StatOptions, type StorageClass, type UndiciBodyInit, type UploadPartOptions, type UploadPartResult };

package/dist/index.js

@@ -404,14 +404,20 @@ var S3Client = class {
       sessionToken
     };
   }
+  // Maybe future API
+  /*
   cors = {
-    get: () => {
-    },
-    set: () => {
-    },
-    delete: () => {
-    }
+  	get: () => {
+  		// TODO: GetBucketCors
+  	},
+  	set: () => {
+  		// TODO: PutBucketCors
+  	},
+  	delete: () => {
+  		// TODO: DeleteBucketCors
+  	},
   };
+  */
   /**
    * Creates an S3File instance for the given path.
    *
@@ -435,7 +441,6 @@ var S3Client = class {
    *
    * lean-s3 does not enforce these restrictions.
    *
-   * @param {Partial<CreateFileInstanceOptions>} [_options] TODO
    * @example
    * ```js
    * const file = client.file("image.jpg");
@@ -443,17 +448,16 @@ var S3Client = class {
    *
    * const configFile = client.file("config.json", {
    *   type: "application/json",
-   *   acl: "private"
    * });
    * ```
    */
-  file(path, _options) {
+  file(path, options = {}) {
     return new S3File(
       this,
       ensureValidPath(path),
       void 0,
       void 0,
-      void 0
+      options.type ?? void 0
     );
   }
   /**
@@ -474,6 +478,7 @@ var S3Client = class {
     // TODO: Maybe rename this to expiresInSeconds
     storageClass,
     contentLength,
+    type,
     acl,
     region: regionOverride,
     bucket: bucketOverride,
@@ -495,17 +500,21 @@ var S3Client = class {
       `${options.accessKeyId}/${date.date}/${region}/s3/aws4_request`,
       date,
       expiresIn,
-      typeof contentLength === "number" ? "content-length;host" : "host",
+      typeof contentLength === "number" || typeof type === "string" ? typeof contentLength === "number" && typeof type === "string" ? "content-length;content-type;host" : typeof contentLength === "number" ? "content-length;host" : typeof type === "string" ? "content-type;host" : "" : "host",
       unsignedPayload,
       storageClass,
       options.sessionToken,
       acl
     );
-    const dataDigest = typeof contentLength === "number" ? createCanonicalDataDigest(
+    const dataDigest = typeof contentLength === "number" || typeof type === "string" ? createCanonicalDataDigest(
       method,
       res.pathname,
       query,
-      { "content-length": String(contentLength), host: res.host },
+      typeof contentLength === "number" && typeof type === "string" ? {
+        "content-length": String(contentLength),
+        "content-type": type,
+        host: res.host
+      } : typeof contentLength === "number" ? { "content-length": String(contentLength), host: res.host } : typeof type === "string" ? { "content-type": type, host: res.host } : {},
       unsignedPayload
     ) : createCanonicalDataDigestHostOnly(
       method,
@@ -1541,7 +1550,7 @@ var S3File = class _S3File {
    * @remarks - Uses [`DeleteObject`](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html).
    *          - `versionId` not supported.
    *
-   * @param {Partial<S3FileDeleteOptions>} [options]
+   * @param {S3FileDeleteOptions} [options]
    *
    * @example
    * ```js
@@ -1632,15 +1641,16 @@ var S3File = class _S3File {
   }
   /**
    * @param {ByteSource} data
+   * @param {S3FileWriteOptions} [options.type] Defaults to the Content-Type that was used to create the {@link S3File} instance.
    * @returns {Promise<void>}
    */
-  async write(data) {
+  async write(data, options = {}) {
     const signal = void 0;
     const [bytes, length, hash] = await this.#transformData(data);
     return await this.#client[write](
       this.#path,
       bytes,
-      this.#contentType,
+      options.type ?? this.#contentType,
       length,
       hash,
       this.#start,

package/package.json

@@ -2,7 +2,7 @@
   "name": "lean-s3",
   "author": "Niklas Mollenhauer",
   "license": "MIT",
-  "version": "0.6.3",
+  "version": "0.7.0",
   "description": "A server-side S3 API for the regular user.",
   "keywords": [
     "s3",
@@ -48,15 +48,15 @@
   },
   "devDependencies": {
     "@biomejs/biome": "2.0.6",
-    "@testcontainers/localstack": "^11.0.3",
-    "@testcontainers/minio": "^11.0.3",
-    "@types/node": "^24.0.7",
-    "@typescript/native-preview": "^7.0.0-dev.20250629.1",
-    "expect": "^30.0.3",
-    "lefthook": "^1.11.14",
+    "@testcontainers/localstack": "^11.2.0",
+    "@testcontainers/minio": "^11.2.0",
+    "@types/node": "^24.0.10",
+    "@typescript/native-preview": "^7.0.0-dev.20250705.1",
+    "expect": "^30.0.4",
+    "lefthook": "^1.11.16",
     "tsup": "^8.5.0",
     "tsx": "^4.20.3",
-    "typedoc": "^0.28.6"
+    "typedoc": "^0.28.7"
   },
   "engines": {
     "node": "^20.19.2 || ^22.16.0 || ^24.2.0"