@cumulus/cmrjs 20.1.1 → 20.1.2

package/.nycrc.json

@@ -4,8 +4,8 @@
     "*.js"
   ],
   "exclude-after-remap": false,
-  "statements": 88.0,
-  "functions": 87.0,
+  "statements": 90.0,
+  "functions": 90.0,
   "branches": 81.0,
-  "lines": 88.0
-}
+  "lines": 90.0
+}

package/cmr-utils.d.ts

@@ -23,6 +23,9 @@ export type OnlineAccessUrl = {
      */
     Type: string;
 };
+export type CMRConstructorParams = import('@cumulus/cmr-client/CMR').CMRConstructorParams;
+export type DistributionBucketMap = import('@cumulus/distribution-utils/dist/types').DistributionBucketMap;
+export type ApiFile = import('@cumulus/types').ApiFile;
 /**
  * Add ETags to file objects as some downstream functions expect this structure.
  *
@@ -42,31 +45,22 @@ export function constructCmrConceptLink(conceptId: any, extension: any): string;
 /**
  * Construct online access url for a given file and a url type.
  *
- * @param {Object} params - input parameters
  * @param {Object} params.file - file object
  * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.bucketTypes - map of bucket name to bucket type
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket name to bucket type
  * @param {Object} params.urlType - url type, distribution or s3
  * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
  *                                                               for all distribution bucketss
  * @param {boolean} [params.useDirectS3Type] - indicate if direct s3 access type is used
  * @returns {(OnlineAccessUrl | undefined)} online access url object, undefined if no URL exists
  */
-export function constructOnlineAccessUrl({ file, distEndpoint, bucketTypes, urlType, distributionBucketMap, useDirectS3Type, }: {
-    file: Object;
-    distEndpoint: string;
-    bucketTypes: Object;
-    urlType: Object;
-    distributionBucketMap: any;
-    useDirectS3Type?: boolean | undefined;
-}): (OnlineAccessUrl | undefined);
+export function constructOnlineAccessUrl({ file, distEndpoint, bucketTypes, urlType, distributionBucketMap, useDirectS3Type, }: Object): (OnlineAccessUrl | undefined);
 /**
  * Construct a list of online access urls grouped by link type.
  *
- * @param {Object} params - input parameters
  * @param {Array<Object>} params.files - array of file objects
  * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.bucketTypes - map of bucket name to bucket type
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket name to bucket type
  * @param {string} params.cmrGranuleUrlType - cmrGranuleUrlType from config
  * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
  *                                                               for all distribution bucketss
@@ -74,14 +68,7 @@ export function constructOnlineAccessUrl({ file, distEndpoint, bucketTypes, urlT
  * @returns {Promise<[{URL: string, URLDescription: string}]>} an array of
  *    online access url objects grouped by link type.
  */
-export function constructOnlineAccessUrls({ files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, useDirectS3Type, }: {
-    files: Array<Object>;
-    distEndpoint: string;
-    bucketTypes: Object;
-    cmrGranuleUrlType: string;
-    distributionBucketMap: any;
-    useDirectS3Type: boolean;
-}): Promise<[{
+export function constructOnlineAccessUrls({ files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, useDirectS3Type, }: Array<Object>): Promise<[{
     URL: string;
     URLDescription: string;
 }]>;
@@ -123,30 +110,35 @@ export function granuleToCmrFileObject({ granuleId, files }: {
  * Helper to build an CMR settings object, used to initialize CMR.
  *
  * @param {Object} cmrConfig - CMR configuration object
- * @param {string} [cmrConfig.oauthProvider] - Oauth provider: launchpad or earthdata
- * @param {string} [cmrConfig.provider] - the CMR provider
- * @param {string} [cmrConfig.clientId] - Client id for CMR requests
- * @param {string} [cmrConfig.passphraseSecretName] - Launchpad passphrase secret name
- * @param {string} [cmrConfig.api] - Launchpad api
- * @param {string} [cmrConfig.certificate] - Launchpad certificate
- * @param {string} [cmrConfig.username] - EDL username
- * @param {string} [cmrConfig.passwordSecretName] - CMR password secret name
- * @returns {Promise<import('@cumulus/cmr-client/CMR').CMRConstructorParams>}
- * object to
- * create CMR instance - contains the
+ * @param {string} cmrConfig.oauthProvider - Oauth provider: launchpad or earthdata
+ * @param {string} cmrConfig.provider - the CMR provider
+ * @param {string} cmrConfig.clientId - Client id for CMR requests
+ * @param {string} cmrConfig.passphraseSecretName - Launchpad passphrase secret name
+ * @param {string} cmrConfig.api - Launchpad api
+ * @param {string} cmrConfig.certificate - Launchpad certificate
+ * @param {string} cmrConfig.username - EDL username
+ * @param {string} cmrConfig.passwordSecretName - CMR password secret name
+ * @returns {Promise<CMRConstructorParams>} object to create CMR instance - contains the
  *    provider, clientId, and either launchpad token or EDL username and
  *    password
 */
 export function getCmrSettings(cmrConfig?: {
-    oauthProvider?: string | undefined;
-    provider?: string | undefined;
-    clientId?: string | undefined;
-    passphraseSecretName?: string | undefined;
-    api?: string | undefined;
-    certificate?: string | undefined;
-    username?: string | undefined;
-    passwordSecretName?: string | undefined;
-}): Promise<import('@cumulus/cmr-client/CMR').CMRConstructorParams>;
+    oauthProvider: string;
+    provider: string;
+    clientId: string;
+    passphraseSecretName: string;
+    api: string;
+    certificate: string;
+    username: string;
+    passwordSecretName: string;
+}): Promise<CMRConstructorParams>;
+/**
+ * Get collectionId from cmr metadata
+ * @param {object} cmrObject - cmr metadata object
+ * @param {string} cmrFileName - used to know how to parse this object
+ * @returns {string}
+ */
+export function getCMRCollectionId(cmrObject: object, cmrFileName: string): string;
 export function getFileDescription(file: any, urlType?: string): string;
 export function getFilename(file: any): any;
 /**
@@ -254,7 +246,7 @@ export function publish2CMR(cmrPublishObject: {
     username: string;
     password: string;
     token: string;
-}, cmrRevisionId: string): Promise<Object>;
+}, cmrRevisionId: string): Object;
 /**
  * Update CMR Metadata record with the information contained in updatedFiles
  * @param {Object} params - parameter object
@@ -264,7 +256,7 @@ export function publish2CMR(cmrPublishObject: {
  * @param {string} params.distEndpoint - distribution endpoint URL
  * @param {boolean} params.published - boolean true if the data should be published to
  *   the CMR service.
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - type of granule CMR url
  * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
  *                                                               for all distribution buckets
@@ -274,7 +266,9 @@ export function reconcileCMRMetadata({ granuleId, updatedFiles, distEndpoint, pu
     updatedFiles: Object;
     distEndpoint: string;
     published: boolean;
-    bucketTypes: Object;
+    bucketTypes: {
+        [key: string]: string;
+    };
     cmrGranuleUrlType: string;
     distributionBucketMap: any;
 }): Promise<void | Object>;
@@ -298,12 +292,12 @@ export function removeFromCMR(granuleUR: string, creds: CmrCredentials): Promise
  * @param {Object} params - parameter object
  * @param {string} params.granuleId - granuleId
  * @param {Object} params.cmrFile - cmr xml file to be updated
- * @param {Array<Object>} params.files - array of file objects
+ * @param {Array<ApiFile>} params.files - array of file objects
  * @param {string} params.distEndpoint - distribution enpoint from config
  * @param {boolean} params.published - indicate if publish is needed
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - type of granule CMR url
- * @param {Object} params.distributionBucketMap - Object with bucket:tea-path
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
  *    mapping for all distribution buckets
  * @returns {Promise<Object>} CMR file object with the `etag` of the newly
  *    updated metadata file
@@ -311,13 +305,61 @@ export function removeFromCMR(granuleUR: string, creds: CmrCredentials): Promise
 export function updateCMRMetadata({ granuleId, cmrFile, files, distEndpoint, published, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: {
     granuleId: string;
     cmrFile: Object;
-    files: Array<Object>;
+    files: Array<ApiFile>;
     distEndpoint: string;
     published: boolean;
-    bucketTypes: Object;
+    bucketTypes: {
+        [key: string]: string;
+    };
     cmrGranuleUrlType: string;
-    distributionBucketMap: Object;
+    distributionBucketMap: DistributionBucketMap;
 }): Promise<Object>;
+/**
+ * Update the Echo10 cmr metadata object to have corrected urls
+ *
+ * @param {Object} params.metadataObject - xml cmr metadata object
+ * @param {Array<Object>} params.files - files with which to update the cmr metadata
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
+ * @param {string} params.cmrGranuleUrlType
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
+ *    mapping for all distribution buckets
+ * @returns {Object}
+ */
+export function updateEcho10XMLMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: Object): Object;
+/**
+ * Update the UMMG cmr metadata object to have corrected urls
+ *
+ * @param {Object} params.metadataObject - ummg cmr metadata object
+ * @param {Array<ApiFile>} params.files - files with which to update the cmr metadata
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
+ * @param {string} params.cmrGranuleUrlType
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
+ *    mapping for all distribution buckets
+ * @returns {Object}
+ */
+export function updateUMMGMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: Object): Object;
+/**
+ * Update collection in an ECHO10 cmr metadata object
+ *
+ * @param {object} cmrObject - CMR metadata object
+ * @param {{ name: string, version: string }} collection - collection name and version to update to
+ * @returns {object}
+ */
+export function setECHO10Collection(cmrObject: object, collection: {
+    name: string;
+    version: string;
+}): object;
+/**
+ * Update collection in an UMMG cmr metadata object
+ *
+ * @param {object} cmrObject - CMR metadata object
+ * @param {{ name: string, version: string }} collection - collection name and version to update to
+ * @returns {object}
+ */
+export function setUMMGCollection(cmrObject: object, collection: {
+    name: string;
+    version: string;
+}): object;
 /**
  * Updates CMR xml file with 'xml' string
  *

package/cmr-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cmr-utils.d.ts","sourceRoot":"","sources":["src/cmr-utils.js"],"names":[],"mappings":"6BAsCa;IACZ,QAAY,EAAE,MAAM,CAAC;IACrB,QAAY,EAAE,MAAM,CAAC;IACrB,QAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAS,CAAC,EAAE,MAAM,CAAA;CACf;;;;;SA6aU,MAAM;;;;oBACN,MAAM;;;;iBACN,MAAM;;;;UACN,MAAM;;AArFpB;;;;;;GAMG;AACH,+CAJW,MAAM,SACN,MAAM,GACJ,MAAM,CASlB;AA/TD,gFAA+G;AAiY/G;;;;;;GAMG;AAEH;;;;;;;;;;;;GAYG;AACH;IAT0B,IAAI,EAAnB,MAAM;IACS,YAAY,EAA3B,MAAM;IACS,WAAW,EAA1B,MAAM;IACS,OAAO,EAAtB,MAAM;IACwB,qBAAqB;IAElC,eAAe;IAC9B,CAAC,eAAe,GAAG,SAAS,CAAC,CAyBzC;AAED;;;;;;;;;;;;;GAaG;AACH;IAViC,KAAK,EAA3B,MAAM,MAAM,CAAC;IACE,YAAY,EAA3B,MAAM;IACS,WAAW,EAA1B,MAAM;IACS,iBAAiB,EAAhC,MAAM;IACwB,qBAAqB;IAEnC,eAAe,EAA/B,OAAO;IACL,QAAQ,CAAC;IAAC,KAAK,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAC,CAAC,CAAC,CA0C5D;AAmQD,8DAWC;AApZD;;;;;;;;;;GAUG;AACH;IAP0B,IAAI,EAAnB,MAAM;IACS,YAAY,EAA3B,MAAM;IACS,OAAO,EAAtB,MAAM;IACwB,qBAAqB;IAEjD,CAAC,MAAM,GAAG,SAAS,CAAC,CAwBhC;AAvWD;;;;;;;;;;;GAWG;AACH;IAPkC,KAAK,EAA5B,MAAM,MAAM,CAAC;IACG,SAAS,EAAzB,MAAM;2BAGJ,MAAM,MAAM,CAAC,CAgBzB;AAynBD;;;;;;;;;;;;;;;;;EAiBE;AACF;IAd8B,aAAa;IACb,QAAQ;IACR,QAAQ;IACR,oBAAoB;IACpB,GAAG;IACH,WAAW;IACX,QAAQ;IACR,kBAAkB;IACnC,QAAQ,OAAO,yBAAyB,EAAE,oBAAoB,CAAC,CA+C3E;AArvBD,wEAMC;AAfD,4CAOC;AAqhCD;;;;;;;;GAQG;AACH,gDANW,MAAM,GACJ,QAAQ,OAAO,gBAAgB,EAAE,4BAA4B,CAAC,CAwI1E;AAnLD;;;;;;GAMG;AACH,6DAJW,MAAM,MAAM,CAAC,GACX,QAAQ,MAAM,CAAC,CAoB3B;AAphCD,+CAKC;AAihCD;;;;;;GAMG;AACH,kDAJW,MAAM,gBACN,MAAM,GACJ,MAAM,CAMlB;AA98BD;;;;;;;;GAQG;AACH,mDANW,MAAM,MAAM,CAAC,0BAIX,MAAM,MAAM,CAAC,CAIzB;AA5DD;;;;;GAKG;AACH,sCAHW,MAAM,GACJ,OAAO,CAKnB;AAfD,kDAE+B;AAH/B,qDAAuE;AAHvE,qDAAmE;AAqBnE;;;;;GAKG;AACH,sCAHW,MAAM,GACJ,OAAO,CAKnB;AA5BD,kDAAiE;AADjE,mDAAkE;AAqVlE;;;;;;GAMG;AACH,oCAJW,MAAM,EAAE,GAEN,MAAM,CASlB;AA9GD;;;;;;;;;;;;GAYG;AACH,uDATW,MAAM,8BAGJ,QAAQ,MAAM,CAAC,CAgB3B;AAtID;;;;;;;;;;;;;;;;GAgBG;AACH;IAZoC,QAAQ,EAAjC,MAAM;IACmB,cAAc,EAAvC,MAAM;IACmB,SAAS,EAAlC,MAAM;;IAEQ,QAAQ,EAAtB,MAAM;IACQ,QAAQ,EAAtB,MAAM;IACQ,QAAQ,EAAtB,MAAM;IACQ,QAAQ,EAAtB,MAAM;IACQ,KAAK,EAAnB,MAAM;kBACN,MAAM,mBAgBhB;AA8vBD;;;;;;;;;;;;;GAaG;AACH;IAX0B,SAAS,EAAxB,MAAM;IACS,YAAY,EAA3B,MAAM;IAES,YAAY,EAA3B,MAAM;IACU,SAAS,EAAzB,OAAO;IAEQ,WAAW,EAA1B,MAAM;IACS,iBAAiB,EAAhC,MAAM;IACwB,qBAAqB;2BA6B7D;AAloBD;;;;;GAKG;AACH,oDAHW,MAAM,GACJ,SAAS,CAOrB;AA7KD;;;;;GAKG;AACH,yCAHW,MAAM,SACN,cAAc,oBAKxB;AAkrBD;;;;;;;;;;;;;;;GAeG;AACH;IAZ0B,SAAS,EAAxB,MAAM;IACS,OAAO,EAAtB,MAAM;IACgB,KAAK,EAA3B,MAAM,MAAM,CAAC;IACE,YAAY,EAA3B,MAAM;IACU,SAAS,EAAzB,OAAO;IACQ,WAAW,EAA1B,MAAM;IACS,iBAAiB,EAAhC,MAAM;IACS,qBAAqB,EAApC,MAAM;IAEJ,QAAQ,MAAM,CAAC,CAkD3B;AArKD;;;;;;GAMG;AACH,yCAJY,MAAM,WACN,MAAM,gBAejB;AAjLD;;;;;;GAMG;AACH,sDAJW,MAAM,WACN,MAAM,gBAehB"}
+{"version":3,"file":"cmr-utils.d.ts","sourceRoot":"","sources":["src/cmr-utils.js"],"names":[],"mappings":"6BAkDa;IACZ,QAAY,EAAE,MAAM,CAAC;IACrB,QAAY,EAAE,MAAM,CAAC;IACrB,QAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAS,CAAC,EAAE,MAAM,CAAA;CACf;;;;;SA2aU,MAAM;;;;oBACN,MAAM;;;;iBACN,MAAM;;;;UACN,MAAM;;mCA9bP,OAAO,yBAAyB,EAAE,oBAAoB;oCACtD,OAAO,wCAAwC,EAAE,qBAAqB;sBACtE,OAAO,gBAAgB,EAAE,OAAO;AAuW7C;;;;;;GAMG;AACH,+CAJW,MAAM,SACN,MAAM,GACJ,MAAM,CASlB;AA7TD,gFAA+G;AA+X/G;;;;;;GAMG;AAEH;;;;;;;;;;;GAWG;AACH,gIATW,MAAM,GAOJ,CAAC,eAAe,GAAG,SAAS,CAAC,CAyBzC;AAED;;;;;;;;;;;;GAYG;AACH,4IAVW,MAAM,MAAM,CAAC,GAOX,QAAQ,CAAC;IAAC,KAAK,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAC,CAAC,CAAC,CA0C5D;AA6RD,8DAWC;AA5aD;;;;;;;;;;GAUG;AACH;IAP0B,IAAI,EAAnB,MAAM;IACS,YAAY,EAA3B,MAAM;IACS,OAAO,EAAtB,MAAM;IACwB,qBAAqB;IAEjD,CAAC,MAAM,GAAG,SAAS,CAAC,CAwBhC;AArWD;;;;;;;;;;;GAWG;AACH;IAPkC,KAAK,EAA5B,MAAM,MAAM,CAAC;IACG,SAAS,EAAzB,MAAM;2BAGJ,MAAM,MAAM,CAAC,CAgBzB;AAipBD;;;;;;;;;;;;;;;EAeE;AACF;IAZ6B,aAAa,EAA/B,MAAM;IACY,QAAQ,EAA1B,MAAM;IACY,QAAQ,EAA1B,MAAM;IACY,oBAAoB,EAAtC,MAAM;IACY,GAAG,EAArB,MAAM;IACY,WAAW,EAA7B,MAAM;IACY,QAAQ,EAA1B,MAAM;IACY,kBAAkB,EAApC,MAAM;IACJ,QAAQ,oBAAoB,CAAC,CA6CzC;AAqfD;;;;;GAKG;AACH,8CAJW,MAAM,eACN,MAAM,GACJ,MAAM,CAgClB;AApyCD,wEAMC;AAfD,4CAOC;AAykCD;;;;;;;;GAQG;AACH,gDANW,MAAM,GACJ,QAAQ,OAAO,gBAAgB,EAAE,4BAA4B,CAAC,CAwI1E;AAnLD;;;;;;GAMG;AACH,6DAJW,MAAM,MAAM,CAAC,GACX,QAAQ,MAAM,CAAC,CAoB3B;AAxkCD,+CAKC;AAqkCD;;;;;;GAMG;AACH,kDAJW,MAAM,gBACN,MAAM,GACJ,MAAM,CAMlB;AAlgCD;;;;;;;;GAQG;AACH,mDANW,MAAM,MAAM,CAAC,0BAIX,MAAM,MAAM,CAAC,CAIzB;AA5DD;;;;;GAKG;AACH,sCAHW,MAAM,GACJ,OAAO,CAKnB;AAfD,kDAE+B;AAH/B,qDAAuE;AAHvE,qDAAmE;AAqBnE;;;;;GAKG;AACH,sCAHW,MAAM,GACJ,OAAO,CAKnB;AA5BD,kDAAiE;AADjE,mDAAkE;AAmVlE;;;;;;GAMG;AACH,oCAJW,MAAM,EAAE,GAEN,MAAM,CASlB;AA9GD;;;;;;;;;;;;GAYG;AACH,uDATW,MAAM,8BAGJ,QAAQ,MAAM,CAAC,CAgB3B;AApID;;;;;;;;;;;;;;;;GAgBG;AACH;IAZoC,QAAQ,EAAjC,MAAM;IACmB,cAAc,EAAvC,MAAM;IACmB,SAAS,EAAlC,MAAM;;IAEQ,QAAQ,EAAtB,MAAM;IACQ,QAAQ,EAAtB,MAAM;IACQ,QAAQ,EAAtB,MAAM;IACQ,QAAQ,EAAtB,MAAM;IACQ,KAAK,EAAnB,MAAM;kBACN,MAAM,UAchB;AAozBD;;;;;;;;;;;;;GAaG;AACH;eAXW,MAAM;kBACN,MAAM;kBAEN,MAAM;eACN,OAAO;;;;uBAGP,MAAM;;2BA8BhB;AAxrBD;;;;;GAKG;AACH,oDAHW,MAAM,GACJ,SAAS,CAOrB;AA7KD;;;;;GAKG;AACH,yCAHW,MAAM,SACN,cAAc,oBAKxB;AAwuBD;;;;;;;;;;;;;;;GAeG;AACH;eAZW,MAAM;aACN,MAAM;WACN,MAAM,OAAO,CAAC;kBACd,MAAM;eACN,OAAO;;;;uBAEP,MAAM;2BACN,qBAAqB;IAEnB,QAAQ,MAAM,CAAC,CAkD3B;AA7JD;;;;;;;;;;GAUG;AACH,+IARW,MAAM,GAMJ,MAAM,CA4ClB;AA/OD;;;;;;;;;;GAUG;AACH,0IARW,MAAM,GAMJ,MAAM,CA2BlB;AA2iBD;;;;;;GAMG;AACH,+CAJW,MAAM,cACN;IAAE,MAAM,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC/B,MAAM,CAiBlB;AAED;;;;;;GAMG;AACH,6CAJW,MAAM,cACN;IAAE,MAAM,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,GAC/B,MAAM,CAYlB;AApeD;;;;;;GAMG;AACH,yCAJY,MAAM,WACN,MAAM,gBAejB;AA7MD;;;;;;GAMG;AACH,sDAJW,MAAM,WACN,MAAM,gBAehB"}

package/cmr-utils.js

@@ -1,8 +1,10 @@
 'use strict';
+//@ts-check
 const got = require('got');
 const get = require('lodash/get');
 const pick = require('lodash/pick');
 const set = require('lodash/set');
+const cloneDeep = require('lodash/cloneDeep');
 const { promisify } = require('util');
 const js2xmlParser = require('js2xmlparser');
 const path = require('path');
@@ -18,8 +20,17 @@ const errors = require('@cumulus/errors');
 const { CMR, getSearchUrl, ummVersion } = require('@cumulus/cmr-client');
 const { constructDistributionUrl } = require('@cumulus/distribution-utils');
 const { getBucketAccessUrl } = require('@cumulus/cmr-client/getUrl');
+const { constructCollectionId } = require('@cumulus/message/Collections');
 const { xmlParseOptions, ummVersionToMetadataFormat, } = require('./utils');
+/* eslint-disable max-len */
+/**
+ * @typedef {import('@cumulus/cmr-client/CMR').CMRConstructorParams} CMRConstructorParams
+ * @typedef {import('@cumulus/distribution-utils/dist/types').DistributionBucketMap} DistributionBucketMap
+ * @typedef {import('@cumulus/types').ApiFile} ApiFile
+ */
+/* eslint-enable max-len */
 const log = new Logger({ sender: '@cumulus/cmrjs/src/cmr-utils' });
+const s3CredsEndpoint = 's3credentials';
 /**
  * @typedef {{
  *   provider: string,
@@ -208,15 +219,15 @@ async function publishUMMGJSON2CMR(cmrFile, cmrClient, revisionId) {
  * @param {string} cmrRevisionId - Optional CMR Revision ID
  * if not provided, CMR username and password are used to get a cmr token
  */
-async function publish2CMR(cmrPublishObject, creds, cmrRevisionId) {
+function publish2CMR(cmrPublishObject, creds, cmrRevisionId) {
     const cmrClient = new CMR(creds);
     const cmrFileName = getFilename(cmrPublishObject);
     // choose xml or json and do the things.
     if (isECHO10Filename(cmrFileName)) {
-        return await publishECHO10XML2CMR(cmrPublishObject, cmrClient, cmrRevisionId);
+        return publishECHO10XML2CMR(cmrPublishObject, cmrClient, cmrRevisionId);
     }
     if (isUMMGFilename(cmrFileName)) {
-        return await publishUMMGJSON2CMR(cmrPublishObject, cmrClient, cmrRevisionId);
+        return publishUMMGJSON2CMR(cmrPublishObject, cmrClient, cmrRevisionId);
     }
     throw new Error(`invalid cmrPublishObject passed to publis2CMR ${JSON.stringify(cmrPublishObject)}`);
 }
@@ -431,10 +442,9 @@ function generateFileUrl({ file, distEndpoint, urlType = 'distribution', distrib
 /**
  * Construct online access url for a given file and a url type.
  *
- * @param {Object} params - input parameters
  * @param {Object} params.file - file object
  * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.bucketTypes - map of bucket name to bucket type
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket name to bucket type
  * @param {Object} params.urlType - url type, distribution or s3
  * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
  *                                                               for all distribution bucketss
@@ -461,10 +471,9 @@ function constructOnlineAccessUrl({ file, distEndpoint, bucketTypes, urlType = '
 /**
  * Construct a list of online access urls grouped by link type.
  *
- * @param {Object} params - input parameters
  * @param {Array<Object>} params.files - array of file objects
  * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.bucketTypes - map of bucket name to bucket type
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket name to bucket type
  * @param {string} params.cmrGranuleUrlType - cmrGranuleUrlType from config
  * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
  *                                                               for all distribution bucketss
@@ -510,16 +519,15 @@ function constructOnlineAccessUrls({ files, distEndpoint, bucketTypes, cmrGranul
  * @param {Object} params - input parameters
  * @param {Array<Object>} params.files - array of file objects
  * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
- * @param {string} params.s3CredsEndpoint - Optional endpoint for acquiring temporary s3 creds
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - cmrGranuleUrlType from config
- * @param {Object} params.distributionBucketMap - Object with bucket:tea-path
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
  *    mapping for all distribution buckets
  * @param {boolean} params.useDirectS3Type - indicate if direct s3 access type is used
  * @returns {Promise<[{URL: string, string, Description: string, Type: string}]>}
  *   an array of online access url objects
  */
-function constructRelatedUrls({ files, distEndpoint, bucketTypes, s3CredsEndpoint = 's3credentials', cmrGranuleUrlType = 'both', distributionBucketMap, useDirectS3Type = false, }) {
+function constructRelatedUrls({ files, distEndpoint, bucketTypes, cmrGranuleUrlType = 'both', distributionBucketMap, useDirectS3Type = false, }) {
     const credsUrl = urljoin(distEndpoint, s3CredsEndpoint);
     const s3CredentialsObject = getS3CredentialsObject(credsUrl);
     const cmrUrlObjects = constructOnlineAccessUrls({
@@ -536,7 +544,7 @@ function constructRelatedUrls({ files, distEndpoint, bucketTypes, s3CredsEndpoin
 /**
  * Create a list of URL objects that should not appear under onlineAccess in the CMR metadata.
  * @param {Array<Object>} files - array of updated file objects
- * @param {Object} bucketTypes - map of buckets name to bucket types
+ * @param {{ [key: string]: string }} bucketTypes - map of buckets name to bucket types
  * @returns {Array<Object>} array of files to be omitted in cmr's OnlineAccessURLs
  */
 function onlineAccessURLsToRemove(files, bucketTypes) {
@@ -627,6 +635,34 @@ function shouldUseDirectS3Type(metadataObject) {
     }
     return false;
 }
+/**
+ * Update the UMMG cmr metadata object to have corrected urls
+ *
+ * @param {Object} params.metadataObject - ummg cmr metadata object
+ * @param {Array<ApiFile>} params.files - files with which to update the cmr metadata
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
+ * @param {string} params.cmrGranuleUrlType
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
+ *    mapping for all distribution buckets
+ * @returns {Object}
+ */
+function updateUMMGMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType = 'both', distributionBucketMap, }) {
+    const updatedMetadataObject = cloneDeep(metadataObject);
+    const useDirectS3Type = shouldUseDirectS3Type(updatedMetadataObject);
+    const newURLs = constructRelatedUrls({
+        files,
+        distEndpoint,
+        bucketTypes,
+        cmrGranuleUrlType,
+        distributionBucketMap,
+        useDirectS3Type,
+    });
+    const removedURLs = onlineAccessURLsToRemove(files, bucketTypes);
+    const originalURLs = get(updatedMetadataObject, 'RelatedUrls', []);
+    const mergedURLs = mergeURLs(originalURLs, newURLs, removedURLs);
+    set(updatedMetadataObject, 'RelatedUrls', mergedURLs);
+    return updatedMetadataObject;
+}
 /**
  * After files are moved, create new online access URLs and then update the S3
  * UMMG cmr.json file with this information.
@@ -635,9 +671,9 @@ function shouldUseDirectS3Type(metadataObject) {
  * @param {Object} params.cmrFile - cmr.json file whose contents will be updated.
  * @param {Array<Object>} params.files - array of moved file objects.
  * @param {string} params.distEndpoint - distribution endpoint form config.
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - cmrGranuleUrlType from config
- * @param {Object} params.distributionBucketMap - Object with bucket:tea-path
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
  *    mapping for all distribution buckets
  * @returns {Promise<{ metadataObject: Object, etag: string}>} an object
  *    containing a `metadataObject` (the updated UMMG metadata object) and the
@@ -646,37 +682,30 @@ function shouldUseDirectS3Type(metadataObject) {
 async function updateUMMGMetadata({ cmrFile, files, distEndpoint, bucketTypes, cmrGranuleUrlType = 'both', distributionBucketMap, }) {
     const filename = getS3UrlOfFile(cmrFile);
     const metadataObject = await metadataObjectFromCMRJSONFile(filename);
-    const useDirectS3Type = shouldUseDirectS3Type(metadataObject);
-    const newURLs = constructRelatedUrls({
+    const updatedMetadataObject = updateUMMGMetadataObject({
+        metadataObject,
         files,
         distEndpoint,
         bucketTypes,
         cmrGranuleUrlType,
         distributionBucketMap,
-        useDirectS3Type,
     });
-    const removedURLs = onlineAccessURLsToRemove(files, bucketTypes);
-    const originalURLs = get(metadataObject, 'RelatedUrls', []);
-    const mergedURLs = mergeURLs(originalURLs, newURLs, removedURLs);
-    set(metadataObject, 'RelatedUrls', mergedURLs);
-    const { ETag: etag } = await uploadUMMGJSONCMRFile(metadataObject, cmrFile);
-    return { metadataObject, etag };
+    const { ETag: etag } = await uploadUMMGJSONCMRFile(updatedMetadataObject, cmrFile);
+    return { metadataObject: updatedMetadataObject, etag };
 }
 /**
  * Helper to build an CMR settings object, used to initialize CMR.
  *
  * @param {Object} cmrConfig - CMR configuration object
- * @param {string} [cmrConfig.oauthProvider] - Oauth provider: launchpad or earthdata
- * @param {string} [cmrConfig.provider] - the CMR provider
- * @param {string} [cmrConfig.clientId] - Client id for CMR requests
- * @param {string} [cmrConfig.passphraseSecretName] - Launchpad passphrase secret name
- * @param {string} [cmrConfig.api] - Launchpad api
- * @param {string} [cmrConfig.certificate] - Launchpad certificate
- * @param {string} [cmrConfig.username] - EDL username
- * @param {string} [cmrConfig.passwordSecretName] - CMR password secret name
- * @returns {Promise<import('@cumulus/cmr-client/CMR').CMRConstructorParams>}
- * object to
- * create CMR instance - contains the
+ * @param {string} cmrConfig.oauthProvider - Oauth provider: launchpad or earthdata
+ * @param {string} cmrConfig.provider - the CMR provider
+ * @param {string} cmrConfig.clientId - Client id for CMR requests
+ * @param {string} cmrConfig.passphraseSecretName - Launchpad passphrase secret name
+ * @param {string} cmrConfig.api - Launchpad api
+ * @param {string} cmrConfig.certificate - Launchpad certificate
+ * @param {string} cmrConfig.username - EDL username
+ * @param {string} cmrConfig.passwordSecretName - CMR password secret name
+ * @returns {Promise<CMRConstructorParams>} object to create CMR instance - contains the
  *    provider, clientId, and either launchpad token or EDL username and
  *    password
 */
@@ -762,23 +791,17 @@ function buildMergedEchoURLObject(URLlist = [], originalURLlist = [], removedURL
     return mergeURLs(originalURLlist, filteredURLObjectList, removedURLs);
 }
 /**
- * After files are moved, creates new online access URLs and then updates
- * the S3 ECHO10 CMR XML file with this information.
+ * Update the Echo10 cmr metadata object to have corrected urls
  *
- * @param {Object} params - parameter object
- * @param {Object} params.cmrFile - cmr xml file object to be updated
- * @param {Array<Object>} params.files - array of file objects
- * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
- * @param {Object} params.distributionBucketMap - Object with bucket:tea-path
+ * @param {Object} params.metadataObject - xml cmr metadata object
+ * @param {Array<Object>} params.files - files with which to update the cmr metadata
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
+ * @param {string} params.cmrGranuleUrlType
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
  *    mapping for all distribution buckets
- * @returns {Promise<{ metadataObject: Object, etag: string}>} an object
- *    containing a `metadataObject` and the `etag` of the uploaded CMR file
+ * @returns {Object}
  */
-async function updateEcho10XMLMetadata({ cmrFile, files, distEndpoint, bucketTypes, s3CredsEndpoint = 's3credentials', cmrGranuleUrlType = 'both', distributionBucketMap, }) {
-    // add/replace the OnlineAccessUrls
-    const filename = getS3UrlOfFile(cmrFile);
-    const metadataObject = await metadataObjectFromCMRXMLFile(filename);
+function updateEcho10XMLMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType = 'both', distributionBucketMap, }) {
     const metadataGranule = metadataObject.Granule;
     const updatedGranule = { ...metadataGranule };
     const originalOnlineAccessURLs = [].concat(get(metadataGranule, 'OnlineAccessURLs.OnlineAccessURL', []));
@@ -800,10 +823,40 @@ async function updateEcho10XMLMetadata({ cmrFile, files, distEndpoint, bucketTyp
     set(updatedGranule, 'OnlineAccessURLs.OnlineAccessURL', mergedOnlineAccessURLs);
     set(updatedGranule, 'OnlineResources.OnlineResource', mergedOnlineResources);
     set(updatedGranule, 'AssociatedBrowseImageUrls.ProviderBrowseUrl', mergedAssociatedBrowse);
-    metadataObject.Granule = updatedGranule;
-    const xml = generateEcho10XMLString(updatedGranule);
+    return {
+        ...metadataObject,
+        Granule: updatedGranule,
+    };
+}
+/**
+ * After files are moved, creates new online access URLs and then updates
+ * the S3 ECHO10 CMR XML file with this information.
+ *
+ * @param {Object} params - parameter object
+ * @param {Object} params.cmrFile - cmr xml file object to be updated
+ * @param {Array<Object>} params.files - array of file objects
+ * @param {string} params.distEndpoint - distribution endpoint from config
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
+ *    mapping for all distribution buckets
+ * @returns {Promise<{ metadataObject: Object, etag: string}>} an object
+ *    containing a `metadataObject` and the `etag` of the uploaded CMR file
+ */
+async function updateEcho10XMLMetadata({ cmrFile, files, distEndpoint, bucketTypes, cmrGranuleUrlType = 'both', distributionBucketMap, }) {
+    // add/replace the OnlineAccessUrls
+    const filename = getS3UrlOfFile(cmrFile);
+    const metadataObject = await metadataObjectFromCMRXMLFile(filename);
+    const updatedMetadataObject = updateEcho10XMLMetadataObject({
+        metadataObject,
+        files,
+        distEndpoint,
+        bucketTypes,
+        cmrGranuleUrlType,
+        distributionBucketMap,
+    });
+    const xml = generateEcho10XMLString(updatedMetadataObject.Granule);
     const { ETag: etag } = await uploadEcho10CMRFile(xml, cmrFile);
-    return { metadataObject, etag };
+    return { metadataObject: updatedMetadataObject, etag };
 }
 /**
  * Modifies cmr metadata file with file's URLs updated to their new locations.
@@ -811,12 +864,12 @@ async function updateEcho10XMLMetadata({ cmrFile, files, distEndpoint, bucketTyp
  * @param {Object} params - parameter object
  * @param {string} params.granuleId - granuleId
  * @param {Object} params.cmrFile - cmr xml file to be updated
- * @param {Array<Object>} params.files - array of file objects
+ * @param {Array<ApiFile>} params.files - array of file objects
  * @param {string} params.distEndpoint - distribution enpoint from config
  * @param {boolean} params.published - indicate if publish is needed
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - type of granule CMR url
- * @param {Object} params.distributionBucketMap - Object with bucket:tea-path
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
  *    mapping for all distribution buckets
  * @returns {Promise<Object>} CMR file object with the `etag` of the newly
  *    updated metadata file
@@ -864,7 +917,7 @@ async function updateCMRMetadata({ granuleId, cmrFile, files, distEndpoint, publ
  * @param {string} params.distEndpoint - distribution endpoint URL
  * @param {boolean} params.published - boolean true if the data should be published to
  *   the CMR service.
- * @param {Object} params.bucketTypes - map of bucket names to bucket types
+ * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - type of granule CMR url
  * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
  *                                                               for all distribution buckets
@@ -1032,6 +1085,63 @@ async function getGranuleTemporalInfo(granule) {
     }
     return {};
 }
+/**
+ * Update collection in an ECHO10 cmr metadata object
+ *
+ * @param {object} cmrObject - CMR metadata object
+ * @param {{ name: string, version: string }} collection - collection name and version to update to
+ * @returns {object}
+ */
+const setECHO10Collection = (cmrObject, collection) => {
+    const cmrObjectCopy = cloneDeep(cmrObject);
+    if (!cmrObjectCopy.Granule) {
+        throw new errors.ValidationError(`invalid ECHO10 cmr metadata ${JSON.stringify(cmrObjectCopy)}, must have granule tag`);
+    }
+    cmrObjectCopy.Granule.Collection = {
+        ShortName: collection.name,
+        VersionId: collection.version,
+    };
+    return cmrObjectCopy;
+};
+/**
+ * Update collection in an UMMG cmr metadata object
+ *
+ * @param {object} cmrObject - CMR metadata object
+ * @param {{ name: string, version: string }} collection - collection name and version to update to
+ * @returns {object}
+ */
+const setUMMGCollection = (cmrObject, collection) => {
+    const cmrObjectCopy = cloneDeep(cmrObject);
+    set(cmrObjectCopy, 'CollectionReference', {
+        ShortName: collection.name,
+        Version: collection.version,
+    });
+    return cmrObjectCopy;
+};
+/**
+ * Get collectionId from cmr metadata
+ * @param {object} cmrObject - cmr metadata object
+ * @param {string} cmrFileName - used to know how to parse this object
+ * @returns {string}
+ */
+const getCMRCollectionId = (cmrObject, cmrFileName) => {
+    if (isUMMGFilename(cmrFileName)) {
+        const collectionName = cmrObject.CollectionReference?.ShortName;
+        const collectionVersion = cmrObject.CollectionReference?.Version;
+        if (!(collectionName && collectionVersion)) {
+            throw new errors.ValidationError('UMMG metadata file has invalid collection configuration' +
+                ` ${JSON.stringify(cmrObject.CollectionReference)}`);
+        }
+        return constructCollectionId(collectionName, collectionVersion);
+    }
+    const collectionName = cmrObject.Granule?.Collection?.ShortName;
+    const collectionVersion = cmrObject.Granule?.Collection?.VersionId;
+    if (!(collectionName && collectionVersion)) {
+        throw new errors.ValidationError('ECHO10 metadata file has invalid collection configuration' +
+            ` ${JSON.stringify(cmrObject.Granule?.Collection)}`);
+    }
+    return constructCollectionId(collectionName, collectionVersion);
+};
 module.exports = {
     addEtagsToFileObjects,
     constructCmrConceptLink,
@@ -1041,6 +1151,7 @@ module.exports = {
     generateFileUrl,
     granuleToCmrFileObject,
     getCmrSettings,
+    getCMRCollectionId,
     getFileDescription,
     getFilename,
     getGranuleTemporalInfo,
@@ -1062,6 +1173,10 @@ module.exports = {
     removeEtagsFromFileObjects,
     removeFromCMR,
     updateCMRMetadata,
+    updateEcho10XMLMetadataObject,
+    updateUMMGMetadataObject,
+    setECHO10Collection,
+    setUMMGCollection,
     uploadEcho10CMRFile,
     uploadUMMGJSONCMRFile,
 };