@cumulus/cmrjs 20.2.1 → 21.0.0

package/cmr-utils.d.ts

@@ -1,10 +1,3 @@
-export type CmrCredentials = {
-    provider: string;
-    clientId: string;
-    username?: string;
-    password?: string;
-    token?: string;
-};
 export type OnlineAccessUrl = {
     /**
      * - The generated file URL.
@@ -25,7 +18,79 @@ export type OnlineAccessUrl = {
 };
 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;
+export type ApiFileGranuleIdOptional = import('@cumulus/types').ApiFileGranuleIdOptional;
+export type ApiFileWithFilePath = ApiFileGranuleIdOptional & {
+    filepath?: string;
+};
+export type CmrFile = {
+    /**
+     * - The S3 bucket name
+     */
+    bucket: string;
+    /**
+     * - The S3 key for the metadata file
+     */
+    key: string;
+    /**
+     * - The granule ID associated with the file
+     */
+    granuleId: string;
+    /**
+     * - Optional entity tag for file versioning
+     */
+    etag?: string | undefined;
+};
+/**
+ *
+ * /**
+ */
+export type CmrCredentials = {
+    provider: string;
+    clientId: string;
+    username?: string;
+    password?: string;
+    token?: string;
+};
+export type Echo10URLObject = {
+    URL: string;
+    Type?: string | undefined;
+    Description?: string | undefined;
+    URLDescription?: string | undefined;
+};
+export type Echo10MetadataObject = {
+    /**
+     * - The root ECHO10 granule object
+     */
+    Granule: {
+        OnlineAccessURLs?: {
+            OnlineAccessURL?: Echo10URLObject[] | undefined;
+        } | undefined;
+        OnlineResources?: {
+            OnlineResource?: Echo10URLObject[] | undefined;
+        } | undefined;
+        AssociatedBrowseImageUrls?: {
+            ProviderBrowseUrl?: Echo10URLObject[] | undefined;
+        } | undefined;
+    };
+};
+export type getS3UrlOfFileFile = {
+    /**
+     * - Full S3 URI (e.g., s3://bucket/key)
+     */
+    filename?: string | undefined;
+    /**
+     * - Bucket name (used with `key` or `filepath`)
+     */
+    bucket?: string | undefined;
+    /**
+     * - S3 key (used with `bucket`)
+     */
+    key?: string | undefined;
+    /**
+     * - Alternate key for the file within the bucket
+     */
+    filepath?: string | undefined;
+};
 /**
  * Add ETags to file objects as some downstream functions expect this structure.
  *
@@ -34,6 +99,22 @@ export type ApiFile = import('@cumulus/types').ApiFile;
  * @returns {Object} - updated granule object
  */
 export function addEtagsToFileObjects(granule: Object, etags: Object): Object;
+/**
+ * Creates the query object used in POSTing to CMR.
+ * This query is a compound conditional using JSONQueryLanguage supported by CMR.
+ * This returns every collection that matches any of the short_name version pairs provided.
+ * the final query should be like
+ *  {"condition":
+ *   { "or": [{ "and": [{"short_name": "sn1"}, {"version": "001"}] },
+ *            { "and": [{"short_name": "sn2"}, {"version": "006"}] },
+ *            { "and": [{"short_name": "sn3"}, {"version": "001"}] },
+ *            .... ] } }
+ *
+ * @param {Array<Object>} results - objects with keys "short_name" and "version"
+ * @returns {Object} - query object for a post to CMR that will return all of the collections that
+ *                     match any of the results.
+ */
+export function buildCMRQuery(results: Array<Object>): Object;
 export function constructCmrConceptLink(conceptId: any, extension: any): string;
 /**
  * @typedef {Object} OnlineAccessUrl
@@ -45,33 +126,49 @@ export function constructCmrConceptLink(conceptId: any, extension: any): string;
 /**
  * Construct online access url for a given file and a url type.
  *
- * @param {Object} params.file - file object
- * @param {string} params.distEndpoint - distribution endpoint from config
- * @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
+ * @param {Object} params
+ * @param {ApiFileWithFilePath} params.file - File object
+ * @param {string} params.distEndpoint - Distribution endpoint from config
+ * @param {{ [key: string]: string }} params.bucketTypes - Map of bucket names to bucket types
+ * @param {'distribution' | 's3'} params.urlType - URL type: 'distribution' or 's3'
+ * @param {DistributionBucketMap} params.distributionBucketMap - Map of bucket to distribution path
+ * @param {boolean} [params.useDirectS3Type=false] - Whether to use direct S3 Type
+ * @returns {Echo10URLObject | undefined} - Online access URL object, or undefined if not applicable
  */
-export function constructOnlineAccessUrl({ file, distEndpoint, bucketTypes, urlType, distributionBucketMap, useDirectS3Type, }: Object): (OnlineAccessUrl | undefined);
+export function constructOnlineAccessUrl({ file, distEndpoint, bucketTypes, urlType, distributionBucketMap, useDirectS3Type, }: {
+    file: ApiFileWithFilePath;
+    distEndpoint: string;
+    bucketTypes: {
+        [key: string]: string;
+    };
+    urlType: 'distribution' | 's3';
+    distributionBucketMap: DistributionBucketMap;
+    useDirectS3Type?: boolean | undefined;
+}): Echo10URLObject | undefined;
 /**
  * Construct a list of online access urls grouped by link type.
  *
- * @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 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
- * @param {boolean} params.useDirectS3Type - indicate if direct s3 access type is used
- * @returns {Promise<[{URL: string, URLDescription: string}]>} an array of
- *    online access url objects grouped by link type.
+ * @param {Object} params
+ * @param {ApiFileWithFilePath[]} params.files - Array of file objects
+ * @param {string} params.distEndpoint - Distribution endpoint from config
+ * @param {{ [key: string]: string }} params.bucketTypes - Map of bucket name to bucket type
+ * @param {DistributionBucketMap} params.distributionBucketMap - Mapping of bucket to
+ * distribution path
+ * @param {string} [params.cmrGranuleUrlType=both] - Granule URL type: 's3',
+ * 'distribution', or 'both'
+ * @param {boolean} [params.useDirectS3Type=false] - Whether direct S3 URL types are used
+ * @returns {Echo10URLObject[]} Array of online access URL objects
  */
-export function constructOnlineAccessUrls({ files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, useDirectS3Type, }: Array<Object>): Promise<[{
-    URL: string;
-    URLDescription: string;
-}]>;
+export function constructOnlineAccessUrls({ bucketTypes, cmrGranuleUrlType, distEndpoint, distributionBucketMap, files, useDirectS3Type, }: {
+    files: ApiFileWithFilePath[];
+    distEndpoint: string;
+    bucketTypes: {
+        [key: string]: string;
+    };
+    distributionBucketMap: DistributionBucketMap;
+    cmrGranuleUrlType?: string | undefined;
+    useDirectS3Type?: boolean | undefined;
+}): Echo10URLObject[];
 export function generateEcho10XMLString(granule: any): string;
 /**
  * generate a url for a given file and a url type.
@@ -79,33 +176,24 @@ export function generateEcho10XMLString(granule: any): string;
  * @param {Object} params - input parameters
  * @param {Object} params.file - file object
  * @param {string} params.distEndpoint - distribution endpoint from config
- * @param {Object} params.urlType - url type, distribution or s3
- * @param {distributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path mapping
- *                                                               for all distribution bucketss
- * @returns {(Object | undefined)} online access url object, undefined if no URL exists
+ * @param {string} [params.urlType = 'distribution'] - url type, distribution or s3
+ * @param {Object} params.distributionBucketMap - Object with bucket:tea-path mapping
+ *                                                               for all distribution buckets
+ * @returns {(string | undefined)} online access url object, undefined if no URL exists
  */
 export function generateFileUrl({ file, distEndpoint, urlType, distributionBucketMap, }: {
     file: Object;
     distEndpoint: string;
-    urlType: Object;
-    distributionBucketMap: any;
-}): (Object | undefined);
+    urlType?: string | undefined;
+    distributionBucketMap: Object;
+}): (string | undefined);
 /**
- * Extracts CMR file objects from the specified granule object.
- *
- * @param {Object} granule - granule object containing CMR files within its
- *    `files` property
- * @param {Array<Object>} granule.files - array of files for a granule
- * @param {string} granule.granuleId - granule ID
- * @param {Function} filterFunc - function to determine if the given file object is a
-      CMR file; defaults to `isCMRFile`
- * @returns {Array<Object>} an array of CMR file objects, each with properties
- *    `granuleId`, `bucket`, `key`, and possibly `etag` (if present on input)
+ * 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 granuleToCmrFileObject({ granuleId, files }: {
-    files: Array<Object>;
-    granuleId: string;
-}, filterFunc?: Function): Array<Object>;
+export function getCMRCollectionId(cmrObject: object, cmrFileName: string): string;
 /**
  * Helper to build an CMR settings object, used to initialize CMR.
  *
@@ -133,14 +221,24 @@ export function getCmrSettings(cmrConfig?: {
     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}
+ * Call CMR to get the all matching Collections information with a compound query call.
+ *
+ * @param {Array<Object>} results - pared results from a Cumulus collection search.
+ * @returns {Promise<Object>} - resolves to the CMR return
+ * containing the found collections
  */
-export function getCMRCollectionId(cmrObject: object, cmrFileName: string): string;
+export function getCollectionsByShortNameAndVersion(results: Array<Object>): Promise<Object>;
 export function getFileDescription(file: any, urlType?: string): string;
-export function getFilename(file: any): any;
+/**
+ * Returns the file 'name' of a given object.
+ *
+ * Accepts multiple file shapes commonly used throughout Cumulus and resolves
+ * them to a valid `s3://bucket/key` URI.
+ *
+ * @param {ApiFileWithFilePath} file - API File
+ * @returns {string | undefined} - The file name, or undefined if not found
+ */
+export function getFilename(file: ApiFileWithFilePath): string | undefined;
 /**
  * Extract temporal information from granule object
  *
@@ -152,14 +250,16 @@ export function getFilename(file: any): any;
  */
 export function getGranuleTemporalInfo(granule: Object): Promise<import('@cumulus/types').PartialGranuleProcessingInfo>;
 /**
- * Call CMR to get the all matching Collections information with a compound query call.
+ * Returns the S3 URI for a given file object.
  *
- * @param {Array<Object>} results - pared results from a Cumulus collection search.
- * @returns {Promise<Object>} - resolves to the CMR return
- * containing the found collections
+ * Accepts multiple file shapes commonly used throughout Cumulus and resolves
+ * them to a valid `s3://bucket/key` URI.
+ *
+ * @param {getS3UrlOfFileFile} file - File object containing filename or bucket/key data
+ * @returns {string} - A string representing the S3 URI (e.g., `s3://bucket/key`)
+ * @throws {Error} if the file does not contain enough information to construct the URI
  */
-export function getCollectionsByShortNameAndVersion(results: Array<Object>): Promise<Object>;
-export function getS3UrlOfFile(file: any): any;
+export function getS3UrlOfFile(file: getS3UrlOfFileFile): string;
 /**
  * Call CMR to get a list of bucket/paths that a user has access to
  *
@@ -168,6 +268,15 @@ export function getS3UrlOfFile(file: any): any;
  * @returns {Object} list of bucket/paths that a user has access to
  */
 export function getUserAccessibleBuckets(edlUser: string, cmrProvider?: string): Object;
+/**
+ * Gets metadata for a CMR XML file from S3.
+ *
+ * @param {string} xmlFilePath - S3 URI to the XML metadata document
+ * @param {string} [etag] - optional entity tag for the desired version of the
+ *    CMR file
+ * @returns {Promise<string>} stringified XML document downloaded from S3
+ */
+export function getXMLMetadataAsString(xmlFilePath: string, etag?: string | undefined): Promise<string>;
 /**
  * Reduce granule object array to CMR files array
  *
@@ -175,9 +284,25 @@ export function getUserAccessibleBuckets(edlUser: string, cmrProvider?: string):
  * @param {Function} filterFunc - function to determine if the given file object is a
       CMR file; defaults to `isCMRFile`
  *
- * @returns {Array<Object>} - CMR file object array: { etag, bucket, key, granuleId }
+ * @returns {Array<CmrFile>} - CMR file object array: { etag, bucket, key, granuleId }
+ */
+export function granulesToCmrFileObjects(granules: Array<Object>, filterFunc?: Function): Array<CmrFile>;
+/**
+ * Extracts CMR file objects from the specified granule object.
+ *
+ * @param {Object} granule - granule object containing CMR files within its
+ *    `files` property
+ * @param {Array<Object>} granule.files - array of files for a granule
+ * @param {string} granule.granuleId - granule ID
+ * @param {Function} filterFunc - function to determine if the given file object is a
+      CMR file; defaults to `isCMRFile`
+ * @returns {Array<CmrFile>} an array of CMR file objects, each with properties
+ *    `granuleId`, `bucket`, `key`, and possibly `etag` (if present on input)
  */
-export function granulesToCmrFileObjects(granules: Array<Object>, filterFunc?: Function): Array<Object>;
+export function granuleToCmrFileObject({ granuleId, files }: {
+    files: Array<Object>;
+    granuleId: string;
+}, filterFunc?: Function): Array<CmrFile>;
 /**
  * Returns True if this object can be determined to be a cmrMetadata object.
  *
@@ -219,6 +344,13 @@ export function mapFileEtags(files: Object[]): Object;
  * @see isUMMGFilename
  */
 export function metadataObjectFromCMRFile(cmrFilename: string, etag?: string | undefined): Promise<Object>;
+/**
+ * Parse an xml string
+ *
+ * @param {string} xml - xml to parse
+ * @returns {Promise<Object>} promise resolves to object version of the xml
+ */
+export function parseXmlString(xml: string): Promise<Object>;
 /**
  * Determines what type of metadata object and posts either ECHO10XML or UMMG
  * JSON data to CMR.
@@ -246,7 +378,7 @@ export function publish2CMR(cmrPublishObject: {
     username: string;
     password: string;
     token: string;
-}, cmrRevisionId: string): Object;
+}, cmrRevisionId: string): Promise<Object>;
 /**
  * Update CMR Metadata record with the information contained in updatedFiles
  * @param {Object} params - parameter object
@@ -286,80 +418,207 @@ export function removeEtagsFromFileObjects(granule: Object): undefined;
  * @param {CmrCredentials} creds - credentials needed to post to CMR service
  */
 export function removeFromCMR(granuleUR: string, creds: CmrCredentials): Promise<unknown>;
+/**
+ * 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;
 /**
  * Modifies cmr metadata file with file's URLs updated to their new locations.
  *
  * @param {Object} params - parameter object
  * @param {string} params.granuleId - granuleId
- * @param {Object} params.cmrFile - cmr xml file to be updated
- * @param {Array<ApiFile>} params.files - array of file objects
+ * @param {string} [params.producerGranuleId] - producer granuleId
+ * @param {CmrFile} params.cmrFile - cmr file to be updated
+ * @param {ApiFileWithFilePath[]} params.files - array of file objects
  * @param {string} params.distEndpoint - distribution enpoint from config
  * @param {boolean} params.published - indicate if publish is needed
  * @param {{ [key: string]: string }} params.bucketTypes - map of bucket names to bucket types
  * @param {string} params.cmrGranuleUrlType - type of granule CMR url
+ * @param {boolean} [params.updateGranuleIdentifiers]
+ * - If true, update the GranuleUR and ProducerGranuleId in metadata
+ * @param {any} [params.testOverrides]
+ * - Optional test overrides for internal functions
  * @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
  */
-export function updateCMRMetadata({ granuleId, cmrFile, files, distEndpoint, published, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: {
+export function updateCMRMetadata({ granuleId, producerGranuleId, cmrFile, files, distEndpoint, published, bucketTypes, cmrGranuleUrlType, updateGranuleIdentifiers, distributionBucketMap, testOverrides, }: {
     granuleId: string;
-    cmrFile: Object;
-    files: Array<ApiFile>;
+    producerGranuleId?: string | undefined;
+    cmrFile: CmrFile;
+    files: ApiFileWithFilePath[];
     distEndpoint: string;
     published: boolean;
     bucketTypes: {
         [key: string]: string;
     };
     cmrGranuleUrlType: string;
+    updateGranuleIdentifiers?: boolean | undefined;
+    testOverrides?: any;
     distributionBucketMap: DistributionBucketMap;
 }): Promise<Object>;
 /**
- * Update the Echo10 cmr metadata object to have corrected urls
+ * Updates an ECHO10 CMR XML metadata file on S3 to reflect new URLs and optionally
+ * a new GranuleUR and ProducerGranuleId.
  *
- * @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}
+ * @param {Object} params
+ * @param {string} params.granuleId - New GranuleUR to set in metadata
+ * @param {string} params.producerGranuleId - Original ProducerGranuleId to record
+ * @param {CmrFile} params.cmrFile - The cmr xml file to be updated
+ * @param {ApiFileWithFilePath[]} params.files - List of granule files used
+ * to generate OnlineAccess URLs
+ * @param {string} params.distEndpoint - Distribution endpoint for download URLs
+ * @param {{ [bucket: string]: string }} params.bucketTypes - Mapping of bucket names to their types
+ * @param {string} [params.cmrGranuleUrlType]
+ * - Type of URLs to generate ('distribution' | 's3' | 'both')
+ * @param {DistributionBucketMap} params.distributionBucketMap
+ * - Maps buckets to distribution paths
+ * @param {boolean} [params.updateGranuleIdentifiers]
+ * - If true, update the GranuleUR and ProducerGranuleId in metadata
+ * @param {any} [params.testOverrides]
+ * - Optional test overrides for internal functions
+ * @returns {Promise<{ metadataObject: any, etag: string }>}
+ * The updated metadata object and resulting ETag
  */
-export function updateEcho10XMLMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: Object): Object;
+export function updateEcho10XMLMetadata({ granuleId, producerGranuleId, cmrFile, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, updateGranuleIdentifiers, testOverrides, }: {
+    granuleId: string;
+    producerGranuleId: string;
+    cmrFile: CmrFile;
+    files: ApiFileWithFilePath[];
+    distEndpoint: string;
+    bucketTypes: {
+        [bucket: string]: string;
+    };
+    cmrGranuleUrlType?: string | undefined;
+    distributionBucketMap: DistributionBucketMap;
+    updateGranuleIdentifiers?: boolean | undefined;
+    testOverrides?: any;
+}): Promise<{
+    metadataObject: any;
+    etag: string;
+}>;
 /**
- * Update the UMMG cmr metadata object to have corrected urls
+ * Updates the OnlineAccessURLs, OnlineResources, and AssociatedBrowseImageUrls
+ * fields of an ECHO10 CMR metadata object with newly constructed 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}
+ * This function:
+ * - Extracts the original URL sets from the ECHO10 XML metadata.
+ * - Constructs new URL entries based on the provided file list and configuration.
+ * - Merges new URLs with original ones, removing outdated or irrelevant URLs.
+ * - Returns a new metadata object with an updated `Granule` field.
+ *
+ * @param {Object} params - Input parameters
+ * @param {Echo10MetadataObject} params.metadataObject - The parsed ECHO10 metadata XML
+ * object (as a JavaScript object), expected to include a `Granule` key
+ * @param {ApiFileWithFilePath[]} params.files - Granule files to generate
+ *  updated URLs from
+ * @param {string} params.distEndpoint - The base distribution endpoint URL
+ * (e.g., CloudFront origin)
+ * @param {{ [bucketName: string]: string }} params.bucketTypes - Mapping of bucket names
+ *  to access types ('public', 'protected', etc.)
+ * @param {string} [params.cmrGranuleUrlType='both'] - Type of URLs to generate
+ *  for CMR: 'distribution', 's3', or 'both'
+ * @param {DistributionBucketMap} params.distributionBucketMap - Maps S3 buckets to their
+ *  distribution URL paths
+ *
+ * @returns {Echo10MetadataObject} A new ECHO10 metadata object with updated
+ *  `Granule.OnlineAccessURLs`, `Granule.OnlineResources`, and `Granule.AssociatedBrowseImageUrls`
+ *  fields
  */
-export function updateUMMGMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: Object): Object;
+export function updateEcho10XMLMetadataObjectUrls({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: {
+    metadataObject: Echo10MetadataObject;
+    files: ApiFileWithFilePath[];
+    distEndpoint: string;
+    bucketTypes: {
+        [bucketName: string]: string;
+    };
+    cmrGranuleUrlType?: string | undefined;
+    distributionBucketMap: DistributionBucketMap;
+}): Echo10MetadataObject;
 /**
- * Update collection in an ECHO10 cmr metadata object
+ * After files are moved, create new online access URLs and then update the S3
+ * UMMG cmr.json file with this information.
  *
- * @param {object} cmrObject - CMR metadata object
- * @param {{ name: string, version: string }} collection - collection name and version to update to
- * @returns {object}
+ * @param {Object} params - parameter object
+ * @param {CmrFile} params.cmrFile - cmr.json file whose contents will be updated.
+ * @param {ApiFileWithFilePath[]} params.files - array of moved file objects.
+ * @param {string} params.distEndpoint - distribution endpoint form config.
+ * @param {{ [bucket: string]: string }} params.bucketTypes - map of bucket names to bucket types
+ * @param {string} params.cmrGranuleUrlType - cmrGranuleUrlType from config
+ * @param {DistributionBucketMap} params.distributionBucketMap - Object with bucket:tea-path
+ *    mapping for all distribution buckets
+ * @param {string} params.producerGranuleId - producer granule id
+ * @param {string} params.granuleId - granule id
+ * @param {boolean} [params.updateGranuleIdentifiers=false] - whether to update the granule UR/add
+ * producerGranuleID to the CMR metadata object
+ * @param {any} [params.testOverrides] - overrides for testing
+ * @returns {Promise<{ metadataObject: Object, etag: string | undefined}>} an object
+ *    containing a `metadataObject` (the updated UMMG metadata object) and the
+ *    `etag` of the uploaded CMR file
  */
-export function setECHO10Collection(cmrObject: object, collection: {
-    name: string;
-    version: string;
-}): object;
+export function updateUMMGMetadata({ cmrFile, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, producerGranuleId, granuleId, updateGranuleIdentifiers, testOverrides, }: {
+    cmrFile: CmrFile;
+    files: ApiFileWithFilePath[];
+    distEndpoint: string;
+    bucketTypes: {
+        [bucket: string]: string;
+    };
+    cmrGranuleUrlType: string;
+    distributionBucketMap: DistributionBucketMap;
+    producerGranuleId: string;
+    granuleId: string;
+    updateGranuleIdentifiers?: boolean | undefined;
+    testOverrides?: any;
+}): Promise<{
+    metadataObject: Object;
+    etag: string | undefined;
+}>;
 /**
- * Update collection in an UMMG cmr metadata object
+ * Update the UMMG cmr metadata object to have corrected urls
  *
- * @param {object} cmrObject - CMR metadata object
- * @param {{ name: string, version: string }} collection - collection name and version to update to
- * @returns {object}
+ * @param {Object} params - Parameters for updating the metadata object
+ * @param {Object} params.metadataObject - The existing UMMG CMR metadata object to update
+ * @param {ApiFileWithFilePath[]} params.files - Array of file
+ * objects used to generate URLs
+ * @param {string} params.distEndpoint - Base URL for distribution endpoints (e.g., CloudFront)
+ * @param {{ [bucket: string]: string }} params.bucketTypes - Map of bucket names
+ * to types (e.g., public, protected)
+ * @param {string} [params.cmrGranuleUrlType='both'] - Type of URLs to generate: 'distribution',
+ * 's3', or 'both'
+ * @param {DistributionBucketMap} params.distributionBucketMap - Mapping of bucket names to
+ * distribution paths
+ *
+ * @returns {Object} - A deep clone of the original metadata object with updated RelatedUrls
  */
-export function setUMMGCollection(cmrObject: object, collection: {
-    name: string;
-    version: string;
-}): object;
+export function updateUMMGMetadataObject({ metadataObject, files, distEndpoint, bucketTypes, cmrGranuleUrlType, distributionBucketMap, }: {
+    metadataObject: Object;
+    files: ApiFileWithFilePath[];
+    distEndpoint: string;
+    bucketTypes: {
+        [bucket: string]: string;
+    };
+    cmrGranuleUrlType?: string | undefined;
+    distributionBucketMap: DistributionBucketMap;
+}): Object;
 /**
  * Updates CMR xml file with 'xml' string
  *
@@ -372,8 +631,12 @@ export function uploadEcho10CMRFile(xml: string, cmrFile: Object): Promise<any>;
  * Updates CMR JSON file with stringified 'metadataObject'
  *
  * @param {Object} metadataObject - JSON Object to stringify
- * @param {Object} cmrFile - cmr file object to write body to
- * @returns {Promise} returns promised promiseS3Upload response
+ * @param {CmrFile} cmrFile - cmr file object to write body to
+ * @returns {Promise<{[key: string]: any, ETag?: string | undefined }>} returns promised
+ * promiseS3Upload response
  */
-export function uploadUMMGJSONCMRFile(metadataObject: Object, cmrFile: Object): Promise<any>;
+export function uploadUMMGJSONCMRFile(metadataObject: Object, cmrFile: CmrFile): Promise<{
+    [key: string]: any;
+    ETag?: string | undefined;
+}>;
 //# sourceMappingURL=cmr-utils.d.ts.map

package/cmr-utils.d.ts.map

@@ -1 +1 @@
-{"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"}
+{"version":3,"file":"cmr-utils.d.ts","sourceRoot":"","sources":["src/cmr-utils.js"],"names":[],"mappings":";;;;SAqjBc,MAAM;;;;oBACN,MAAM;;;;iBACN,MAAM;;;;UACN,MAAM;;mCA7gBP,OAAO,yBAAyB,EAAE,oBAAoB;oCACtD,OAAO,wCAAwC,EAAE,qBAAqB;uCACtE,OAAO,gBAAgB,EAAE,wBAAwB;kCAChD,wBAAwB,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE;;;;;YAKhD,MAAM;;;;SACN,MAAM;;;;eACN,MAAM;;;;;;;;;;6BAMP;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;;SAKU,MAAM;;;;;;;;;;QAS4C,gBAAgB;;;QACjB,eAAe;;;QACZ,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;AAkZ3F;;;;;;GAMG;AACH,+CAJW,MAAM,SACN,MAAM,GACJ,MAAM,CASlB;AAqzBD;;;;;;;;;;;;;;GAcG;AACH,uCAJW,MAAM,MAAM,CAAC,GACX,MAAM,CASlB;AA3oCD,gFAA+G;AAmY/G;;;;;;GAMG;AAEH;;;;;;;;;;;GAWG;AACH;UARW,mBAAmB;kBACnB,MAAM;;;;aAEN,cAAc,GAAG,IAAI;2BACrB,qBAAqB;;IAEnB,eAAe,GAAG,SAAS,CAyBvC;AAED;;;;;;;;;;;;;GAaG;AACH;WAVW,mBAAmB,EAAE;kBACrB,MAAM;;;;2BAEN,qBAAqB;;;IAKnB,eAAe,EAAE,CA6C7B;AA8TD,8DAWC;AAldD;;;;;;;;;;GAUG;AACH;IAP0B,IAAI,EAAnB,MAAM;IACS,YAAY,EAA3B,MAAM;IACU,OAAO;IACR,qBAAqB,EAApC,MAAM;IAEJ,CAAC,MAAM,GAAG,SAAS,CAAC,CAwBhC;AA4+BD;;;;;GAKG;AACH,8CAJW,MAAM,eACN,MAAM,GACJ,MAAM,CAgClB;AArqBD;;;;;;;;;;;;;;;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;AAwWD;;;;;;GAMG;AACH,6DAJW,MAAM,MAAM,CAAC,GACX,QAAQ,MAAM,CAAC,CAoB3B;AArrCD,wEAMC;AAxBD;;;;;;;;GAQG;AACH,kCAHW,mBAAmB,GACjB,MAAM,GAAG,SAAS,CAS9B;AAssCD;;;;;;;;GAQG;AACH,gDANW,MAAM,GACJ,QAAQ,OAAO,gBAAgB,EAAE,4BAA4B,CAAC,CAwI1E;AAn3CD;;;;;;;;;GASG;AACH,qCAJW,kBAAkB,GAChB,MAAM,CAQlB;AA2sCD;;;;;;GAMG;AACH,kDAJW,MAAM,gBACN,MAAM,GACJ,MAAM,CAMlB;AAx/BD;;;;;;;GAOG;AACH,oDALW,MAAM,8BAGJ,QAAQ,MAAM,CAAC,CAQ3B;AArJD;;;;;;;;GAQG;AACH,mDANW,MAAM,MAAM,CAAC,0BAIX,MAAM,OAAO,CAAC,CAI1B;AAtCD;;;;;;;;;;;GAWG;AACH;IAPkC,KAAK,EAA5B,MAAM,MAAM,CAAC;IACG,SAAS,EAAzB,MAAM;2BAGJ,MAAM,OAAO,CAAC,CAgB1B;AA/CD;;;;;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;AAuVlE;;;;;;GAMG;AACH,oCAJW,MAAM,EAAE,GAEN,MAAM,CASlB;AAlHD;;;;;;;;;;;;GAYG;AACH,uDATW,MAAM,8BAGJ,QAAQ,MAAM,CAAC,CAgB3B;AAzDD;;;;;GAKG;AACH,oCAHW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAI3B;AAnFD;;;;;;;;;;;;;;;;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,mBAchB;AAi7BD;;;;;;;;;;;;;GAaG;AACH;eAXW,MAAM;kBACN,MAAM;kBAEN,MAAM;eACN,OAAO;;;;uBAGP,MAAM;;2BA8BhB;AAjzBD;;;;;GAKG;AACH,oDAHW,MAAM,GACJ,SAAS,CAOrB;AAjLD;;;;;GAKG;AACH,yCAHW,MAAM,SACN,cAAc,oBAKxB;AA4pCD;;;;;;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;AAhXD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;eAjBW,MAAM;;aAEN,OAAO;WACP,mBAAmB,EAAE;kBACrB,MAAM;eACN,OAAO;;;;uBAEP,MAAM;;oBAGN,GAAG;2BAEH,qBAAqB;IAEnB,QAAQ,MAAM,CAAC,CA6D3B;AA3JD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH;eAnBW,MAAM;uBACN,MAAM;aACN,OAAO;WACP,mBAAmB,EAAE;kBAErB,MAAM;;;;;2BAIN,qBAAqB;;oBAIrB,GAAG;;oBAEyB,GAAG;UAAQ,MAAM;GAsDvD;AA/JD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH;oBAjBW,oBAAoB;WAEpB,mBAAmB,EAAE;kBAErB,MAAM;;;;;2BAMN,qBAAqB;IAGnB,oBAAoB,CA2DhC;AAhQD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;aAhBW,OAAO;WACP,mBAAmB,EAAE;kBACrB,MAAM;;;;uBAEN,MAAM;2BACN,qBAAqB;uBAErB,MAAM;eACN,MAAM;;oBAGN,GAAG;;oBACyB,MAAM;UAAQ,MAAM,GAAG,SAAS;GA4CtE;AA1GD;;;;;;;;;;;;;;;;GAgBG;AACH;oBAbW,MAAM;WACN,mBAAmB,EAAE;kBAErB,MAAM;;;;;2BAKN,qBAAqB;IAGnB,MAAM,CA4BlB;AAyID;;;;;;GAMG;AACH,yCAJY,MAAM,WACN,MAAM,gBAejB;AA9OD;;;;;;;GAOG;AACH,sDALW,MAAM,WACN,OAAO;;WAC+B,MAAM,GAAG,SAAS;GAelE"}