@cumulus/aws-client 20.3.0 → 21.0.0

package/README.md

@@ -299,7 +299,7 @@ Invoke a Lambda function
         * [~deleteS3Object(bucket, key)](#module_S3..deleteS3Object) ⇒ <code>Promise</code>
         * [~headObject(Bucket, Key, retryOptions)](#module_S3..headObject) ⇒
         * [~s3ObjectExists(params)](#module_S3..s3ObjectExists) ⇒ <code>Promise.&lt;boolean&gt;</code>
-        * [~waitForObjectToExist()](#module_S3..waitForObjectToExist)
+        * [~waitForObjectToExist(params)](#module_S3..waitForObjectToExist) ⇒
         * [~s3PutObject(params)](#module_S3..s3PutObject)
         * [~putFile()](#module_S3..putFile)
         * [~s3CopyObject()](#module_S3..s3CopyObject)
@@ -479,15 +479,28 @@ Test if an object exists in S3
 
 <a name="module_S3..waitForObjectToExist"></a>
 
-### S3~waitForObjectToExist()
-Wait for an object to exist in S3
+### S3~waitForObjectToExist(params) ⇒
+Asynchronously waits for an S3 object to exist at a specified location.
+
+This function uses `p-wait-for` to repeatedly check for the object's existence
+until it's found or a timeout is reached. It provides configurable `interval`
+between checks and a total `timeout` duration.
 
 **Kind**: inner method of [<code>S3</code>](#module_S3)  
+**Returns**: A Promise that resolves when the S3 object is found.  
+**Throws**:
 
-| Param | Default | Description |
-| --- | --- | --- |
-| params.interval | <code>1000</code> | interval before retries, in ms |
-| params.timeout | <code>30000</code> | timeout, in ms |
+- <code>TimeoutError</code> If the object does not exist within the specified `timeout` period.
+- <code>Error</code> If an unexpected error occurs during the S3 existence check.
+
+
+| Param | Description |
+| --- | --- |
+| params | The parameters for waiting for the object. |
+| params.bucket | The name of the S3 bucket where the object is expected. |
+| params.key | The key (path) of the S3 object within the bucket. |
+| params.interval | The time in milliseconds to wait between checks. Defaults to 1000ms (1 second). |
+| params.timeout | The maximum time in milliseconds to wait before giving up and throwing a `TimeoutError`. Defaults to 30000ms (30 seconds). |
 
 <a name="module_S3..s3PutObject"></a>
 

package/S3.d.ts

@@ -78,15 +78,28 @@ export declare const s3ObjectExists: (params: {
     Key: string;
 }) => Promise<boolean>;
 /**
- * Wait for an object to exist in S3
- * @param params.interval=1000 - interval before retries, in ms
- * @param params.timeout=30000 - timeout, in ms
+ * Asynchronously waits for an S3 object to exist at a specified location.
+ *
+ * This function uses `p-wait-for` to repeatedly check for the object's existence
+ * until it's found or a timeout is reached. It provides configurable `interval`
+ * between checks and a total `timeout` duration.
+ *
+ * @param params - The parameters for waiting for the object.
+ * @param params.bucket - The name of the S3 bucket where the object is expected.
+ * @param params.key - The key (path) of the S3 object within the bucket.
+ * @param params.interval - The time in milliseconds to wait between checks.
+ * Defaults to 1000ms (1 second).
+ * @param params.timeout - The maximum time in milliseconds to wait before
+ * giving up and throwing a `TimeoutError`. Defaults to 30000ms (30 seconds).
+ * @returns A Promise that resolves when the S3 object is found.
+ * @throws {TimeoutError} If the object does not exist within the specified `timeout` period.
+ * @throws {Error} If an unexpected error occurs during the S3 existence check.
  */
 export declare const waitForObjectToExist: (params: {
     bucket: string;
     key: string;
-    interval: number;
-    timeout: number;
+    interval?: number;
+    timeout?: number;
 }) => Promise<void>;
 /**
 * Put an object on S3

package/S3.js

@@ -174,9 +174,22 @@ const s3ObjectExists = (params) => (0, exports.headObject)(params.Bucket, params
 });
 exports.s3ObjectExists = s3ObjectExists;
 /**
- * Wait for an object to exist in S3
- * @param params.interval=1000 - interval before retries, in ms
- * @param params.timeout=30000 - timeout, in ms
+ * Asynchronously waits for an S3 object to exist at a specified location.
+ *
+ * This function uses `p-wait-for` to repeatedly check for the object's existence
+ * until it's found or a timeout is reached. It provides configurable `interval`
+ * between checks and a total `timeout` duration.
+ *
+ * @param params - The parameters for waiting for the object.
+ * @param params.bucket - The name of the S3 bucket where the object is expected.
+ * @param params.key - The key (path) of the S3 object within the bucket.
+ * @param params.interval - The time in milliseconds to wait between checks.
+ * Defaults to 1000ms (1 second).
+ * @param params.timeout - The maximum time in milliseconds to wait before
+ * giving up and throwing a `TimeoutError`. Defaults to 30000ms (30 seconds).
+ * @returns A Promise that resolves when the S3 object is found.
+ * @throws {TimeoutError} If the object does not exist within the specified `timeout` period.
+ * @throws {Error} If an unexpected error occurs during the S3 existence check.
  */
 const waitForObjectToExist = async (params) => {
     const { bucket, key, interval = 1000, timeout = 30 * 1000, } = params;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/aws-client",
-  "version": "20.3.0",
+  "version": "21.0.0",
   "description": "Utilities for working with AWS",
   "keywords": [
     "GIBS",
@@ -69,10 +69,10 @@
     "@aws-sdk/s3-request-presigner": "^3.621.0",
     "@aws-sdk/signature-v4-crt": "^3.621.0",
     "@aws-sdk/types": "^3.609.0",
-    "@cumulus/checksum": "20.3.0",
-    "@cumulus/errors": "20.3.0",
-    "@cumulus/logger": "20.3.0",
-    "@cumulus/types": "20.3.0",
+    "@cumulus/checksum": "21.0.0",
+    "@cumulus/errors": "21.0.0",
+    "@cumulus/logger": "21.0.0",
+    "@cumulus/types": "21.0.0",
     "lodash": "~4.17.21",
     "mem": "^8.0.2",
     "p-map": "^1.2.0",
@@ -83,8 +83,8 @@
     "uuid": "^8.2.0"
   },
   "devDependencies": {
-    "@cumulus/test-data": "20.3.0",
+    "@cumulus/test-data": "21.0.0",
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "0d3a61cd0185f62360b3e8ab6e59f69e93ac7410"
+  "gitHead": "19bb3477969662a9e0b300f10f6df23b6c0654db"
 }