@dmptool/utils 1.0.0

package/dist/eventBridge.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.putEvent = void 0;
+const client_eventbridge_1 = require("@aws-sdk/client-eventbridge");
+/**
+ * Publishes an event to EventBridge.
+ *
+ * @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) {
+        // 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
+            };
+        }
+    }
+    // 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!'}`,
+        eventId: undefined
+    };
+};
+exports.putEvent = putEvent;

package/dist/general.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Convert an error to a string
+ *
+ * @param error the error to convert
+ * @returns the error message
+ */
+export declare const toErrorMessage: (error: unknown) => string;
+/**
+ * Convert http to https
+ *
+ * @param input a URL with the protocol
+ * @returns a URL with the protocol converted to https
+ */
+export declare const normaliseHttpProtocol: (input: string | null) => string | null;
+/**
+ *Function to return the current date.
+ *
+ * @returns The current date as YYYY-MM-DD.
+ */
+export declare const currentDateAsString: () => string;
+/**
+ * Function to convert a MySQL DB date/time (in ISO `YYY-MM-DDThh:mm:ddZ` format to RFC3339 format
+ *
+ * @param dateTime the MySQL DB date/time to convert
+ * @returns the converted date/time in RFC3339 format
+ */
+export declare const convertMySQLDateTimeToRFC3339: (dateTime: string | Date | null | undefined) => string | null;
+/**
+ * Generate a random hex code
+ *
+ * @param size the size of the hex code to generate
+ * @returns a random hex code
+ */
+export declare const randomHex: (size: number) => string;
+/**
+ * Function to check if a value is null or undefined.
+ *
+ * @param val
+ * @returns True if the value is null or undefined, false otherwise.
+ */
+export declare const isNullOrUndefined: (val: unknown) => boolean;
+/**
+ * Remove null and undefined values from an object or array.
+ *
+ * @param obj An object (may contain nested objects and arrays)
+ * @returns The object with null and undefined values removed.
+ */
+export declare const removeNullAndUndefinedFromObject: (obj: any) => any;
+/**
+ * Function to test for equality between two objects, arrays or primitives
+ *
+ * @param a An object (may contain nested objects and arrays)
+ * @param b Another object (may contain nested objects and arrays)
+ * @returns True if the objects are equal, false otherwise
+ */
+export declare const areEqual: (a: any, b: any) => boolean;

package/dist/general.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.areEqual = exports.removeNullAndUndefinedFromObject = exports.isNullOrUndefined = exports.randomHex = exports.convertMySQLDateTimeToRFC3339 = exports.currentDateAsString = exports.normaliseHttpProtocol = exports.toErrorMessage = void 0;
+/**
+ * Convert an error to a string
+ *
+ * @param error the error to convert
+ * @returns the error message
+ */
+const toErrorMessage = (error) => {
+    if (error instanceof Error)
+        return error.message;
+    return String(error);
+};
+exports.toErrorMessage = toErrorMessage;
+/**
+ * Convert http to https
+ *
+ * @param input a URL with the protocol
+ * @returns a URL with the protocol converted to https
+ */
+const normaliseHttpProtocol = (input) => {
+    if (!input) {
+        return null;
+    }
+    return input.trim().replace(/^http:\/\//, 'https://');
+};
+exports.normaliseHttpProtocol = normaliseHttpProtocol;
+/**
+ *Function to return the current date.
+ *
+ * @returns The current date as YYYY-MM-DD.
+ */
+// Function to return the current date as "YYYY-MM-DD"
+const currentDateAsString = () => {
+    const now = new Date();
+    // Extract components
+    const year = now.getFullYear();
+    // Months are 0-indexed so need to add 1 here
+    const month = String(now.getMonth() + 1).padStart(2, '0');
+    const day = String(now.getDate()).padStart(2, '0');
+    // Format as YYYY-MM-DD
+    return `${year}-${month}-${day}`;
+};
+exports.currentDateAsString = currentDateAsString;
+/**
+ * Function to convert a MySQL DB date/time (in ISO `YYY-MM-DDThh:mm:ddZ` format to RFC3339 format
+ *
+ * @param dateTime the MySQL DB date/time to convert
+ * @returns the converted date/time in RFC3339 format
+ */
+const convertMySQLDateTimeToRFC3339 = (dateTime) => {
+    var _a;
+    if (dateTime) {
+        if (typeof dateTime !== 'string')
+            return dateTime.toISOString();
+        const newDate = (_a = dateTime === null || dateTime === void 0 ? void 0 : dateTime.trim()) === null || _a === void 0 ? void 0 : _a.replace(' ', 'T');
+        return newDate.includes('T')
+            ? (newDate.endsWith('Z') ? newDate : newDate + 'Z')
+            : newDate + 'T00:00:00Z';
+    }
+    return null;
+};
+exports.convertMySQLDateTimeToRFC3339 = convertMySQLDateTimeToRFC3339;
+/**
+ * Generate a random hex code
+ *
+ * @param size the size of the hex code to generate
+ * @returns a random hex code
+ */
+const randomHex = (size) => {
+    return [...Array(size)].map(() => Math.floor(Math.random() * 16).toString(16)).join('');
+};
+exports.randomHex = randomHex;
+/**
+ * Function to check if a value is null or undefined.
+ *
+ * @param val
+ * @returns True if the value is null or undefined, false otherwise.
+ */
+const isNullOrUndefined = (val) => {
+    return val === null || val === undefined;
+};
+exports.isNullOrUndefined = isNullOrUndefined;
+/**
+ * Remove null and undefined values from an object or array.
+ *
+ * @param obj An object (may contain nested objects and arrays)
+ * @returns The object with null and undefined values removed.
+ */
+const removeNullAndUndefinedFromObject = (obj) => {
+    if (Array.isArray(obj)) {
+        return obj.map(exports.removeNullAndUndefinedFromObject).filter(v => !(0, exports.isNullOrUndefined)(v));
+    }
+    else if (!(0, exports.isNullOrUndefined)(obj) && typeof obj === 'object') {
+        return Object.fromEntries(Object.entries(obj)
+            .map(([k, v]) => [k, (0, exports.removeNullAndUndefinedFromObject)(v)])
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            .filter(([_, v]) => !(0, exports.isNullOrUndefined)(v)));
+    }
+    return obj;
+};
+exports.removeNullAndUndefinedFromObject = removeNullAndUndefinedFromObject;
+/**
+ * Function to test for equality between two objects, arrays or primitives
+ *
+ * @param a An object (may contain nested objects and arrays)
+ * @param b Another object (may contain nested objects and arrays)
+ * @returns True if the objects are equal, false otherwise
+ */
+const areEqual = (a, b) => {
+    // Check for strict equality (handles primitives and same references)
+    if (a === b)
+        return true;
+    // If either is not an object (or is null), they can't be equal
+    if (typeof a !== 'object' || a === null || typeof b !== 'object' || b === null) {
+        return false;
+    }
+    // If one is an array and the other isn't, they aren't equal
+    if (Array.isArray(a) !== Array.isArray(b))
+        return false;
+    // Handle Arrays specifically
+    if (Array.isArray(a) && Array.isArray(b)) {
+        if (a.length !== b.length)
+            return false;
+        return a.every((item, index) => (0, exports.areEqual)(item, b[index]));
+    }
+    // Handle Objects
+    const keysA = Object.keys(a);
+    const keysB = Object.keys(b);
+    // If the number of properties is different, they aren't equal'
+    if (keysA.length !== keysB.length)
+        return false;
+    // Check each property for equality
+    for (const key of keysA) {
+        if (!keysB.includes(key) || !(0, exports.areEqual)(a[key], b[key])) {
+            return false;
+        }
+    }
+    return true;
+};
+exports.areEqual = areEqual;

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './cloudFormation';
+export * from './dynamo';
+export * from './eventBridge';
+export * from './general';
+export * from './logger';
+export * from './maDMP';
+export * from './maDMPTypes';
+export * from './rds';
+export * from './s3';
+export * from './ssm';

package/dist/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Entrypoint for the package
+__exportStar(require("./cloudFormation"), exports);
+__exportStar(require("./dynamo"), exports);
+__exportStar(require("./eventBridge"), exports);
+__exportStar(require("./general"), exports);
+__exportStar(require("./logger"), exports);
+__exportStar(require("./maDMP"), exports);
+__exportStar(require("./maDMPTypes"), exports);
+__exportStar(require("./rds"), exports);
+__exportStar(require("./s3"), exports);
+__exportStar(require("./ssm"), exports);

package/dist/logger.d.ts

@@ -0,0 +1,17 @@
+import { Logger } from 'pino';
+export declare enum LogLevel {
+    trace = "trace",
+    debug = "debug",
+    info = "info",
+    warn = "warn",
+    error = "error",
+    fatal = "fatal"
+}
+/**
+ * Initialize a Pino logger with ECS formatting for the Lambda function.
+ *
+ * @param lambdaName Name of the function, used as the module name in the logs
+ * @param logLevel Log level to use, defaults to 'info'
+ * @returns A Pino logger instance
+ */
+export declare const initializeLogger: (lambdaName: string, logLevel: LogLevel) => Logger;

package/dist/logger.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initializeLogger = exports.LogLevel = void 0;
+const pino_1 = __importDefault(require("pino"));
+const pino_lambda_1 = require("pino-lambda");
+const ecs_pino_format_1 = require("@elastic/ecs-pino-format");
+// The available log levels
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["trace"] = "trace";
+    LogLevel["debug"] = "debug";
+    LogLevel["info"] = "info";
+    LogLevel["warn"] = "warn";
+    LogLevel["error"] = "error";
+    LogLevel["fatal"] = "fatal";
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
+/**
+ * Initialize a Pino logger with ECS formatting for the Lambda function.
+ *
+ * @param lambdaName Name of the function, used as the module name in the logs
+ * @param logLevel Log level to use, defaults to 'info'
+ * @returns A Pino logger instance
+ */
+const initializeLogger = (lambdaName, logLevel) => {
+    const destination = (0, pino_lambda_1.pinoLambdaDestination)();
+    const logger = (0, pino_1.default)(Object.assign({ 
+        // Set the minimum log level
+        level: logLevel || 'info' }, ecs_pino_format_1.ecsFormat), destination);
+    // Define a standardized module name
+    logger.child({ module: lambdaName });
+    return logger;
+};
+exports.initializeLogger = initializeLogger;

package/dist/maDMP.d.ts

@@ -0,0 +1,41 @@
+import { DMPToolDMPType, DMPToolExtensionType } from "@dmptool/types";
+/**
+ * Validate the specified DMP metadata record against the RDA Common Standard
+ * and DMP Tool extensions schema
+ *
+ * @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;
+/**
+ * Validate the specified DMP metadata record against the RDA Common Standard
+ * and DMP Tool extensions schema
+ *
+ * @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;
+/**
+ *
+ * Generate a JSON representation for a DMP that confirms to the RDA Common Metadata
+ * standard and includes DMP Tool specific extensions to that standard.
+ *
+ * Some things of note about the JSON representation:
+ *   - There are no primitive booleans, booleans are represented as: 'yes',
+ *   'no', 'unknown'
+ *   - There are no primitive dates, strings formatted as 'YYYY-MM-DD hh:mm:ss:msZ'
+ *   are used
+ *   - The `provenance` is used to store the ID of the system that created the DMP
+ *   - The `privacy` should be used to determine authorization for viewing the
+ *   DMP narrative
+ *   - The `featured` indicates whether the DMP is featured on the DMP Tool
+ *   website's public plans page
+ *   - 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 planId the ID of the plan to generate the DMP for
+ * @returns a JSON representation of the DMP
+ */
+export declare function planToDMPCommonStandard(planId: number): Promise<DMPToolDMPType | undefined>;