@amaster.ai/client 1.1.21 → 1.1.23

package/README.md

@@ -574,7 +574,10 @@ File upload, download, and metadata lookup.
 
 ```typescript
 // Upload file
-await client.s3.upload(file);
+await client.s3.upload(file, {
+  category: "documents",
+  onProgress: ({ percentage }) => console.log(`Uploading: ${percentage}%`),
+});
 
 // Download file
 await client.s3.download("path/to/file");
@@ -764,11 +767,12 @@ Workflow execution API from `@amaster.ai/workflow-client`:
 
 S3 storage API:
 
-- `upload(file)` - Upload file
+- `upload(file, options?)` - Upload file
 - `download(path)` - Download file as a blob
 - `getMetadata(key)` - Read object metadata
 
-`upload(file)` automatically switches to multipart upload for large files.
+`upload(file, options?)` automatically switches to multipart upload for large
+files and can report progress via `options.onProgress`.
 
 ### `client.asr`
 
@@ -813,10 +817,11 @@ Function invocation API:
 
 S3 storage API:
 
-- `upload(file)` - Upload file
+- `upload(file, options?)` - Upload file
 - `download(path)` - Download file
 
-`upload(file)` automatically switches to multipart upload for large files.
+`upload(file, options?)` automatically switches to multipart upload for large
+files and can report progress via `options.onProgress`.
 
 ## 🔐 Token Management Flow
 

package/dist/index.d.cts

@@ -15,7 +15,7 @@ export { FunctionClient, FunctionInvocationResult } from '@amaster.ai/function-c
 import { TTSClientConfig, TTSClient } from '@amaster.ai/tts-client';
 export { TTSClient, TTSClientConfig, TTSRuntime, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStorageAdapter, createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from '@amaster.ai/tts-client';
 import { S3Client } from '@amaster.ai/s3-client';
-export { S3Client, S3Metadata, UploadRes } from '@amaster.ai/s3-client';
+export { S3Client, S3Metadata, S3UploadOptions, S3UploadProgress, S3UploadProgressPhase, UploadRes } from '@amaster.ai/s3-client';
 import { MiniProgramRuntime, HttpClient } from '@amaster.ai/http-client';
 export { ClientError, ClientResult, HttpClient, RequestConfig } from '@amaster.ai/http-client';
 
@@ -301,10 +301,12 @@ interface AmasterClient {
      * @example
      * ```typescript
      * // Upload file
-     * await client.s3.upload(file);
+     * await client.s3.upload(file, {
+     *   onProgress: ({ percentage }) => console.log(`Uploading: ${percentage}%`),
+     * });
      *
-    * // Download file
-    * await client.s3.download('path/to/file');
+     * // Download file
+     * await client.s3.download('path/to/file');
      *
      * // Read metadata
      * await client.s3.getMetadata('path/to/file');

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export { FunctionClient, FunctionInvocationResult } from '@amaster.ai/function-c
 import { TTSClientConfig, TTSClient } from '@amaster.ai/tts-client';
 export { TTSClient, TTSClientConfig, TTSRuntime, TTSSnapshot, TTSSpeakController, TTSSpeakControllerOptions, TTSSpeakOptions, TTSStorageAdapter, createTTSSpeakController, preprocessTTSContent, splitTextIntoFragments } from '@amaster.ai/tts-client';
 import { S3Client } from '@amaster.ai/s3-client';
-export { S3Client, S3Metadata, UploadRes } from '@amaster.ai/s3-client';
+export { S3Client, S3Metadata, S3UploadOptions, S3UploadProgress, S3UploadProgressPhase, UploadRes } from '@amaster.ai/s3-client';
 import { MiniProgramRuntime, HttpClient } from '@amaster.ai/http-client';
 export { ClientError, ClientResult, HttpClient, RequestConfig } from '@amaster.ai/http-client';
 
@@ -301,10 +301,12 @@ interface AmasterClient {
      * @example
      * ```typescript
      * // Upload file
-     * await client.s3.upload(file);
+     * await client.s3.upload(file, {
+     *   onProgress: ({ percentage }) => console.log(`Uploading: ${percentage}%`),
+     * });
      *
-    * // Download file
-    * await client.s3.download('path/to/file');
+     * // Download file
+     * await client.s3.download('path/to/file');
      *
      * // Read metadata
      * await client.s3.getMetadata('path/to/file');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amaster.ai/client",
-  "version": "1.1.21",
+  "version": "1.1.23",
   "description": "Unified API client for Amaster platform - All services in one package",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -72,16 +72,16 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@amaster.ai/asr-client": "1.1.21",
-    "@amaster.ai/bpm-client": "1.1.21",
-    "@amaster.ai/auth-client": "1.1.21",
-    "@amaster.ai/copilot-client": "1.1.21",
-    "@amaster.ai/entity-client": "1.1.21",
-    "@amaster.ai/function-client": "1.1.21",
-    "@amaster.ai/http-client": "1.1.21",
-    "@amaster.ai/s3-client": "1.1.21",
-    "@amaster.ai/tts-client": "1.1.21",
-    "@amaster.ai/workflow-client": "1.1.21"
+    "@amaster.ai/asr-client": "1.1.23",
+    "@amaster.ai/bpm-client": "1.1.23",
+    "@amaster.ai/auth-client": "1.1.23",
+    "@amaster.ai/entity-client": "1.1.23",
+    "@amaster.ai/copilot-client": "1.1.23",
+    "@amaster.ai/function-client": "1.1.23",
+    "@amaster.ai/http-client": "1.1.23",
+    "@amaster.ai/tts-client": "1.1.23",
+    "@amaster.ai/workflow-client": "1.1.23",
+    "@amaster.ai/s3-client": "1.1.23"
   },
   "peerDependencies": {
     "axios": "^1.11.0"

package/types/__tests__/type-checks.test-d.ts

@@ -16,6 +16,7 @@ import type {
   User,
   Task,
   ProcessInstance,
+  S3UploadOptions,
 } from '../index';
 
 describe('Type Tests', () => {
@@ -112,6 +113,24 @@ describe('Type Tests', () => {
       expectTypeOf<AmasterClient['function']>().toHaveProperty('invoke');
       expectTypeOf<AmasterClient['s3']>().toHaveProperty('upload');
     });
+
+    it('should accept S3 upload options', () => {
+      const options: S3UploadOptions = {
+        fileName: 'report.pdf',
+        category: 'documents',
+        onProgress: (progress) => {
+          expectTypeOf(progress.percentage).toEqualTypeOf<number>();
+          expectTypeOf(progress.phase).toEqualTypeOf<
+            'preparing' | 'uploading' | 'completing' | 'completed'
+          >();
+        },
+      };
+
+      expectTypeOf<AmasterClient['s3']['upload']>().parameters.toMatchTypeOf<
+        [File | Blob, S3UploadOptions?]
+      >();
+      expectTypeOf(options).toMatchTypeOf<S3UploadOptions>();
+    });
   });
 
   describe('LoginParams', () => {

package/types/index.d.ts

@@ -467,7 +467,15 @@ export type {
   TTSRuntime,
   TTSStorageAdapter,
 } from "./tts";
-export type { S3ClientAPI, UploadRes, S3Metadata, S3ClientAPI as S3Client } from "./s3";
+export type {
+  S3ClientAPI,
+  UploadRes,
+  S3Metadata,
+  S3UploadOptions,
+  S3UploadProgress,
+  S3UploadProgressPhase,
+  S3ClientAPI as S3Client,
+} from "./s3";
 export type { HttpClient, MiniProgramRuntime, RequestConfig } from "./http";
 
 // For detailed types, import directly from submodules:

package/types/s3.d.ts

@@ -29,6 +29,44 @@ export interface S3Metadata {
   [key: string]: any;
 }
 
+export type S3UploadProgressPhase =
+  | "preparing"
+  | "uploading"
+  | "completing"
+  | "completed";
+
+/**
+ * Upload progress event emitted by client.s3.upload.
+ *
+ */
+export interface S3UploadProgress {
+  /** Uploaded bytes across the whole file */
+  loaded: number;
+  /** Total file bytes */
+  total: number;
+  /** Upload percentage from 0 to 100 */
+  percentage: number;
+  /** Current upload phase */
+  phase: S3UploadProgressPhase;
+  /** Multipart part currently reporting progress */
+  partNumber?: number;
+  /** Total multipart part count */
+  totalParts?: number;
+}
+
+/**
+ * Upload options.
+ *
+ */
+export interface S3UploadOptions {
+  /** Override the uploaded filename */
+  fileName?: string;
+  /** Optional storage category metadata */
+  category?: string;
+  /** Receives upload progress events */
+  onProgress?: (progress: S3UploadProgress) => void;
+}
+
 // ==================== S3 Client API ====================
 
 /**
@@ -78,13 +116,16 @@ export interface S3ClientAPI {
    * Upload a file
    * 
    * @param file - The file to upload (File or Blob)
+   * @param options - Optional filename/category and progress callback
    * @returns Upload result containing key and URL
    * 
    * @example
    * const fileInput = document.querySelector('input[type="file"]');
    * const file = fileInput.files[0];
    * 
-   * const result = await client.s3.upload(file);
+   * const result = await client.s3.upload(file, {
+   *   onProgress: ({ percentage }) => console.log(`Uploaded ${percentage}%`),
+   * });
    * if (result.data) {
    *   console.log('File uploaded:', result.data.url);
    *   console.log('File key:', result.data.key);
@@ -92,5 +133,8 @@ export interface S3ClientAPI {
    * 
    * @since 1.0.0
    */
-  upload(file: File | Blob): Promise<ClientResult<UploadRes>>;
+  upload(
+    file: File | Blob,
+    options?: S3UploadOptions,
+  ): Promise<ClientResult<UploadRes>>;
 }