@cumulus/cmrjs 21.3.1 → 21.3.2

package/src/echo10Modifiers.ts

@@ -25,6 +25,7 @@ function isEcho10XmlBaseGranule(obj: any): obj is Echo10XmlBaseGranule {
  * @param params.xml - The parsed XML object (e.g., from xml2js) representing ECHO10 metadata.
  * @param params.granuleUr - The new GranuleUR value to apply to the metadata.
  * @param params.producerGranuleId - The original identifier value to be set as ProducerGranuleId.
+ * @param params.excludeDataGranule - Whether to add or update the DataGranule node in the metadata
  * @returns A deep-cloned and updated copy of the original ECHO10 metadata object.
  * @throws If the input object does not conform to the expected ECHO10 structure.
  */
@@ -32,10 +33,12 @@ export function updateEcho10XMLGranuleUrAndGranuleIdentifier({
   xml, // The parsed XML object (e.g., from xml2js)
   granuleUr, // The new GranuleUR value
   producerGranuleId, // The original identifier to store
+  excludeDataGranule = false, // Whether to add/update the DataGranule node in the metadata
 }: {
   xml: unknown;
   granuleUr: string;
   producerGranuleId: string;
+  excludeDataGranule?: boolean;
 }): any {
   if (!isEcho10XmlBaseGranule(xml)) {
     throw new Error('Invalid XML input - expected an object with GranuleUR');
@@ -46,46 +49,48 @@ export function updateEcho10XMLGranuleUrAndGranuleIdentifier({
   moddedXml.Granule ??= {};
   moddedXml.Granule.GranuleUR = granuleUr;
 
-  moddedXml.Granule.DataGranule ??= {};
+  if (excludeDataGranule === false) {
+    moddedXml.Granule.DataGranule ??= {};
 
-  const dataGranule = moddedXml.Granule.DataGranule as any;
-  const orderedDataGranule = new Map<string, any>();
+    const dataGranule = moddedXml.Granule.DataGranule as any;
+    const orderedDataGranule = new Map<string, any>();
 
-  // ECHO10 DataGranule element order as defined in the XSD schema
-  // https://git.earthdata.nasa.gov/projects/EMFD/repos/echo-schemas/browse/schemas/10.0/Granule.xsd
-  const echo10DataGranuleOrder = [
-    'DataGranuleSizeInBytes',
-    'SizeMBDataGranule',
-    'Checksum',
-    'ReprocessingPlanned',
-    'ReprocessingActual',
-    'ProducerGranuleId',
-    'DayNightFlag',
-    'ProductionDateTime',
-    'LocalVersionId',
-    'AdditionalFile',
-  ];
+    // ECHO10 DataGranule element order as defined in the XSD schema
+    // https://git.earthdata.nasa.gov/projects/EMFD/repos/echo-schemas/browse/schemas/10.0/Granule.xsd
+    const echo10DataGranuleOrder = [
+      'DataGranuleSizeInBytes',
+      'SizeMBDataGranule',
+      'Checksum',
+      'ReprocessingPlanned',
+      'ReprocessingActual',
+      'ProducerGranuleId',
+      'DayNightFlag',
+      'ProductionDateTime',
+      'LocalVersionId',
+      'AdditionalFile',
+    ];
 
-  const existingKeys = Object.keys(dataGranule);
-  const unexpectedKeys = existingKeys.filter((key) => !echo10DataGranuleOrder.includes(key));
+    const existingKeys = Object.keys(dataGranule);
+    const unexpectedKeys = existingKeys.filter((key) => !echo10DataGranuleOrder.includes(key));
 
-  if (unexpectedKeys.length > 0) {
-    throw new Error(
-      `Unexpected DataGranule key(s) found: ${unexpectedKeys.join(', ')}. `
-      + `Valid keys are: ${echo10DataGranuleOrder.join(', ')}. `
-      + `GranuleUR: ${moddedXml.Granule.GranuleUR}`
-    );
-  }
-
-  echo10DataGranuleOrder.forEach((key) => {
-    if (key === 'ProducerGranuleId') {
-      orderedDataGranule.set(key, producerGranuleId);
-    } else if (dataGranule[key] !== undefined) {
-      orderedDataGranule.set(key, dataGranule[key]);
+    if (unexpectedKeys.length > 0) {
+      throw new Error(
+        `Unexpected DataGranule key(s) found: ${unexpectedKeys.join(', ')}. `
+        + `Valid keys are: ${echo10DataGranuleOrder.join(', ')}. `
+        + `GranuleUR: ${moddedXml.Granule.GranuleUR}`
+      );
     }
-  });
 
-  moddedXml.Granule.DataGranule = orderedDataGranule as any;
+    echo10DataGranuleOrder.forEach((key) => {
+      if (key === 'ProducerGranuleId') {
+        orderedDataGranule.set(key, producerGranuleId);
+      } else if (dataGranule[key] !== undefined) {
+        orderedDataGranule.set(key, dataGranule[key]);
+      }
+    });
+
+    moddedXml.Granule.DataGranule = orderedDataGranule as any;
+  }
 
   return moddedXml;
 }

package/src/ummgModifiers.ts

@@ -29,6 +29,7 @@ function isUMMGGranule(obj: any): obj is UMMGGranule {
  * @param metadataObject - The parsed UMM-G metadata object to be modified.
  * @param granuleUr - The new GranuleUR value to assign.
  * @param producerGranuleId - The ProducerGranuleId to store in the Identifiers list.
+ * @param excludeDataGranule - Whether to add or update the DataGranule node in the metadata
  * @returns A deep-cloned and updated copy of the UMM-G metadata object.
  * @throws If the input does not match the expected UMM-G granule structure.
  */
@@ -37,10 +38,12 @@ export function updateUMMGGranuleURAndGranuleIdentifier({
   metadataObject,
   granuleUr,
   producerGranuleId,
+  excludeDataGranule = false,
 }: {
   metadataObject: unknown;
   granuleUr: string;
   producerGranuleId: string;
+  excludeDataGranule?: boolean;
 }): UMMGGranule {
   if (!isUMMGGranule(metadataObject)) {
     throw new Error('Invalid UMM-G JSON metadata');
@@ -49,22 +52,28 @@ export function updateUMMGGranuleURAndGranuleIdentifier({
   const moddedJson = structuredClone(metadataObject);
 
   moddedJson.GranuleUR = granuleUr;
-  moddedJson.DataGranule ??= {};
-  moddedJson.DataGranule.Identifiers ??= [];
 
-  const producerIndex = moddedJson.DataGranule.Identifiers.findIndex(
-    (id) => id.IdentifierType === 'ProducerGranuleId'
-  );
+  if (excludeDataGranule === false) {
+    moddedJson.DataGranule ??= {};
+    moddedJson.DataGranule.Identifiers ??= [];
 
-  const producerGranuleIdIdentifier = {
-    Identifier: producerGranuleId,
-    IdentifierType: 'ProducerGranuleId',
-  };
+    const producerIndex = moddedJson.DataGranule.Identifiers.findIndex(
+      (id: any) => id.IdentifierType === 'ProducerGranuleId'
+    );
+
+    const producerGranuleIdIdentifier = {
+      Identifier: producerGranuleId,
+      IdentifierType: 'ProducerGranuleId',
+    };
+
+    if (producerIndex !== -1) {
+      moddedJson.DataGranule.Identifiers[producerIndex] = producerGranuleIdIdentifier;
+    } else {
+      moddedJson.DataGranule.Identifiers.push(producerGranuleIdIdentifier);
+    }
 
-  if (producerIndex !== -1) {
-    moddedJson.DataGranule.Identifiers[producerIndex] = producerGranuleIdIdentifier;
-  } else {
-    moddedJson.DataGranule.Identifiers.push(producerGranuleIdIdentifier);
+    moddedJson.DataGranule.DayNightFlag ??= 'Unspecified';
+    moddedJson.DataGranule.ProductionDateTime ??= new Date().toISOString();
   }
 
   return moddedJson;