@dmptool/utils 1.0.24 → 1.0.25

package/dist/dynamo.d.ts

@@ -13,6 +13,10 @@ interface DMPVersionType {
     SK: string;
     modified: string;
 }
+export interface LatestDMPVersion {
+    dmpId: string;
+    modified: string;
+}
 /**
  * Lightweight query just to check if the DMP exists.
  *
@@ -22,6 +26,14 @@ interface DMPVersionType {
  * @throws DMPToolDynamoError if the record could not be fetched due to an error
  */
 export declare const DMPExists: (dynamoConnectionParams: DynamoConnectionParams, dmpId: string) => Promise<boolean>;
+/**
+ * Fetch the latest version for every unique DMP ID
+ *
+ * @param dynamoConnectionParams the DynamoDB connection parameters
+ * @returns The latest version for every unique DMP ID
+ * @throws DMPToolDynamoError if the records could not be fetched due to an error
+ */
+export declare const getAllUniqueDMPIds: (dynamoConnectionParams: DynamoConnectionParams) => Promise<LatestDMPVersion[] | []>;
 /**
  * Fetch the version timestamps (including DMP_LATEST_VERSION) for the specified DMP ID.
  *

package/dist/dynamo.js

@@ -11,7 +11,7 @@ var __rest = (this && this.__rest) || function (s, e) {
     return t;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteDMP = exports.tombstoneDMP = exports.updateDMP = exports.createDMP = exports.getDMPs = exports.getDMPVersions = exports.DMPExists = exports.DMP_TOMBSTONE_VERSION = exports.DMP_LATEST_VERSION = void 0;
+exports.deleteDMP = exports.tombstoneDMP = exports.updateDMP = exports.createDMP = exports.getDMPs = exports.getDMPVersions = exports.getAllUniqueDMPIds = exports.DMPExists = exports.DMP_TOMBSTONE_VERSION = exports.DMP_LATEST_VERSION = void 0;
 const util_dynamodb_1 = require("@aws-sdk/util-dynamodb");
 const client_dynamodb_1 = require("@aws-sdk/client-dynamodb");
 const general_1 = require("./general");
@@ -84,6 +84,47 @@ const DMPExists = async (dynamoConnectionParams, dmpId) => {
     }
 };
 exports.DMPExists = DMPExists;
+/**
+ * Fetch the latest version for every unique DMP ID
+ *
+ * @param dynamoConnectionParams the DynamoDB connection parameters
+ * @returns The latest version for every unique DMP ID
+ * @throws DMPToolDynamoError if the records could not be fetched due to an error
+ */
+const getAllUniqueDMPIds = async (dynamoConnectionParams) => {
+    if (!dynamoConnectionParams) {
+        throw new DMPToolDynamoError('Missing Dynamo config');
+    }
+    // Get the PK, SK and modified timestamps for all the latest versions
+    const params = {
+        ProjectionExpression: "PK, modified",
+        FilterExpression: `SK = '${DMP_VERSION_PREFIX}#${exports.DMP_LATEST_VERSION}'`
+    };
+    try {
+        dynamoConnectionParams.logger.debug(Object.assign({}, params), 'Scanning for latest DMP versions in DynamoDB');
+        const response = await scanTable(dynamoConnectionParams, params);
+        if (Array.isArray(response) && response.length > 0) {
+            const versions = [];
+            for (const item of response) {
+                const unmarshalled = (0, util_dynamodb_1.unmarshall)(item);
+                if (unmarshalled.PK && unmarshalled.SK && unmarshalled.modified) {
+                    versions.push({
+                        dmpId: unmarshalled.PK.replace(`${DMP_PK_PREFIX}#`, 'https://'),
+                        modified: unmarshalled.modified
+                    });
+                }
+            }
+            return versions;
+        }
+        return [];
+    }
+    catch (err) {
+        const errMsg = (0, general_1.toErrorMessage)(err);
+        dynamoConnectionParams.logger.fatal(Object.assign(Object.assign({}, params), { errMsg }), 'Failed to fetch all unique DMPs');
+        throw new DMPToolDynamoError(`Unable to fetch all unique DMPs: ${errMsg}`);
+    }
+};
+exports.getAllUniqueDMPIds = getAllUniqueDMPIds;
 /**
  * Fetch the version timestamps (including DMP_LATEST_VERSION) for the specified DMP ID.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dmptool/utils",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "description": "Helper/Utility functions for use in the DMP Tool services. Particularly AWS tooling and maDMP serialization",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",