@airtop/sdk 0.1.37-beta0 → 0.1.37-beta1

package/wrapper/AirtopSessions.js

@@ -152,14 +152,21 @@ class AirtopSessions extends Client_1.Sessions {
         });
     }
     /**
-     * Waits for a file to be downloaded in a session and reach 'available' status
+     * Waits for a file to be downloaded in a session and reach 'available' status.
+     * Defaults to looking back 5 seconds in the event stream for the file to be available.
+     * Use `includePriorEvents` and `lookbackSeconds` to control this behavior.
      *
-     * @param sessionId - The ID of the session to monitor
-     * @param requestOptions - Optional request configuration including timeout
-     * @returns Object containing file's id and downloadUrl, or null if timed out
+     * @param {Object} params - The parameters for the function
+     * @param {string} params.sessionId - The ID of the session to monitor
+     * @param {boolean} [params.includePriorEvents=true] - Whether to include prior events in the wait. Default `true`.
+     * @param {number} [params.lookbackSeconds=5] - The number of seconds to look back for prior events. Default `5`.
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @returns {Promise<{ id: string, downloadUrl: string } | null>} Object containing file's id and downloadUrl, or null if timed out
      */
-    waitForDownload(sessionId, requestOptions) {
+    waitForDownload(sessionId, configuration, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
+            const { includePriorEvents = true, lookbackSeconds = 5 } = configuration || {};
+            const startTime = new Date();
             const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 120;
             // Create a promise that resolves to null after the timeout
             const timeoutPromise = new Promise((resolve) => {
@@ -168,7 +175,7 @@ class AirtopSessions extends Client_1.Sessions {
             // Create a promise for the event processing
             const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
                 var _a, e_2, _b, _c;
-                const sessionEvents = yield this.events(sessionId, {}, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
+                const sessionEvents = yield this.events(sessionId, { all: includePriorEvents }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
                 try {
                     for (var _d = true, sessionEvents_2 = __asyncValues(sessionEvents), sessionEvents_2_1; sessionEvents_2_1 = yield sessionEvents_2.next(), _a = sessionEvents_2_1.done, !_a; _d = true) {
                         _c = sessionEvents_2_1.value;
@@ -176,8 +183,14 @@ class AirtopSessions extends Client_1.Sessions {
                         const event = _c;
                         const e = event;
                         if (e.event === 'file_status') {
-                            this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
                             if (e.status === 'available') {
+                                const eventTime = Date.parse(e.eventTime);
+                                this.log(`file_status message received:\n${JSON.stringify(event, null, 2)}`);
+                                const thresholdTime = startTime.getTime() - lookbackSeconds * 1000;
+                                if (eventTime < thresholdTime) {
+                                    this.log(`skipping file available event for ${e.fileId} because its timestamp is earlier than lookbackSeconds`);
+                                    continue;
+                                }
                                 return {
                                     id: e.fileId,
                                     downloadUrl: e.downloadUrl,
@@ -202,12 +215,14 @@ class AirtopSessions extends Client_1.Sessions {
     /**
      * Waits for a file download to start in a session
      *
-     * @param sessionId - The ID of the session to monitor
-     * @param requestOptions - Optional request configuration including timeout
-     * @returns Object containing file's id and downloadUrl, or null if timed out
+     * @param {Object} params - The parameters for the function
+     * @param {string} params.sessionId - The ID of the session to monitor
+     * @param {boolean} [params.includePriorEvents=false] - Whether to include prior events in the wait
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
+     * @returns {Promise<{ id: string, downloadUrl: string } | null>} Object containing file's id and downloadUrl, or null if timed out
      */
-    waitForDownloadStart(sessionId, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    waitForDownloadStart(_a, requestOptions_1) {
+        return __awaiter(this, arguments, void 0, function* ({ sessionId, includePriorEvents = false }, requestOptions) {
             const timeoutSeconds = (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) || 60;
             // Create a promise that resolves to null after the timeout
             const timeoutPromise = new Promise((resolve) => {
@@ -216,7 +231,7 @@ class AirtopSessions extends Client_1.Sessions {
             // Create a promise for the event processing
             const processEventsPromise = (() => __awaiter(this, void 0, void 0, function* () {
                 var _a, e_3, _b, _c;
-                const sessionEvents = yield this.events(sessionId, {}, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
+                const sessionEvents = yield this.events(sessionId, { all: includePriorEvents }, Object.assign({ timeoutInSeconds: timeoutSeconds }, (requestOptions || {})));
                 try {
                     for (var _d = true, sessionEvents_3 = __asyncValues(sessionEvents), sessionEvents_3_1; sessionEvents_3_1 = yield sessionEvents_3.next(), _a = sessionEvents_3_1.done, !_a; _d = true) {
                         _c = sessionEvents_3_1.value;
@@ -250,16 +265,18 @@ class AirtopSessions extends Client_1.Sessions {
     /**
      * Downloads the next file from a session as soon as it starts to become available
      *
-     * @param sessionId - The ID of the session to download from
-     * @param destinationPath - The local path where the file should be saved
-     * @param onProgress - Optional callback to track download progress
-     * @param requestOptions - Optional request configuration including timeout
+     * @param {Object} params - The parameters for the function
+     * @param {string} params.sessionId - The ID of the session to download from
+     * @param {string} params.destinationPath - The local path where the file should be saved
+     * @param {function} [params.onProgress] - Optional callback to track download progress
+     * @param {boolean} [params.includePriorEvents=false] - Whether to include prior events in the wait
+     * @param {Sessions.RequestOptions} [requestOptions] - Optional request configuration including timeout
      * @throws Error if no file is available to download within the timeout period
      */
-    downloadNextFile(sessionId, destinationPath, onProgress, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const nextFile = yield this.waitForDownload(sessionId, requestOptions);
+    downloadNextFile(_a, requestOptions_1) {
+        return __awaiter(this, arguments, void 0, function* ({ sessionId, destinationPath, onProgress, includePriorEvents = false, }, requestOptions) {
+            var _b;
+            const nextFile = yield this.waitForDownload(sessionId, { includePriorEvents }, requestOptions);
             if (!nextFile) {
                 throw new Error('No file to download within timeout');
             }
@@ -267,7 +284,7 @@ class AirtopSessions extends Client_1.Sessions {
             if (!downloadResponse.ok) {
                 throw new Error(`Failed to download file: ${downloadResponse.statusText}`);
             }
-            const totalBytes = Number.parseInt((_a = downloadResponse.headers.get('content-length')) !== null && _a !== void 0 ? _a : '0', 10);
+            const totalBytes = Number.parseInt((_b = downloadResponse.headers.get('content-length')) !== null && _b !== void 0 ? _b : '0', 10);
             let downloadedBytes = 0;
             fs.mkdirSync(path.dirname(destinationPath), { recursive: true });
             const fileStream = fs.createWriteStream(destinationPath);