@cumulus/cmrjs 20.3.0 → 21.0.0-echo10

package/src/echo10Modifiers.ts

@@ -0,0 +1,91 @@
+type Echo10XmlBaseGranule = {
+  Granule: {
+    GranuleUR?: string;
+    DataGranule?: {
+      ProducerGranuleId?: string;
+    }
+    [key: string]: unknown;
+  };
+};
+
+function isEcho10XmlBaseGranule(obj: any): obj is Echo10XmlBaseGranule {
+  return typeof obj === 'object' && obj !== null
+    && obj.Granule?.GranuleUR !== undefined;
+}
+
+/**
+ * Updates an ECHO10 metadata XML object with a new GranuleUR and ProducerGranuleId.
+ *
+ * This function:
+ * - Validates that the input is a minimally valid ECHO10 metadata object.
+ * - Performs a deep clone to avoid mutating the original input.
+ * - Sets the new `GranuleUR` and `ProducerGranuleId` values accordingly.
+ *
+ * @param params
+ * @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.
+ * @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.
+ */
+export function updateEcho10XMLGranuleUrAndGranuleIdentifier({
+  xml, // The parsed XML object (e.g., from xml2js)
+  granuleUr, // The new GranuleUR value
+  producerGranuleId, // The original identifier to store
+}: {
+  xml: unknown;
+  granuleUr: string;
+  producerGranuleId: string;
+}): any {
+  if (!isEcho10XmlBaseGranule(xml)) {
+    throw new Error('Invalid XML input - expected an object with GranuleUR');
+  }
+
+  const moddedXml = structuredClone(xml);
+
+  moddedXml.Granule ??= {};
+  moddedXml.Granule.GranuleUR = granuleUr;
+
+  moddedXml.Granule.DataGranule ??= {};
+
+  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',
+  ];
+
+  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]);
+    }
+  });
+
+  moddedXml.Granule.DataGranule = orderedDataGranule as any;
+
+  return moddedXml;
+}

package/src/ummgModifiers.ts

@@ -0,0 +1,71 @@
+// Implementation against https://git.earthdata.nasa.gov/projects/EMFD/repos/unified-metadata-model/browse/granule/v1.6.6/umm-g-json-schema.json
+type UMMGGranule = {
+  GranuleUR: string;
+  DataGranule?: {
+    Identifiers?: {
+      Identifier: string;
+      IdentifierType: string;
+      IdentifierName?: string;
+    }[];
+    [key: string]: any;
+  };
+  [key: string]: unknown;
+};
+
+function isUMMGGranule(obj: any): obj is UMMGGranule {
+  return typeof obj === 'object' && obj !== null && typeof obj.GranuleUR === 'string';
+}
+
+/**
+ * Updates a UMM-G metadata object with a new GranuleUR and ProducerGranuleId.
+ *
+ * This function:
+ * - Validates that the input is a valid UMM-G granule metadata object.
+ * - Performs a deep clone to preserve the original input.
+ * - Sets the GranuleUR to the specified value.
+ * - Ensures that the DataGranule.Identifiers array exists.
+ * - Adds or updates an entry of type "ProducerGranuleId" with the provided identifier.
+ *
+ * @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.
+ * @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.
+ */
+
+export function updateUMMGGranuleURAndGranuleIdentifier({
+  metadataObject,
+  granuleUr,
+  producerGranuleId,
+}: {
+  metadataObject: unknown;
+  granuleUr: string;
+  producerGranuleId: string;
+}): UMMGGranule {
+  if (!isUMMGGranule(metadataObject)) {
+    throw new Error('Invalid UMM-G JSON metadata');
+  }
+
+  const moddedJson = structuredClone(metadataObject);
+
+  moddedJson.GranuleUR = granuleUr;
+  moddedJson.DataGranule ??= {};
+  moddedJson.DataGranule.Identifiers ??= [];
+
+  const producerIndex = moddedJson.DataGranule.Identifiers.findIndex(
+    (id) => id.IdentifierType === 'ProducerGranuleId'
+  );
+
+  const producerGranuleIdIdentifier = {
+    Identifier: producerGranuleId,
+    IdentifierType: 'ProducerGranuleId',
+  };
+
+  if (producerIndex !== -1) {
+    moddedJson.DataGranule.Identifiers[producerIndex] = producerGranuleIdIdentifier;
+  } else {
+    moddedJson.DataGranule.Identifiers.push(producerGranuleIdIdentifier);
+  }
+
+  return moddedJson;
+}