@vankyle/storage-s3 0.3.0 → 0.4.0

package/README.md

@@ -81,6 +81,12 @@ const storage = new S3Storage({
 
 All four URL types use `@aws-sdk/s3-request-presigner`.
 
+`createReadUrl` and `DefaultStorageService.getReadUrl` support optional
+`responseContentDisposition` and `responseContentType` overrides. They are
+passed to S3 as `response-content-disposition` and `response-content-type`
+query parameters on the presigned URL, so S3 sets those response headers on the
+eventual GET.
+
 ## Options reference
 
 ```typescript

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { S3Storage } from "./storage/index";
-export type { S3StorageOptions } from "./types/index";
+export { S3Storage } from "./storage/index.js";
+export type { S3StorageOptions } from "./types/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,2 +1,2 @@
-export { S3Storage } from "./storage/index";
+export { S3Storage } from "./storage/index.js";
 //# sourceMappingURL=index.js.map

package/dist/mappers/index.d.ts

@@ -1,2 +1,2 @@
-export { mapS3HeadToCore } from "../mappers/s3-head-to-core";
+export { mapS3HeadToCore } from "../mappers/s3-head-to-core.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/mappers/index.js

@@ -1,2 +1,2 @@
-export { mapS3HeadToCore } from "../mappers/s3-head-to-core";
+export { mapS3HeadToCore } from "../mappers/s3-head-to-core.js";
 //# sourceMappingURL=index.js.map

package/dist/storage/index.d.ts

@@ -1,2 +1,2 @@
-export { S3Storage } from "../storage/s3-storage";
+export { S3Storage } from "../storage/s3-storage.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/storage/index.js

@@ -1,2 +1,2 @@
-export { S3Storage } from "../storage/s3-storage";
+export { S3Storage } from "../storage/s3-storage.js";
 //# sourceMappingURL=index.js.map

package/dist/storage/s3-storage.d.ts

@@ -1,5 +1,5 @@
 import { type IStorage, type StorageCapabilities, type PutObjectInput, type PutObjectResult, type GetObjectInput, type GetObjectResult, type HeadObjectInput, type HeadObjectResult, type DeleteObjectInput, type InitUploadSessionInput, type InitUploadSessionResult, type UploadPartInput, type UploadPartResult, type CompleteUploadSessionInput, type CompleteUploadSessionResult, type AbortUploadSessionInput, type CreateReadUrlInput, type CreatePutUrlInput, type CreateUploadPartUrlInput, type SignedAccess } from "@vankyle/storage-core";
-import type { S3StorageOptions } from "../types/s3-options";
+import type { S3StorageOptions } from "../types/s3-options.js";
 export declare class S3Storage implements IStorage {
     readonly provider: "s3";
     readonly capabilities: StorageCapabilities;

package/dist/storage/s3-storage.js

@@ -2,7 +2,7 @@ import { S3Client, PutObjectCommand, GetObjectCommand, HeadObjectCommand, Delete
 import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
 import { StorageProvider, } from "@vankyle/storage-core";
 import { StorageError, StorageObjectNotFoundError, } from "@vankyle/storage-shared";
-import { mapS3HeadToCore } from "../mappers/s3-head-to-core";
+import { mapS3HeadToCore } from "../mappers/s3-head-to-core.js";
 const DEFAULT_EXPIRES_IN = 3600; // 1 hour
 export class S3Storage {
     provider = StorageProvider.S3;

package/dist/storage/s3-storage.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=s3-storage.test.d.ts.map

package/dist/storage/s3-storage.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-storage.test.d.ts","sourceRoot":"","sources":["../../src/storage/s3-storage.test.ts"],"names":[],"mappings":""}

package/dist/storage/s3-storage.test.js

@@ -0,0 +1,44 @@
+import { describe, expect, it } from "vitest";
+import { S3Storage } from "../storage/s3-storage.js";
+function createStorage() {
+    return new S3Storage({
+        clientConfig: {
+            region: "us-east-1",
+            endpoint: "https://s3.example.test",
+            credentials: {
+                accessKeyId: "test-access-key",
+                secretAccessKey: "test-secret-key",
+            },
+        },
+        forcePathStyle: true,
+    });
+}
+describe("S3Storage", () => {
+    describe("createReadUrl", () => {
+        it("should include response header overrides in the presigned URL", async () => {
+            const storage = createStorage();
+            const signed = await storage.createReadUrl({
+                bucket: "test-bucket",
+                objectKey: "path/to/demo.txt",
+                expiresInSeconds: 600,
+                responseContentDisposition: "attachment; filename=\"demo.txt\"; filename*=UTF-8''demo.txt",
+                responseContentType: "text/plain",
+            });
+            const params = new URL(signed.url).searchParams;
+            expect(params.get("response-content-disposition")).toBe("attachment; filename=\"demo.txt\"; filename*=UTF-8''demo.txt");
+            expect(params.get("response-content-type")).toBe("text/plain");
+        });
+        it("should omit response header override query params when not provided", async () => {
+            const storage = createStorage();
+            const signed = await storage.createReadUrl({
+                bucket: "test-bucket",
+                objectKey: "path/to/demo.txt",
+                expiresInSeconds: 600,
+            });
+            const params = new URL(signed.url).searchParams;
+            expect(params.has("response-content-disposition")).toBe(false);
+            expect(params.has("response-content-type")).toBe(false);
+        });
+    });
+});
+//# sourceMappingURL=s3-storage.test.js.map

package/dist/storage/s3-storage.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3-storage.test.js","sourceRoot":"","sources":["../../src/storage/s3-storage.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAEjD,SAAS,aAAa;IACpB,OAAO,IAAI,SAAS,CAAC;QACnB,YAAY,EAAE;YACZ,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,yBAAyB;YACnC,WAAW,EAAE;gBACX,WAAW,EAAE,iBAAiB;gBAC9B,eAAe,EAAE,iBAAiB;aACnC;SACF;QACD,cAAc,EAAE,IAAI;KACrB,CAAC,CAAC;AACL,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;YAC7E,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;YAEhC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC;gBACzC,MAAM,EAAE,aAAa;gBACrB,SAAS,EAAE,kBAAkB;gBAC7B,gBAAgB,EAAE,GAAG;gBACrB,0BAA0B,EACxB,8DAA8D;gBAChE,mBAAmB,EAAE,YAAY;aAClC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC;YAChD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,CAAC,IAAI,CACrD,8DAA8D,CAC/D,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACjE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;YACnF,MAAM,OAAO,GAAG,aAAa,EAAE,CAAC;YAEhC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC;gBACzC,MAAM,EAAE,aAAa;gBACrB,SAAS,EAAE,kBAAkB;gBAC7B,gBAAgB,EAAE,GAAG;aACtB,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,YAAY,CAAC;YAChD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC/D,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
-export type { S3StorageOptions } from "../types/s3-options";
+export type { S3StorageOptions } from "../types/s3-options.js";
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vankyle/storage-s3",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "S3-compatible object storage adapter for vankyle-storage.",
   "type": "module",
   "main": "./dist/index.js",
@@ -31,8 +31,8 @@
   "homepage": "https://github.com/Vankyle-Hub/storage-ts",
   "packageManager": "pnpm@10.28.2",
   "dependencies": {
-    "@vankyle/storage-core": "0.3.0",
-    "@vankyle/storage-shared": "0.3.0",
+    "@vankyle/storage-core": "0.4.0",
+    "@vankyle/storage-shared": "0.4.0",
     "@aws-sdk/client-s3": "^3.1029.0",
     "@aws-sdk/s3-request-presigner": "^3.1029.0"
   },