@karpeleslab/klbfw 0.2.21 → 0.2.22

package/README.md

@@ -50,6 +50,48 @@ npm run test:integration
 - **Standardized Naming**: Consistent use of camelCase with backward compatibility for legacy APIs
 - **Enhanced Error Handling**: More robust error handling and reporting
 
+## Migrating from upload.append() to uploadFile()
+
+The new `uploadFile()` function provides a simpler Promise-based API for file uploads. Here are the key differences when migrating:
+
+### Return Value
+
+**Legacy `upload.append()`** resolves with an upload object containing the result in `.final`:
+```javascript
+upload.append('Misc/Debug:testUpload', file)
+  .then(result => {
+    console.log(result.final);  // The completion response data
+  });
+```
+
+**New `uploadFile()`** resolves with the full REST response:
+```javascript
+uploadFile('Misc/Debug:testUpload', buffer)
+  .then(response => {
+    console.log(response.data);  // The completion response data
+  });
+```
+
+### Migration Example
+
+Before:
+```javascript
+upload.append('Misc/Debug:testUpload', file, params, context)
+  .then(up => {
+    const data = up.final;
+    // use data
+  });
+```
+
+After:
+```javascript
+uploadFile('Misc/Debug:testUpload', file, 'POST', params, context)
+  .then(response => {
+    const data = response.data;
+    // use data
+  });
+```
+
 # API
 
 ## REST API Methods

package/index.d.ts

@@ -90,7 +90,7 @@ declare const upload: {
   onprogress?: (status: { queue: any[]; running: any[]; failed: any[] }) => void;
 };
 
-/** Upload a single file */
+/** Upload a single file. Resolves with the full REST response. */
 declare function uploadFile(
   api: string,
   buffer: UploadFileInput,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karpeleslab/klbfw",
-  "version": "0.2.21",
+  "version": "0.2.22",
   "description": "Frontend Framework",
   "main": "index.js",
   "types": "index.d.ts",

package/upload.js

@@ -37,7 +37,7 @@ const { env, utils, awsReq, readChunkFromStream, readFileSlice } = require('./up
  * @param {Function} [options.onError] - Error callback(error, context). Can return a Promise
  *   that, if resolved, will cause the failed operation to be retried. Context contains
  *   { phase, blockNum, attempt } for block uploads or { phase, attempt } for other operations.
- * @returns {Promise<Object>} - Resolves with the upload result data
+ * @returns {Promise<Object>} - Resolves with the full REST response
  *
  * @example
  * // Upload a buffer with filename
@@ -290,7 +290,7 @@ async function doPutUpload(file, uploadInfo, context, options) {
         attempt++;
         try {
             const completeResponse = await rest.rest(uploadInfo.Complete, 'POST', {}, context);
-            return completeResponse.data;
+            return completeResponse;
         } catch (error) {
             if (onError) {
                 await onError(error, { phase: 'complete', attempt });
@@ -542,7 +542,7 @@ async function doAwsUpload(file, uploadInfo, context, options) {
                 {},
                 context
             );
-            return finalResponse.data;
+            return finalResponse;
         } catch (error) {
             if (onError) {
                 await onError(error, { phase: 'handleComplete', attempt: handleAttempt });