@amaster.ai/s3-client 1.1.0-beta.17

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Amaster Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,76 @@
+# @amaster.ai/s3-client
+
+Type-safe client for interacting with Amaster S3 storage service.
+
+## Installation
+
+```bash
+npm install @amaster.ai/s3-client
+# or
+pnpm add @amaster.ai/s3-client
+```
+
+## Usage
+
+```typescript
+import { createS3Client } from '@amaster.ai/s3-client';
+
+const s3Client = createS3Client();
+
+// 1. Upload a file
+const fileInput = document.querySelector('input[type="file"]');
+if (fileInput.files.length > 0) {
+  const file = fileInput.files[0];
+  const uploadResult = await s3Client.upload(file);
+  
+  if (uploadResult.data) {
+    console.log('Uploaded:', uploadResult.data.url);
+    console.log('Key:', uploadResult.data.key);
+  }
+}
+
+// 2. Get file metadata
+const metadata = await s3Client.getMetadata('uploads/image.png');
+if (metadata.data) {
+  console.log('Type:', metadata.data.contentType);
+  console.log('Size:', metadata.data.contentLength);
+}
+
+// 3. Download a file
+const downloadResult = await s3Client.download('uploads/image.png');
+if (downloadResult.data) {
+  // result.data is a Blob
+  const url = URL.createObjectURL(downloadResult.data);
+  window.open(url);
+}
+```
+
+## API Reference
+
+### `createS3Client(http?: HttpClient)`
+
+Creates a new instance of the S3 client. Optionally accepts a custom HTTP client.
+
+### `upload(file: File | Blob)`
+
+Uploads a file to the storage.
+
+- **Parameters**:
+  - `file`: `File` or `Blob` object to upload.
+- **Returns**: `Promise<ClientResult<UploadRes>>`
+
+### `download(filename: string)`
+
+Downloads a file as a Blob.
+
+- **Parameters**:
+  - `filename`: The key/path of the file to download.
+- **Returns**: `Promise<ClientResult<Blob>>`
+
+### `getMetadata(key: string)`
+
+Retrieves metadata for a specific file.
+
+- **Parameters**:
+  - `key`: The key/path of the file.
+- **Returns**: `Promise<ClientResult<S3Metadata>>`

package/dist/index.cjs

@@ -0,0 +1,2 @@
+'use strict';var httpClient=require('@amaster.ai/http-client');var a="/api/storage";function l(e=httpClient.createHttpClient()){return {async download(t){return t?await e.request({url:`${a}/download`,method:"get",params:{filename:t},responseType:"blob"}):{data:null,error:{message:"Filename is required",status:400},status:400}},async getMetadata(t){return t?e.request({url:`${a}/metadata`,method:"get",params:{key:t}}):{data:null,error:{message:"Key is required",status:400},status:400}},async upload(t){if(!t)return {data:null,error:{message:"File is required",status:400},status:400};let r=new FormData;return r.append("file",t),e.request({url:`${a}/upload`,method:"post",data:r,headers:{"Content-Type":"multipart/form-data"}})}}}exports.createS3Client=l;//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/s3-client.ts"],"names":["BASE_URL","createS3Client","http","createHttpClient","filename","key","file","formData"],"mappings":"+DAGA,IAAMA,CAAAA,CAAW,cAAA,CAEV,SAASC,CAAAA,CAAeC,CAAAA,CAAmBC,2BAAAA,EAAiB,CAAa,CAC9E,OAAO,CACL,MAAM,QAAA,CAASC,CAAAA,CAA+C,CAC5D,OAAKA,CAAAA,CAQU,MAAMF,EAAK,OAAA,CAAc,CACtC,GAAA,CAAK,CAAA,EAAGF,CAAQ,CAAA,SAAA,CAAA,CAChB,MAAA,CAAQ,KAAA,CACR,OAAQ,CAAE,QAAA,CAAAI,CAAS,CAAA,CACnB,YAAA,CAAc,MAChB,CAAC,CAAA,CAZQ,CACL,IAAA,CAAM,IAAA,CACN,KAAA,CAAO,CAAE,OAAA,CAAS,sBAAA,CAAwB,MAAA,CAAQ,GAAI,EACtD,MAAA,CAAQ,GACV,CAWJ,CAAA,CAEA,MAAM,WAAA,CAAYC,CAAAA,CAAgD,CAChE,OAAKA,CAAAA,CAQEH,CAAAA,CAAK,OAAA,CAAoB,CAC9B,GAAA,CAAK,CAAA,EAAGF,CAAQ,CAAA,SAAA,CAAA,CAChB,OAAQ,KAAA,CACR,MAAA,CAAQ,CAAE,GAAA,CAAAK,CAAI,CAChB,CAAC,CAAA,CAXQ,CACL,IAAA,CAAM,IAAA,CACN,KAAA,CAAO,CAAE,OAAA,CAAS,iBAAA,CAAmB,MAAA,CAAQ,GAAI,EACjD,MAAA,CAAQ,GACV,CAQJ,CAAA,CAEA,MAAM,MAAA,CAAOC,CAAAA,CAAqD,CAChE,GAAI,CAACA,CAAAA,CACH,OAAO,CACL,IAAA,CAAM,IAAA,CACN,KAAA,CAAO,CAAE,QAAS,kBAAA,CAAoB,MAAA,CAAQ,GAAI,CAAA,CAClD,MAAA,CAAQ,GACV,CAAA,CAGF,IAAMC,EAAW,IAAI,QAAA,CACrB,OAAAA,CAAAA,CAAS,MAAA,CAAO,MAAA,CAAQD,CAAI,CAAA,CAErBJ,EAAK,OAAA,CAAmB,CAC7B,GAAA,CAAK,CAAA,EAAGF,CAAQ,CAAA,OAAA,CAAA,CAChB,MAAA,CAAQ,MAAA,CACR,KAAMO,CAAAA,CACN,OAAA,CAAS,CACP,cAAA,CAAgB,qBAClB,CACF,CAAC,CACH,CACF,CACF","file":"index.cjs","sourcesContent":["import { type ClientResult, createHttpClient, type HttpClient } from \"@amaster.ai/http-client\";\nimport type { S3Client, S3Metadata, UploadRes } from \"./types\";\n\nconst BASE_URL = \"/api/storage\";\n\nexport function createS3Client(http: HttpClient = createHttpClient()): S3Client {\n  return {\n    async download(filename: string): Promise<ClientResult<Blob>> {\n      if (!filename) {\n        return {\n          data: null,\n          error: { message: \"Filename is required\", status: 400 },\n          status: 400,\n        };\n      }\n\n      const result = await http.request<Blob>({\n        url: `${BASE_URL}/download`,\n        method: \"get\",\n        params: { filename },\n        responseType: \"blob\",\n      });\n\n      return result;\n    },\n\n    async getMetadata(key: string): Promise<ClientResult<S3Metadata>> {\n      if (!key) {\n        return {\n          data: null,\n          error: { message: \"Key is required\", status: 400 },\n          status: 400,\n        };\n      }\n\n      return http.request<S3Metadata>({\n        url: `${BASE_URL}/metadata`,\n        method: \"get\",\n        params: { key },\n      });\n    },\n\n    async upload(file: File | Blob): Promise<ClientResult<UploadRes>> {\n      if (!file) {\n        return {\n          data: null,\n          error: { message: \"File is required\", status: 400 },\n          status: 400,\n        };\n      }\n\n      const formData = new FormData();\n      formData.append(\"file\", file);\n\n      return http.request<UploadRes>({\n        url: `${BASE_URL}/upload`,\n        method: \"post\",\n        data: formData,\n        headers: {\n          \"Content-Type\": \"multipart/form-data\",\n        },\n      });\n    },\n  };\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,33 @@
+import { ClientResult, HttpClient } from '@amaster.ai/http-client';
+
+interface UploadRes {
+    key: string;
+    url: string;
+}
+interface S3Metadata {
+    contentType?: string;
+    contentLength?: number;
+    lastModified?: string;
+    [key: string]: any;
+}
+type S3Client = {
+    /**
+     * Download a file
+     * @param filename - The name of the file to download
+     */
+    download(filename: string): Promise<ClientResult<Blob>>;
+    /**
+     * Get metadata for a file
+     * @param key - The key of the file
+     */
+    getMetadata(key: string): Promise<ClientResult<S3Metadata>>;
+    /**
+     * Upload a file
+     * @param file - The file to upload (File or Blob)
+     */
+    upload(file: File | Blob): Promise<ClientResult<UploadRes>>;
+};
+
+declare function createS3Client(http?: HttpClient): S3Client;
+
+export { type S3Client, type S3Metadata, type UploadRes, createS3Client };

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { ClientResult, HttpClient } from '@amaster.ai/http-client';
+
+interface UploadRes {
+    key: string;
+    url: string;
+}
+interface S3Metadata {
+    contentType?: string;
+    contentLength?: number;
+    lastModified?: string;
+    [key: string]: any;
+}
+type S3Client = {
+    /**
+     * Download a file
+     * @param filename - The name of the file to download
+     */
+    download(filename: string): Promise<ClientResult<Blob>>;
+    /**
+     * Get metadata for a file
+     * @param key - The key of the file
+     */
+    getMetadata(key: string): Promise<ClientResult<S3Metadata>>;
+    /**
+     * Upload a file
+     * @param file - The file to upload (File or Blob)
+     */
+    upload(file: File | Blob): Promise<ClientResult<UploadRes>>;
+};
+
+declare function createS3Client(http?: HttpClient): S3Client;
+
+export { type S3Client, type S3Metadata, type UploadRes, createS3Client };

package/dist/index.js

@@ -0,0 +1,2 @@
+import {createHttpClient}from'@amaster.ai/http-client';var a="/api/storage";function l(e=createHttpClient()){return {async download(t){return t?await e.request({url:`${a}/download`,method:"get",params:{filename:t},responseType:"blob"}):{data:null,error:{message:"Filename is required",status:400},status:400}},async getMetadata(t){return t?e.request({url:`${a}/metadata`,method:"get",params:{key:t}}):{data:null,error:{message:"Key is required",status:400},status:400}},async upload(t){if(!t)return {data:null,error:{message:"File is required",status:400},status:400};let r=new FormData;return r.append("file",t),e.request({url:`${a}/upload`,method:"post",data:r,headers:{"Content-Type":"multipart/form-data"}})}}}export{l as createS3Client};//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/s3-client.ts"],"names":["BASE_URL","createS3Client","http","createHttpClient","filename","key","file","formData"],"mappings":"uDAGA,IAAMA,CAAAA,CAAW,cAAA,CAEV,SAASC,CAAAA,CAAeC,CAAAA,CAAmBC,gBAAAA,EAAiB,CAAa,CAC9E,OAAO,CACL,MAAM,QAAA,CAASC,CAAAA,CAA+C,CAC5D,OAAKA,CAAAA,CAQU,MAAMF,EAAK,OAAA,CAAc,CACtC,GAAA,CAAK,CAAA,EAAGF,CAAQ,CAAA,SAAA,CAAA,CAChB,MAAA,CAAQ,KAAA,CACR,OAAQ,CAAE,QAAA,CAAAI,CAAS,CAAA,CACnB,YAAA,CAAc,MAChB,CAAC,CAAA,CAZQ,CACL,IAAA,CAAM,IAAA,CACN,KAAA,CAAO,CAAE,OAAA,CAAS,sBAAA,CAAwB,MAAA,CAAQ,GAAI,EACtD,MAAA,CAAQ,GACV,CAWJ,CAAA,CAEA,MAAM,WAAA,CAAYC,CAAAA,CAAgD,CAChE,OAAKA,CAAAA,CAQEH,CAAAA,CAAK,OAAA,CAAoB,CAC9B,GAAA,CAAK,CAAA,EAAGF,CAAQ,CAAA,SAAA,CAAA,CAChB,OAAQ,KAAA,CACR,MAAA,CAAQ,CAAE,GAAA,CAAAK,CAAI,CAChB,CAAC,CAAA,CAXQ,CACL,IAAA,CAAM,IAAA,CACN,KAAA,CAAO,CAAE,OAAA,CAAS,iBAAA,CAAmB,MAAA,CAAQ,GAAI,EACjD,MAAA,CAAQ,GACV,CAQJ,CAAA,CAEA,MAAM,MAAA,CAAOC,CAAAA,CAAqD,CAChE,GAAI,CAACA,CAAAA,CACH,OAAO,CACL,IAAA,CAAM,IAAA,CACN,KAAA,CAAO,CAAE,QAAS,kBAAA,CAAoB,MAAA,CAAQ,GAAI,CAAA,CAClD,MAAA,CAAQ,GACV,CAAA,CAGF,IAAMC,EAAW,IAAI,QAAA,CACrB,OAAAA,CAAAA,CAAS,MAAA,CAAO,MAAA,CAAQD,CAAI,CAAA,CAErBJ,EAAK,OAAA,CAAmB,CAC7B,GAAA,CAAK,CAAA,EAAGF,CAAQ,CAAA,OAAA,CAAA,CAChB,MAAA,CAAQ,MAAA,CACR,KAAMO,CAAAA,CACN,OAAA,CAAS,CACP,cAAA,CAAgB,qBAClB,CACF,CAAC,CACH,CACF,CACF","file":"index.js","sourcesContent":["import { type ClientResult, createHttpClient, type HttpClient } from \"@amaster.ai/http-client\";\nimport type { S3Client, S3Metadata, UploadRes } from \"./types\";\n\nconst BASE_URL = \"/api/storage\";\n\nexport function createS3Client(http: HttpClient = createHttpClient()): S3Client {\n  return {\n    async download(filename: string): Promise<ClientResult<Blob>> {\n      if (!filename) {\n        return {\n          data: null,\n          error: { message: \"Filename is required\", status: 400 },\n          status: 400,\n        };\n      }\n\n      const result = await http.request<Blob>({\n        url: `${BASE_URL}/download`,\n        method: \"get\",\n        params: { filename },\n        responseType: \"blob\",\n      });\n\n      return result;\n    },\n\n    async getMetadata(key: string): Promise<ClientResult<S3Metadata>> {\n      if (!key) {\n        return {\n          data: null,\n          error: { message: \"Key is required\", status: 400 },\n          status: 400,\n        };\n      }\n\n      return http.request<S3Metadata>({\n        url: `${BASE_URL}/metadata`,\n        method: \"get\",\n        params: { key },\n      });\n    },\n\n    async upload(file: File | Blob): Promise<ClientResult<UploadRes>> {\n      if (!file) {\n        return {\n          data: null,\n          error: { message: \"File is required\", status: 400 },\n          status: 400,\n        };\n      }\n\n      const formData = new FormData();\n      formData.append(\"file\", file);\n\n      return http.request<UploadRes>({\n        url: `${BASE_URL}/upload`,\n        method: \"post\",\n        data: formData,\n        headers: {\n          \"Content-Type\": \"multipart/form-data\",\n        },\n      });\n    },\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@amaster.ai/s3-client",
+  "version": "1.1.0-beta.17",
+  "description": "S3 storage client for file upload, download and management",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [
+    "s3",
+    "storage",
+    "client",
+    "upload",
+    "download",
+    "typescript"
+  ],
+  "author": "Amaster Team",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "@amaster.ai/http-client": "1.1.0-beta.17"
+  },
+  "peerDependencies": {
+    "axios": "^1.11.0"
+  },
+  "devDependencies": {
+    "axios": "^1.11.0",
+    "tsup": "^8.3.5",
+    "typescript": "~5.7.2",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist *.tsbuildinfo",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "type-check": "tsc --noEmit"
+  }
+}