@devrev/airsync-sdk 2.0.0-beta.4 → 2.0.0-beta.6

package/dist/uploader/uploader.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Uploader = void 0;
 const form_data_1 = __importDefault(require("form-data"));
 const js_jsonl_1 = require("js-jsonl");
-const client_1 = require("../http/client");
 const constants_1 = require("../common/constants");
+const client_1 = require("../http/client");
 const logger_1 = require("../logger/logger");
 const uploader_helpers_1 = require("./uploader.helpers");
 class Uploader {
@@ -22,17 +22,11 @@ class Uploader {
             Authorization: `Bearer ${this.devrevApiToken}`,
         };
     }
-    /**
-     * Uploads the fetched objects to the DevRev platform. Fetched objects are compressed to a gzipped jsonl object and uploaded to the platform.
-     * @param {string} itemType - The type of the item to be uploaded
-     * @param {object[] | object} fetchedObjects - The objects to be uploaded
-     * @returns {Promise<UploadResponse>} - The response object containing the artifact information or error information if there was an error
-     */
+    /** Compresses fetched objects to gzipped JSONL and uploads them as an artifact. */
     async upload(itemType, fetchedObjects) {
         if (this.isLocalDevelopment) {
             await (0, uploader_helpers_1.downloadToLocal)(itemType, fetchedObjects);
         }
-        // Compress the fetched objects to a gzipped jsonl object
         const { response: file, error: fileError } = (0, uploader_helpers_1.compressGzip)(js_jsonl_1.jsonl.stringify(fetchedObjects));
         if (fileError) {
             return {
@@ -44,7 +38,6 @@ class Uploader {
         }
         const filename = itemType + '.jsonl.gz';
         const fileType = 'application/x-gzip';
-        // Get upload url
         const { error: preparedArtifactError, response: preparedArtifact } = await this.getArtifactUploadUrl(filename, fileType);
         if (preparedArtifactError) {
             return {
@@ -54,7 +47,6 @@ class Uploader {
                 },
             };
         }
-        // Upload prepared artifact to the given url
         const { error: uploadItemError } = await this.uploadArtifact(preparedArtifact, file);
         if (uploadItemError) {
             return {
@@ -64,10 +56,9 @@ class Uploader {
                 },
             };
         }
-        // Skip confirmation for External Sync Units, as this confirmation attachments
-        // uploads to the sync, which we haven't created yet when extracting External Sync Units.
+        // Skip confirmation for External Sync Units: confirmation attaches the upload
+        // to the sync, which doesn't exist yet when extracting External Sync Units.
         if (!this.skipConfirmation) {
-            // Confirm upload
             const { error: confirmArtifactUploadError } = await this.confirmArtifactUpload(preparedArtifact.artifact_id);
             if (confirmArtifactUploadError) {
                 return {
@@ -78,21 +69,10 @@ class Uploader {
                 };
             }
         }
-        // Return the artifact information to the platform
-        const artifact = {
-            id: preparedArtifact.artifact_id,
-            item_type: itemType,
-            item_count: Array.isArray(fetchedObjects) ? fetchedObjects.length : 1,
-        };
+        const artifactDateRanges = (0, uploader_helpers_1.computeArtifactDateRanges)(fetchedObjects);
+        const artifact = Object.assign({ id: preparedArtifact.artifact_id, item_type: itemType, item_count: Array.isArray(fetchedObjects) ? fetchedObjects.length : 1 }, artifactDateRanges);
         return { artifact };
     }
-    /**
-     * Gets the upload URL for an artifact from the DevRev API.
-     * @param {string} filename - The name of the file to upload
-     * @param {string} fileType - The MIME type of the file
-     * @param {number} [fileSize] - Optional file size in bytes
-     * @returns {Promise<ArtifactToUpload | void>} The artifact upload information or undefined on error
-     */
     async getArtifactUploadUrl(filename, fileType, fileSize) {
         const url = `${this.devrevApiEndpoint}/internal/airdrop.artifacts.upload-url`;
         if (fileSize !== undefined && fileSize <= 0) {
@@ -116,12 +96,7 @@ class Uploader {
             return { error };
         }
     }
-    /**
-     * Uploads an artifact file to the provided upload URL using multipart form data.
-     * @param {ArtifactToUpload} artifact - The artifact upload information containing upload URL and form data
-     * @param {Buffer} file - The file buffer to upload
-     * @returns {Promise<AxiosResponse | void>} The axios response or undefined on error
-     */
+    /** Uploads the file buffer to the artifact's upload URL as multipart form data. */
     async uploadArtifact(artifact, file) {
         const formData = new form_data_1.default();
         for (const field in artifact.form_data) {
@@ -138,30 +113,24 @@ class Uploader {
             return { error };
         }
     }
-    /**
-     * Streams an artifact file from an HTTP streaming response to the upload URL.
-     * @param {ArtifactToUpload} artifact - The artifact upload information containing upload URL and form data
-     * @param {HttpStreamResponse} fileStream - The HTTP streaming response containing the file data
-     * @returns {Promise<AxiosResponse | void>} The axios response or undefined on error
-     */
+    /** Streams a file from an HTTP response directly to the artifact's upload URL. */
     async streamArtifact(artifact, fileStream) {
         const formData = new form_data_1.default();
         for (const field in artifact.form_data) {
             formData.append(field, artifact.form_data[field]);
         }
         formData.append('file', fileStream.data);
+        const hasContentLength = !!fileStream.headers['content-length'];
         try {
-            const response = await client_1.axiosClient.post(artifact.upload_url, formData, {
-                headers: Object.assign(Object.assign({}, formData.getHeaders()), (!fileStream.headers['content-length']
+            const response = await client_1.axiosClient.post(artifact.upload_url, formData, Object.assign({ headers: Object.assign(Object.assign({}, formData.getHeaders()), (!hasContentLength
                     ? {
                         'Content-Length': constants_1.MAX_DEVREV_ARTIFACT_SIZE,
                     }
-                    : {})),
-                // Prevents buffering of the response in the memory
-                maxRedirects: 0,
-                // Allow 2xx and 3xx (redirects) to be considered successful, 4xx and 5xx will throw errors and be caught in the catch block
-                validateStatus: (status) => status >= 200 && status < 400,
-            });
+                    : {})), 
+                // Prevents buffering of the response in memory
+                maxRedirects: 0, 
+                // 2xx and 3xx are success; 4xx/5xx throw into the catch block
+                validateStatus: (status) => status >= 200 && status < 400 }, (!hasContentLength ? { 'axios-retry': { retries: 0 } } : {})));
             this.destroyStream(fileStream);
             return { response };
         }
@@ -170,11 +139,6 @@ class Uploader {
             return { error };
         }
     }
-    /**
-     * Confirms that an artifact upload has been completed successfully.
-     * @param {string} artifactId - The ID of the artifact to confirm
-     * @returns {Promise<AxiosResponse | void>} The axios response or undefined on error
-     */
     async confirmArtifactUpload(artifactId) {
         const url = `${this.devrevApiEndpoint}/internal/airdrop.artifacts.confirm-upload`;
         try {
@@ -184,7 +148,6 @@ class Uploader {
             }, {
                 headers: Object.assign({}, this.defaultHeaders),
             });
-            // If response exists and the status is 2xx, return the response
             if ((response === null || response === void 0 ? void 0 : response.status) >= 200 && (response === null || response === void 0 ? void 0 : response.status) < 300) {
                 return { response };
             }
@@ -201,14 +164,10 @@ class Uploader {
             return { error: { message: (0, logger_1.serializeError)(error) } };
         }
     }
-    /**
-     * Destroys a stream to prevent resource leaks.
-     * @param {HttpStreamResponse} fileStream - The HTTP streaming response to destroy
-     */
     destroyStream(fileStream) {
         try {
             if (fileStream && fileStream.data) {
-                // For axios response streams, the data property contains the actual stream
+                // For axios response streams, `data` holds the actual stream
                 if (typeof fileStream.data.destroy === 'function') {
                     fileStream.data.destroy();
                 }
@@ -221,14 +180,8 @@ class Uploader {
             console.warn('Error while destroying stream:', (0, logger_1.serializeError)(error));
         }
     }
-    /**
-     * Retrieves attachment metadata from an artifact by downloading and parsing it.
-     * @param {object} param0 - Configuration object
-     * @param {string} param0.artifact - The artifact ID to download attachments from
-     * @returns {Promise<{attachments?: NormalizedAttachment[], error?: {message: string}}>} The attachments array or error object
-     */
+    /** Downloads an artifact and parses it into attachment metadata. */
     async getAttachmentsFromArtifactId({ artifact, }) {
-        // Get the URL of the attachments metadata artifact
         const { response: artifactUrl, error: artifactUrlError } = await this.getArtifactDownloadUrl(artifact);
         if (artifactUrlError) {
             return {
@@ -238,7 +191,6 @@ class Uploader {
                 },
             };
         }
-        // Download artifact from the URL
         const { response: gzippedJsonlObject, error: gzippedJsonlObjectError } = await this.downloadArtifact(artifactUrl);
         if (gzippedJsonlObjectError) {
             return {
@@ -248,7 +200,6 @@ class Uploader {
                 },
             };
         }
-        // Decompress the gzipped jsonl object
         const { response: jsonlObject, error: jsonlObjectError } = (0, uploader_helpers_1.decompressGzip)(gzippedJsonlObject);
         if (jsonlObjectError) {
             return {
@@ -258,7 +209,6 @@ class Uploader {
                 },
             };
         }
-        // Parse the jsonl object to get the attachment metadata
         const { response: jsonObject, error: jsonObjectError } = (0, uploader_helpers_1.parseJsonl)(jsonlObject);
         if (jsonObjectError) {
             return {
@@ -270,11 +220,6 @@ class Uploader {
         }
         return { attachments: jsonObject };
     }
-    /**
-     * Gets the download URL for an artifact from the DevRev API.
-     * @param {string} artifactId - The ID of the artifact to download
-     * @returns {Promise<string | void>} The download URL or undefined on error
-     */
     async getArtifactDownloadUrl(artifactId) {
         const url = `${this.devrevApiEndpoint}/internal/airdrop.artifacts.download-url`;
         try {
@@ -291,11 +236,6 @@ class Uploader {
             return { error };
         }
     }
-    /**
-     * Downloads an artifact file from the given URL.
-     * @param {string} artifactUrl - The URL to download the artifact from
-     * @returns {Promise<Buffer | void>} The artifact file buffer or undefined on error
-     */
     async downloadArtifact(artifactUrl) {
         try {
             const response = await client_1.axiosClient.get(artifactUrl, {
@@ -307,13 +247,7 @@ class Uploader {
             return { error };
         }
     }
-    /**
-     * Retrieves and parses JSON objects from an artifact by artifact ID.
-     * @param {object} param0 - Configuration object
-     * @param {string} param0.artifactId - The artifact ID to download and parse
-     * @param {boolean} [param0.isGzipped=false] - Whether the artifact is gzipped
-     * @returns {Promise<object[] | object | void>} The parsed JSON objects or undefined on error
-     */
+    /** Downloads an artifact (optionally gzipped) and parses it as JSONL. */
     async getJsonObjectByArtifactId({ artifactId, isGzipped = false, }) {
         const { response: artifactUrl, error: artifactUrlError } = await this.getArtifactDownloadUrl(artifactId);
         if (artifactUrlError) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devrev/airsync-sdk",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.6",
   "description": "Typescript SDK for building AirSync snap-ins on the DevRev platform.",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -38,6 +38,7 @@
     "eslint": "9.32.0",
     "eslint-config-prettier": "^9.1.2",
     "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-simple-import-sort": "^13.0.0",
     "jest": "^29.7.0",
     "jiti": "^2.6.1",
     "prettier": "^2.8.3",
@@ -46,8 +47,8 @@
     "typescript-eslint": "^8.46.1"
   },
   "dependencies": {
-    "@devrev/typescript-sdk": "^1.1.74",
-    "axios": "^1.15.2",
+    "@devrev/typescript-sdk": "^1.1.76",
+    "axios": "^1.17.0",
     "axios-retry": "^4.5.0",
     "form-data": "^4.0.4",
     "js-jsonl": "^1.1.1",
@@ -56,6 +57,7 @@
   },
   "files": [
     "dist/**/*",
-    "!dist/tests/**/*"
+    "!dist/tests/**/*",
+    "MIGRATION.md"
   ]
 }