secure-s3-storage 1.0.1 → 1.0.2

package/README.en.md

@@ -11,10 +11,10 @@ npm install secure-s3-storage
 ## Quick Start
 
 ```ts
-import { init } from "secure-s3-storage";
+import { initStorage, type Storage, type BrowserFile, type UploadResult } from "secure-s3-storage";
 import { readFile } from "node:fs/promises";
 
-const storage = init({
+const storage: Storage = initStorage({
   bucket: "my-bucket",
   region: "ap-northeast-2",
   accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
@@ -25,7 +25,15 @@ const storage = init({
   },
 });
 
-const result = await storage.upload(file);
+const source = await readFile("./photo.png");
+const file: BrowserFile = {
+  name: "photo.png",
+  type: "image/png",
+  arrayBuffer: async () =>
+    source.buffer.slice(source.byteOffset, source.byteOffset + source.byteLength),
+};
+
+const result: UploadResult = await storage.upload(file);
 
 const body = await readFile("./photo.png");
 await storage.put("images", body, "image/png");
@@ -36,7 +44,7 @@ await storage.remove(result.key);
 If you use temporary AWS credentials, pass `sessionToken` as well.
 
 ```ts
-const storage = init({
+const storage = initStorage({
   bucket: "my-bucket",
   region: "ap-northeast-2",
   accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
@@ -51,7 +59,7 @@ const storage = init({
 
 ## API
 
-### `init(options)`
+### `initStorage(options)`
 
 Creates a storage instance.
 
@@ -126,6 +134,6 @@ Return value from `storage.upload()` and `storage.put()`.
   key: string;
   filename: string;
   extension: string;
-  contentType?: string;
+  contentType: string;
 }
 ```

package/README.md

@@ -13,10 +13,10 @@ npm install secure-s3-storage
 ## Quick Start
 
 ```ts
-import { init } from "secure-s3-storage";
+import { initStorage, type Storage, type BrowserFile, type UploadResult } from "secure-s3-storage";
 import { readFile } from "node:fs/promises";
 
-const storage = init({
+const storage: Storage = initStorage({
   bucket: "my-bucket",
   region: "ap-northeast-2",
   accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
@@ -27,7 +27,15 @@ const storage = init({
   },
 });
 
-const result = await storage.upload(file);
+const source = await readFile("./photo.png");
+const file: BrowserFile = {
+  name: "photo.png",
+  type: "image/png",
+  arrayBuffer: async () =>
+    source.buffer.slice(source.byteOffset, source.byteOffset + source.byteLength),
+};
+
+const result: UploadResult = await storage.upload(file);
 
 const body = await readFile("./photo.png");
 await storage.put("images", body, "image/png");
@@ -38,7 +46,7 @@ await storage.remove(result.key);
 임시 AWS credential을 쓰는 경우에는 `sessionToken`도 함께 넣으면 됩니다.
 
 ```ts
-const storage = init({
+const storage = initStorage({
   bucket: "my-bucket",
   region: "ap-northeast-2",
   accessKeyId: process.env.AWS_ACCESS_KEY_ID!,
@@ -53,7 +61,7 @@ const storage = init({
 
 ## API
 
-### `init(options)`
+### `initStorage(options)`
 
 스토리지 인스턴스를 생성합니다.
 
@@ -128,6 +136,6 @@ object key 기준으로 공개 URL을 생성합니다.
   key: string;
   filename: string;
   extension: string;
-  contentType?: string;
+  contentType: string;
 }
 ```

package/dist/index.d.ts

@@ -17,15 +17,15 @@ export type UploadResult = {
     key: string;
     filename: string;
     extension: string;
-    contentType?: string;
+    contentType: string;
+};
+export type Storage = {
+    put(path: string, file: Buffer, contentType?: string): Promise<UploadResult>;
+    upload(file: BrowserFile): Promise<UploadResult>;
+    remove(key: string): Promise<void>;
+    getUrl(key: string): string;
 };
-export type Storage = ReturnType<typeof init>;
 export declare class StorageValidationError extends Error {
     constructor(message: string);
 }
-export declare function init(options: StorageInitOptions): {
-    put: (path: string, file: Buffer, contentType?: string) => Promise<UploadResult>;
-    upload: (file: BrowserFile) => Promise<UploadResult>;
-    remove: (key: string) => Promise<void>;
-    getUrl: (key: string) => string;
-};
+export declare function initStorage(options: StorageInitOptions): Storage;

package/dist/index.js

@@ -72,7 +72,7 @@ export class StorageValidationError extends Error {
         this.name = "StorageValidationError";
     }
 }
-export function init(options) {
+export function initStorage(options) {
     const { bucket, categories, accessKeyId, secretAccessKey, sessionToken, ...s3Config } = options;
     const normalizedAccessKeyId = typeof accessKeyId === "string" ? accessKeyId.trim() : undefined;
     const normalizedSecretAccessKey = typeof secretAccessKey === "string" ? secretAccessKey.trim() : undefined;
@@ -126,7 +126,7 @@ export function init(options) {
         const datePrefix = getDatePrefix();
         const prefixWithDate = `${datePrefix}/${config.prefix}`;
         const key = buildObjectKey(prefixWithDate, filename);
-        const finalContentType = contentType ?? detected?.mime ?? getContentTypeFromFilename(filename);
+        const finalContentType = contentType ?? detected?.mime ?? getContentTypeFromFilename(filename) ?? "application/octet-stream";
         await client.send(new PutObjectCommand({
             Bucket: bucket,
             Key: key,
@@ -250,7 +250,9 @@ async function resolveUploadTarget(input) {
         return {
             extension,
             filename: buildGeneratedFilename(extension),
-            contentType: input.sourceContentType ?? getContentTypeFromFilename(`file.${extension}`),
+            contentType: input.sourceContentType ??
+                getContentTypeFromFilename(`file.${extension}`) ??
+                "application/octet-stream",
         };
     }
     throw new StorageValidationError(`Unable to validate file contents for .${extension}.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "secure-s3-storage",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "S3-backed storage module with automatic file validation",
   "type": "module",
   "main": "dist/index.js",