@dmptool/utils 1.0.5 → 1.0.7

package/dist/eventBridge.js

@@ -2,46 +2,60 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.putEvent = void 0;
 const client_eventbridge_1 = require("@aws-sdk/client-eventbridge");
+const general_1 = require("./general");
 /**
  * Publishes an event to EventBridge.
  *
+ * @param logger The logger to use for logging.
  * @param source The name of the caller (e.g. the Lambda Function or Application Function)
  * @param detailType The type of event (resources typically watch for specific types of events)
  * @param detail The payload of the event (will be accessible to the invoked resource)
  */
-const putEvent = async (source, detailType, details) => {
-    var _a, _b, _c, _d, _e;
-    const busName = process.env.EVENTBRIDGE_BUS_NAME;
-    if (busName) {
+const putEvent = async (logger, busName, source, detailType, details, region = 'us-west-2') => {
+    var _a, _b, _c, _d;
+    let errMsg = '';
+    if (logger && busName) {
         // Create a new EventBridge client instance
-        const client = new client_eventbridge_1.EventBridgeClient({
-            region: (_a = process.env.AWS_REGION) !== null && _a !== void 0 ? _a : "us-west-2",
-        });
-        // Publish the event
-        const response = await client.send(new client_eventbridge_1.PutEventsCommand({
-            Entries: [
-                {
-                    EventBusName: busName,
-                    Detail: details ? JSON.stringify(details) : undefined,
-                    DetailType: detailType,
-                    Source: source,
-                },
-            ],
-        }));
-        if (response) {
-            const statusCode = (_c = (_b = response.$metadata) === null || _b === void 0 ? void 0 : _b.httpStatusCode) !== null && _c !== void 0 ? _c : 500;
-            // We got a response, so return it.
-            return {
-                status: statusCode,
-                message: statusCode >= 200 && statusCode <= 300 ? "Ok" : "Failure",
-                eventId: (_e = (_d = response.Entries) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.EventId
-            };
+        const client = new client_eventbridge_1.EventBridgeClient({ region });
+        logger.debug({ busName, source, detailType, details }, 'Publishing event');
+        try {
+            // Publish the event
+            const response = await client.send(new client_eventbridge_1.PutEventsCommand({
+                Entries: [
+                    {
+                        EventBusName: busName,
+                        Detail: details ? JSON.stringify(details) : undefined,
+                        DetailType: detailType,
+                        Source: source,
+                    },
+                ],
+            }));
+            if (response) {
+                const statusCode = (_b = (_a = response.$metadata) === null || _a === void 0 ? void 0 : _a.httpStatusCode) !== null && _b !== void 0 ? _b : 500;
+                // We got a response, so return it.
+                return {
+                    status: statusCode,
+                    message: statusCode >= 200 && statusCode <= 300 ? "Ok" : "Failure",
+                    eventId: (_d = (_c = response.Entries) === null || _c === void 0 ? void 0 : _c[0]) === null || _d === void 0 ? void 0 : _d.EventId
+                };
+            }
+            else {
+                logger.error({ busName, source, detailType, details }, 'No response from EventBridge');
+                errMsg = 'No response from EventBridge';
+            }
         }
+        catch (error) {
+            logger.fatal({ busName, source, detailType, details, error }, 'Error publishing event');
+            errMsg = `Error publishing event: ${(0, general_1.toErrorMessage)(error)}`;
+        }
+    }
+    else {
+        errMsg = 'Missing logger or busName args!';
     }
     // The busName was not available or the response was undefined
     return {
         status: 500,
-        message: `Failure: ${busName ? 'Unable to put event.' : 'Missing EVENTBRIDGE_BUS_NAME variable!'}`,
+        message: errMsg,
         eventId: undefined
     };
 };

package/dist/maDMP.d.ts

@@ -1,22 +1,27 @@
+import { Logger } from 'pino';
+import { ConnectionParams } from './rds';
+import { EnvironmentEnum } from "./general";
 import { DMPToolDMPType, DMPToolExtensionType } from "@dmptool/types";
 /**
  * Validate the specified DMP metadata record against the RDA Common Standard
  * and DMP Tool extensions schema
  *
+ * @param logger the logger to use for logging
  * @param dmp The DMP metadata record to validate
  * @returns the DMP metadata record if it is valid
  * @throws DMPValidationError if the record is invalid with the error message(s)
  */
-export declare const validateRDACommonStandard: (dmp: DMPToolDMPType) => DMPToolDMPType;
+export declare const validateRDACommonStandard: (logger: Logger, dmp: DMPToolDMPType) => DMPToolDMPType;
 /**
  * Validate the specified DMP metadata record against the RDA Common Standard
  * and DMP Tool extensions schema
  *
+ * @param logger the logger to use for logging
  * @param dmp The DMP metadata record to validate
  * @returns the DMP metadata record if it is valid
  * @throws DMPValidationError if the record is invalid with the error message(s)
  */
-export declare const validateDMPToolExtensions: (dmp: DMPToolExtensionType) => DMPToolExtensionType;
+export declare const validateDMPToolExtensions: (logger: Logger, dmpId: string, dmp: DMPToolExtensionType) => DMPToolExtensionType;
 /**
  *
  * Generate a JSON representation for a DMP that confirms to the RDA Common Metadata
@@ -35,7 +40,11 @@ export declare const validateDMPToolExtensions: (dmp: DMPToolExtensionType) => D
  *   - The `registered` indicates whether the DMP is published/registered with DataCite/EZID
  *   - The `tombstoned` indicates that it was published/registered but is now removed
  *
+ * @param rdsConnectionParams the connection parameters for the RDS instance
+ * @param applicationName the name of the application/service
+ * @param domainName the domain name of the application/service website
  * @param planId the ID of the plan to generate the DMP for
+ * @param env The environment from EnvironmentEnum (defaults to EnvironmentEnum.DEV)
  * @returns a JSON representation of the DMP
  */
-export declare function planToDMPCommonStandard(planId: number): Promise<DMPToolDMPType | undefined>;
+export declare function planToDMPCommonStandard(rdsConnectionParams: ConnectionParams, applicationName: string, domainName: string, env: EnvironmentEnum | undefined, planId: number): Promise<DMPToolDMPType | undefined>;