@cumulus/cmrjs 20.3.0 → 21.0.0-echo10

package/ummgModifiers.d.ts

@@ -0,0 +1,35 @@
+declare type UMMGGranule = {
+    GranuleUR: string;
+    DataGranule?: {
+        Identifiers?: {
+            Identifier: string;
+            IdentifierType: string;
+            IdentifierName?: string;
+        }[];
+        [key: string]: any;
+    };
+    [key: string]: unknown;
+};
+/**
+ * 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 declare function updateUMMGGranuleURAndGranuleIdentifier({ metadataObject, granuleUr, producerGranuleId, }: {
+    metadataObject: unknown;
+    granuleUr: string;
+    producerGranuleId: string;
+}): UMMGGranule;
+export {};
+//# sourceMappingURL=ummgModifiers.d.ts.map

package/ummgModifiers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ummgModifiers.d.ts","sourceRoot":"","sources":["src/ummgModifiers.ts"],"names":[],"mappings":"AACA,aAAK,WAAW,GAAG;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QACZ,WAAW,CAAC,EAAE;YACZ,UAAU,EAAE,MAAM,CAAC;YACnB,cAAc,EAAE,MAAM,CAAC;YACvB,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB,EAAE,CAAC;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB,CAAC;AAMF;;;;;;;;;;;;;;;GAeG;AAEH,wBAAgB,uCAAuC,CAAC,EACtD,cAAc,EACd,SAAS,EACT,iBAAiB,GAClB,EAAE;IACD,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,GAAG,WAAW,CA2Bd"}

package/ummgModifiers.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateUMMGGranuleURAndGranuleIdentifier = void 0;
+function isUMMGGranule(obj) {
+    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.
+ */
+function updateUMMGGranuleURAndGranuleIdentifier({ metadataObject, granuleUr, producerGranuleId, }) {
+    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;
+}
+exports.updateUMMGGranuleURAndGranuleIdentifier = updateUMMGGranuleURAndGranuleIdentifier;
+//# sourceMappingURL=ummgModifiers.js.map

package/ummgModifiers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ummgModifiers.js","sourceRoot":"","sources":["src/ummgModifiers.ts"],"names":[],"mappings":";;;AAcA,SAAS,aAAa,CAAC,GAAQ;IAC7B,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,SAAS,KAAK,QAAQ,CAAC;AACtF,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AAEH,SAAgB,uCAAuC,CAAC,EACtD,cAAc,EACd,SAAS,EACT,iBAAiB,GAKlB;IACC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;QAClC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;KAChD;IAED,MAAM,UAAU,GAAG,eAAe,CAAC,cAAc,CAAC,CAAC;IAEnD,UAAU,CAAC,SAAS,GAAG,SAAS,CAAC;IACjC,UAAU,CAAC,WAAW,KAAK,EAAE,CAAC;IAC9B,UAAU,CAAC,WAAW,CAAC,WAAW,KAAK,EAAE,CAAC;IAE1C,MAAM,aAAa,GAAG,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,SAAS,CAChE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,cAAc,KAAK,mBAAmB,CAClD,CAAC;IAEF,MAAM,2BAA2B,GAAG;QAClC,UAAU,EAAE,iBAAiB;QAC7B,cAAc,EAAE,mBAAmB;KACpC,CAAC;IAEF,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE;QACxB,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,aAAa,CAAC,GAAG,2BAA2B,CAAC;KACjF;SAAM;QACL,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;KACtE;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAnCD,0FAmCC"}