tmpbox.me 1.0.4 → 1.0.5

package/README.md

@@ -1,11 +1,14 @@
 # tmpbox.me
 
-Official TmpBox.me uploader SDK and CLI for Node.js.
+Official Node.js SDK and CLI for uploading files to **TmpBox.me**.
 
 - No account required for guest uploads
-- Guest limit: **100MB per file**
-- Logged-in user limit: **500MB per file**
-- Supports CommonJS, ES Module, TypeScript types, and CLI
+- Guest uploads up to **100MB**
+- Logged-in users upload up to **500MB**
+- Default expiration is **30 days**
+- Supports CommonJS, ES Module, TypeScript and CLI
+
+---
 
 ## Installation
 
@@ -13,40 +16,72 @@ Official TmpBox.me uploader SDK and CLI for Node.js.
 npm install tmpbox.me
 ```
 
-Node.js 18 or newer is required.
+Node.js **18+** is required.
+
+---
+
+# Upload Limits
+
+| Mode  | Authentication               | Max file size | Available TTL                                        |
+| ----- | ---------------------------- | ------------: | ---------------------------------------------------- |
+| Guest | None                         |    **100 MB** | `1d`, `7d`, `30d` _(default)_                        |
+| User  | Username & Password or Token |    **500 MB** | `1d`, `7d`, `30d` _(default)_, `0` _(Never expires)_ |
+
+---
 
-## Quick start as guest
+# Quick Start (Guest)
 
-No username, password, or token is required.
+No account or token is required.
 
-### CommonJS
+If no authentication is provided, uploads automatically use **Guest Mode**.
 
 ```js
-const { uploadFile } = require("tmpbox.me");
+import { uploadFile } from "tmpbox.me";
 
 const result = await uploadFile("./video.mp4");
+
 console.log(result.fullUrl);
 ```
 
-### ES Module
+CommonJS
 
 ```js
-import { uploadFile } from "tmpbox.me";
+const { uploadFile } = require("tmpbox.me");
 
 const result = await uploadFile("./video.mp4");
+
 console.log(result.fullUrl);
 ```
 
-Guest uploads are limited to **100MB per file**.
+Guest uploads:
 
-## Login with username and password
+- Maximum file size: **100MB**
+- Default TTL: **30 days**
+- Supported TTL:
+  - `1d`
+  - `7d`
+  - `30d`
 
-Use username and password when you need the **500MB per file** user limit.
+Example:
 
 ```js
 import { uploadFile } from "tmpbox.me";
 
-const result = await uploadFile("./large-video.mp4", {
+const result = await uploadFile("./photo.png", {
+  ttl: "7d",
+});
+```
+
+---
+
+# Login with Username & Password
+
+Logged-in users can upload files up to **500MB**.
+
+```js
+import { uploadFile } from "tmpbox.me";
+
+const result = await uploadFile("./movie.mp4", {
   username: "your_username",
   password: "your_password",
 });
@@ -54,31 +89,48 @@ const result = await uploadFile("./large-video.mp4", {
 console.log(result.fullUrl);
 ```
 
-You can also use an existing token:
+Default TTL:
+
+```
+30d
+```
+
+Supported TTL:
+
+- `1d`
+- `7d`
+- `30d`
+- `0` _(Never expires)_
+
+Example:
 
 ```js
 import { uploadFile } from "tmpbox.me";
 
-const result = await uploadFile("./large-video.mp4", {
-  token: "YOUR_TOKEN",
+const result = await uploadFile("./backup.zip", {
+  username: "your_username",
+  password: "your_password",
+  ttl: "0",
 });
 ```
 
-## Upload progress
+---
+
+# Upload with Access Token
+
+If you already have an access token:
 
 ```js
 import { uploadFile } from "tmpbox.me";
 
-const result = await uploadFile("./file.zip", {
-  onProgress(state) {
-    console.log(state.status, state.progress);
-  },
+const result = await uploadFile("./video.mp4", {
+  token: "YOUR_ACCESS_TOKEN",
 });
-
-console.log(result.fullUrl);
 ```
 
-## Upload multiple files
+---
+
+# Upload Multiple Files
 
 ```js
 import { uploadFiles } from "tmpbox.me";
@@ -89,117 +141,187 @@ const results = await uploadFiles([
   "./archive.zip",
 ]);
 
-console.log(results.map((item) => item.fullUrl));
+console.log(results);
 ```
 
-## CLI
+---
 
-### Guest upload
+# Upload Progress
+
+```js
+import { uploadFile } from "tmpbox.me";
+
+const result = await uploadFile("./video.mp4", {
+  onProgress(progress) {
+    console.log(progress.status);
+    console.log(progress.progress + "%");
+  },
+});
+```
+
+---
+
+# Default Behavior
+
+If `ttl` is omitted, the SDK automatically uses:
+
+```js
+ttl: "30d";
+```
+
+If authentication is omitted, the SDK automatically uploads as a **Guest**.
+
+---
+
+# CLI
+
+Guest upload
 
 ```bash
 tmpbox-upload ./video.mp4
 ```
 
-### User upload
+Login upload
 
 ```bash
-tmpbox-upload ./video.mp4 -u your_username -p your_password
+tmpbox-upload ./video.mp4 -u username -p password
 ```
 
-### Upload with token
+Token upload
 
 ```bash
-tmpbox-upload ./video.mp4 -t "$TMPBOX_TOKEN"
+tmpbox-upload ./video.mp4 -t YOUR_TOKEN
 ```
 
-### Upload multiple files
+Multiple files
 
 ```bash
-tmpbox-upload ./a.zip ./b.pdf ./c.mp4
+tmpbox-upload ./a.zip ./b.mp4 ./c.pdf
 ```
 
-### JSON output
+JSON output
 
 ```bash
 tmpbox-upload ./video.mp4 --json
 ```
 
-## Environment variables
+---
+
+# Environment Variables
 
-The CLI and SDK can read these automatically:
+Username & Password
 
 ```bash
 TMPBOX_USERNAME=your_username
 TMPBOX_PASSWORD=your_password
 ```
 
-or:
+Token
 
 ```bash
-TMPBOX_TOKEN=your_token
+TMPBOX_TOKEN=your_access_token
 ```
 
-Legacy token environment variables are also supported:
+Legacy variables are also supported:
 
 ```bash
 FILESTORAGE_TOKEN=your_token
 UPLOAD_TOKEN=your_token
 ```
 
-If no account or token is provided, upload runs in guest mode.
+---
 
-## API
+# API
 
-### `uploadFile(filePath, options?)`
-
-Uploads one file.
+## uploadFile()
 
 ```ts
 uploadFile(filePath: string, options?: UploadOptions): Promise<UploadResult>
 ```
 
-### `uploadFiles(filePaths, options?)`
+Uploads a single file.
+
+---
 
-Uploads multiple files one by one.
+## uploadFiles()
 
 ```ts
-uploadFiles(filePaths: string[], options?: UploadOptions): Promise<UploadResult[]>
+uploadFiles(files: string[], options?: UploadOptions): Promise<UploadResult[]>
 ```
 
-### `login(username, password)`
+Uploads multiple files.
+
+---
 
-Logs in and returns an auth token.
+## login()
 
 ```ts
 login(username: string, password: string): Promise<LoginResult>
 ```
 
-## Options
+Logs in and returns an access token.
+
+---
+
+# Options
 
 ```ts
 interface UploadOptions {
   token?: string;
+
   username?: string;
+
   password?: string;
-  ttl?: string;
+
+  /**
+   * Default: "30d"
+   *
+   * Guest:
+   *  - "1d"
+   *  - "7d"
+   *  - "30d"
+   *
+   * User:
+   *  - "1d"
+   *  - "7d"
+   *  - "30d"
+   *  - "0" (Never expires)
+   */
+  ttl?: "1d" | "7d" | "30d" | "0";
+
   filename?: string;
+
   mimetype?: string;
+
   chunkSize?: number;
-  chunkConcurrency?: number;
+
   wait?: boolean;
+
   timeoutMs?: number;
+
   pollIntervalMs?: number;
-  onProgress?: (state: UploadState) => void;
+
+  onProgress?: (progress: UploadProgress) => void;
 }
 ```
 
-## Limits
+---
+
+# Features
+
+- Guest uploads without registration
+- Username & password authentication
+- Token authentication
+- Automatic retry
+- Automatic polling
+- Upload progress callback
+- CommonJS support
+- ES Module support
+- TypeScript definitions
+- CLI included
 
-| Mode  | Auth required              | Limit          |
-| ----- | -------------------------- | -------------- |
-| Guest | No                         | 100MB per file |
-| User  | Username/password or token | 500MB per file |
+---
 
-## License
+# License
 
 MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tmpbox.me",
   "author": "bangvn71",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Official TmpBox.me uploader SDK and CLI for Node.js.",
   "type": "module",
   "main": "./lib/index.cjs",
@@ -28,11 +28,35 @@
     "pack:local": "npm pack"
   },
   "keywords": [
-    "tmpbox.me",
     "tmpbox",
+    "tmpbox.me",
+    "tmpbox sdk",
+    "tmpbox api",
+    "tmpbox uploader",
     "upload",
+    "uploader",
+    "upload sdk",
+    "file",
+    "file upload",
     "file-upload",
     "storage",
+    "cloud storage",
+    "temporary storage",
+    "temporary file",
+    "file hosting",
+    "share files",
+    "cdn",
+    "multipart",
+    "chunk upload",
+    "parallel upload",
+    "nodejs",
+    "node",
+    "javascript",
+    "typescript",
+    "esm",
+    "commonjs",
+    "sdk",
+    "api",
     "cli"
   ],
   "license": "MIT",