@dmptool/utils 1.0.0

package/dist/maDMPTypes.d.ts

@@ -0,0 +1,273 @@
+import { AnyAnswerType } from '@dmptool/types';
+export interface LoadPlanInfo {
+    id: number;
+    dmpId: string;
+    projectId: number;
+    versionedTemplateId: number;
+    createdById: number;
+    created: string;
+    modifiedById: number;
+    modified: string;
+    title: string;
+    status: string;
+    visibility: string;
+    featured: boolean;
+    registeredBy?: number;
+    registered?: string;
+    languageId: string;
+}
+export interface LoadProjectInfo {
+    id: number;
+    title: string;
+    abstractText?: string;
+    startDate?: string;
+    endDate?: string;
+    dmptool_research_domain?: string;
+}
+export interface LoadFundingInfo {
+    id: number;
+    uri?: string;
+    name: string;
+    status: string;
+    grantId?: string;
+    funderProjectNumber?: string;
+    funderOpportunityNumber?: string;
+}
+export interface LoadMemberInfo {
+    id: number;
+    uri?: string;
+    name?: string;
+    email?: string;
+    givenName?: string;
+    surName?: string;
+    orcid?: string;
+    isPrimaryContact: boolean;
+    roles: string;
+}
+export interface LoadDatasetInfo {
+    title: string;
+    type: string;
+    personal_data: string;
+    sensitive_data: string;
+    dataset_id: {
+        identifier: string;
+        type: string;
+    };
+}
+export interface LoadRelatedWorkInfo {
+    identifier: string;
+    workType?: string;
+}
+export interface LoadNarrativeQuestionInfo {
+    questionId: number;
+    questionText: string;
+    questionOrder: number;
+    answerId: number;
+    answerJSON: AnyAnswerType;
+}
+export interface LoadNarrativeSectionInfo {
+    sectionId: number;
+    sectionTitle: string;
+    sectionDescription?: string;
+    sectionOrder: number;
+    question: LoadNarrativeQuestionInfo[];
+}
+export interface LoadNarrativeInfo {
+    templateId: number;
+    templateTitle: string;
+    templateDescription?: string;
+    templateVersion?: string;
+    section: LoadNarrativeSectionInfo[];
+}
+export interface RDACommonStandardAffiliation {
+    name: string;
+    affiliation_id?: {
+        identifier: string;
+        type: string;
+    };
+}
+export interface RDACommonStandardContact {
+    name: string;
+    mbox: string;
+    contact_id: {
+        identifier: string;
+        type: string;
+    }[];
+    affiliation?: RDACommonStandardAffiliation[];
+}
+export interface RDACommonStandardContributor {
+    contributor_id: {
+        identifier: string;
+        type: string;
+    }[];
+    name: string;
+    affiliation?: RDACommonStandardAffiliation[];
+    role: string[];
+}
+export interface RDACommonStandardProject {
+    title: string;
+    description?: string;
+    start?: string;
+    end?: string;
+    project_id: {
+        identifier: string;
+        type: string;
+    }[];
+    funding?: {
+        name: string;
+        funding_status: string;
+        grant_id?: {
+            identifier: string;
+            type: string;
+        };
+        funder_id?: {
+            identifier: string;
+            type: string;
+        };
+    }[];
+}
+export interface RDACommonStandardRelatedWork {
+    identifier: string;
+    type: string;
+    relation_type?: string;
+    resource_type?: string;
+}
+export interface RDACommonStandardDataset {
+    title: string;
+    type: string;
+    description?: string;
+    dataset_id: {
+        identifier: string;
+        type: string;
+    };
+    personal_data?: string;
+    sensitive_data?: string;
+    data_quality_assurance?: string[];
+    is_reused?: boolean;
+    issued?: string;
+    keyword?: string[];
+    language?: string;
+    metadata?: {
+        description?: string;
+        language: string;
+        metadata_standard_id: {
+            identifier: string;
+            type: string;
+        }[];
+    }[];
+    preservation_statement?: string;
+    security_and_privacy?: {
+        title: string;
+        description: string;
+    }[];
+    alternate_identifier?: {
+        identifier: string;
+        type: string;
+    }[];
+    technical_resource?: {
+        name: string;
+        description?: string;
+        technical_resource_id: {
+            identifier: string;
+            type: string;
+        }[];
+    }[];
+    distribution?: RDACommonStandardDistribution[];
+}
+export interface RDACommonStandardDistribution {
+    title: string;
+    description?: string;
+    access_url?: string;
+    download_url?: string;
+    byte_size?: number;
+    format?: string[];
+    data_access: string;
+    issued?: string;
+    license?: {
+        license_ref: string;
+        start_date?: string;
+    }[];
+    host: RDACommonStandardHost;
+}
+export interface RDACommonStandardHost {
+    title: string;
+    description?: string;
+    url: string;
+    host_id: {
+        identifier: string;
+        type: string;
+    }[];
+    availability?: string;
+    backup_frequency?: string;
+    backup_type?: string;
+    certified_with?: string;
+    geo_location?: string;
+    pid_system?: string[];
+    storage_type?: string;
+    support_versioning?: string;
+}
+export interface RDACommonStandardIdentifierType {
+    identifier: string;
+    type: StandardIdentifierType;
+}
+export declare enum StandardIdentifierType {
+    ARK = "ark",
+    DOI = "doi",
+    HANDLE = "handle",
+    ROR = "ror",
+    URL = "url",
+    OTHER = "other"
+}
+export interface DMPExtensionFunderProjectType {
+    project_id: {
+        identifier: string;
+        type: StandardIdentifierType;
+    };
+    funder_id: {
+        identifier: string;
+        type: StandardIdentifierType;
+    };
+    project_identifier: {
+        identifier: string;
+        type: StandardIdentifierType;
+    };
+}
+export interface DMPExtensionFunderOpportunityType {
+    project_id: {
+        identifier: string;
+        type: StandardIdentifierType;
+    };
+    funder_id: {
+        identifier: string;
+        type: StandardIdentifierType;
+    };
+    opportunity_identifier: {
+        identifier: string;
+        type: StandardIdentifierType;
+    };
+}
+interface DMPExtensionNarrativeAnswer {
+    id: number;
+    json: AnyAnswerType;
+}
+interface DMPExtensionNarrativeQuestion {
+    id: number;
+    text: string;
+    order: number;
+    answer?: DMPExtensionNarrativeAnswer;
+}
+interface DMPExtensionNarrativeSection {
+    id: number;
+    title: string;
+    description?: string;
+    order: number;
+    question: DMPExtensionNarrativeQuestion[];
+}
+export interface DMPExtensionNarrative {
+    id: number;
+    title: string;
+    description?: string;
+    version?: string;
+    section: DMPExtensionNarrativeSection[];
+}
+export {};

package/dist/maDMPTypes.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StandardIdentifierType = void 0;
+var StandardIdentifierType;
+(function (StandardIdentifierType) {
+    StandardIdentifierType["ARK"] = "ark";
+    StandardIdentifierType["DOI"] = "doi";
+    StandardIdentifierType["HANDLE"] = "handle";
+    StandardIdentifierType["ROR"] = "ror";
+    StandardIdentifierType["URL"] = "url";
+    StandardIdentifierType["OTHER"] = "other";
+})(StandardIdentifierType || (exports.StandardIdentifierType = StandardIdentifierType = {}));

package/dist/rds.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Function to run a SQL query against the MySQL database.
+ *
+ * @param query the SQL query to run
+ * @param params the parameters to use in the query
+ * @returns the results of the query
+ */
+export declare const queryTable: (query: string, params?: any[]) => Promise<{
+    results: any[];
+    fields: any[];
+}>;

package/dist/rds.js

@@ -0,0 +1,108 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.queryTable = void 0;
+const mysql = __importStar(require("mysql2/promise"));
+const date_fns_1 = require("date-fns");
+/**
+ * Connect to the MySQL database and run a query.
+ * @returns A new connection to the MySQL database.
+ */
+const createConnection = async () => {
+    var _a, _b, _c, _d;
+    const args = {
+        host: (_a = process.env.RDS_HOST) !== null && _a !== void 0 ? _a : 'localhost',
+        port: process.env.RDS_PORT ? Number.parseInt(process.env.RDS_PORT) : 3306,
+        user: (_b = process.env.RDS_USER) !== null && _b !== void 0 ? _b : 'root',
+        password: (_c = process.env.RDS_PASSWORD) !== null && _c !== void 0 ? _c : 'password',
+        database: (_d = process.env.RDS_DATABASE) !== null && _d !== void 0 ? _d : 'dmp',
+        multipleStatements: false,
+    };
+    return mysql.createConnection(args);
+};
+/**
+ * Function to convert the incoming value into an appropriate type for insertion
+ * into a SQL query.
+ * @param val the incoming value to convert
+ * @param type the type of the incoming value
+ * @returns the converted value
+ */
+const prepareValue = (val, type) => {
+    if (val === null || val === undefined) {
+        return null;
+    }
+    switch (type) {
+        case 'number':
+            return Number(val);
+        case 'json':
+            return JSON.stringify(val);
+        case Object:
+        case Array:
+            return JSON.stringify(val);
+        case 'boolean':
+            return Boolean(val);
+        default:
+            if ((0, date_fns_1.isDate)(val)) {
+                const date = new Date(val).toISOString();
+                return (0, date_fns_1.formatISO9075)(date);
+            }
+            else if (Array.isArray(val)) {
+                return JSON.stringify(val);
+            }
+            else {
+                return String(val);
+            }
+    }
+};
+/**
+ * Function to run a SQL query against the MySQL database.
+ *
+ * @param query the SQL query to run
+ * @param params the parameters to use in the query
+ * @returns the results of the query
+ */
+// Runs the provided SQL query and returns the results
+const queryTable = async (query, params = []) => {
+    const connection = await createConnection();
+    // Remove all tabs and new lines
+    const sql = query.split(/[\s\t\n]+/).join(' ');
+    // Prepare the values for the query
+    const vals = params.map((val) => prepareValue(val, typeof val));
+    // Run the query and then close the connection
+    const [results, fields] = await connection.query(sql, vals);
+    await connection.end();
+    return { results: results, fields: fields };
+};
+exports.queryTable = queryTable;

package/dist/s3.d.ts

@@ -0,0 +1,44 @@
+import { GetObjectCommandOutput, PutObjectCommandOutput } from "@aws-sdk/client-s3";
+export interface DMPToolListObjectsOutput {
+    key: string;
+    lastModified: Date;
+    size: number;
+}
+/**
+ * List the contents of a bucket that match a key prefix.
+ *
+ * @param bucket The name of the bucket to list.
+ * @param keyPrefix The prefix to filter the results by.
+ * @returns A list of objects that match the key prefix, or undefined if the
+ * bucket or key prefix are invalid.
+ */
+export declare const listObjects: (bucket: string, keyPrefix: string) => Promise<DMPToolListObjectsOutput[] | []>;
+/**
+ * Get an object from the specified bucket.
+ *
+ * @param bucket The name of the bucket to get the object from.
+ * @param key The key of the object to get.
+ * @returns The object, or undefined if the bucket or key are invalid.
+ */
+export declare const getObject: (bucket: string, key: string) => Promise<GetObjectCommandOutput | undefined>;
+/**
+ * Put an object into the specified bucket.
+ *
+ * @param bucket The name of the bucket to put the object into.
+ * @param key The key of the object to put.
+ * @param body The object to put.
+ * @param contentType The content type of the object.
+ * @param contentEncoding The content encoding of the object.
+ * @returns The response from the S3 putObject operation, or undefined if the
+ * bucket or key are invalid.
+ */
+export declare const putObject: (bucket: string, key: string, body: any, contentType?: string, contentEncoding?: string) => Promise<PutObjectCommandOutput | undefined>;
+/**
+ * Generate a Pre-signed URL for an S3 object.
+ *
+ * @param bucket The name of the bucket to generate the URL for.
+ * @param key The key of the object to generate the URL for.
+ * @param usePutMethod Whether to use the PUT method for the URL. Defaults to false.
+ * @returns The Pre-signed URL, or undefined if the bucket or key are invalid.
+ */
+export declare const getPresignedURL: (bucket: string, key: string, usePutMethod?: boolean) => Promise<string | undefined>;

package/dist/s3.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPresignedURL = exports.putObject = exports.getObject = exports.listObjects = void 0;
+const s3_request_presigner_1 = require("@aws-sdk/s3-request-presigner");
+const client_s3_1 = require("@aws-sdk/client-s3");
+const s3Client = new client_s3_1.S3Client({});
+/**
+ * List the contents of a bucket that match a key prefix.
+ *
+ * @param bucket The name of the bucket to list.
+ * @param keyPrefix The prefix to filter the results by.
+ * @returns A list of objects that match the key prefix, or undefined if the
+ * bucket or key prefix are invalid.
+ */
+const listObjects = async (bucket, keyPrefix) => {
+    if (bucket && bucket.trim() !== '') {
+        const listObjectsCommand = new client_s3_1.ListObjectsV2Command({
+            Bucket: bucket,
+            Prefix: keyPrefix
+        });
+        const response = await s3Client.send(listObjectsCommand);
+        if (Array.isArray(response.Contents) && response.Contents.length > 0) {
+            const objects = [];
+            for (const obj of response.Contents) {
+                if (obj && obj.Key && obj.LastModified && obj.Size) {
+                    objects.push({
+                        key: obj.Key,
+                        lastModified: obj.LastModified,
+                        size: obj.Size
+                    });
+                }
+            }
+            return objects;
+        }
+    }
+    return [];
+};
+exports.listObjects = listObjects;
+/**
+ * Get an object from the specified bucket.
+ *
+ * @param bucket The name of the bucket to get the object from.
+ * @param key The key of the object to get.
+ * @returns The object, or undefined if the bucket or key are invalid.
+ */
+const getObject = async (bucket, key) => {
+    if (bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+        const command = new client_s3_1.GetObjectCommand({ Bucket: bucket, Key: key });
+        return await s3Client.send(command);
+    }
+    return undefined;
+};
+exports.getObject = getObject;
+/**
+ * Put an object into the specified bucket.
+ *
+ * @param bucket The name of the bucket to put the object into.
+ * @param key The key of the object to put.
+ * @param body The object to put.
+ * @param contentType The content type of the object.
+ * @param contentEncoding The content encoding of the object.
+ * @returns The response from the S3 putObject operation, or undefined if the
+ * bucket or key are invalid.
+ */
+const putObject = async (bucket, key, body, contentType = 'application/json', contentEncoding = 'utf-8') => {
+    if (bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+        const command = new client_s3_1.PutObjectCommand({
+            Bucket: bucket,
+            Key: key,
+            Body: body,
+            ContentType: contentType,
+            ContentEncoding: contentEncoding,
+        });
+        return await s3Client.send(command);
+    }
+    return undefined;
+};
+exports.putObject = putObject;
+/**
+ * Generate a Pre-signed URL for an S3 object.
+ *
+ * @param bucket The name of the bucket to generate the URL for.
+ * @param key The key of the object to generate the URL for.
+ * @param usePutMethod Whether to use the PUT method for the URL. Defaults to false.
+ * @returns The Pre-signed URL, or undefined if the bucket or key are invalid.
+ */
+const getPresignedURL = async (bucket, key, usePutMethod = false) => {
+    if (bucket && key && bucket.trim() !== '' && key.trim() !== '') {
+        const params = { Bucket: bucket, Key: key };
+        const command = usePutMethod
+            ? new client_s3_1.PutObjectCommand(params)
+            : new client_s3_1.GetObjectCommand(params);
+        return await (0, s3_request_presigner_1.getSignedUrl)(s3Client, command, { expiresIn: 900 });
+        ;
+    }
+    return undefined;
+};
+exports.getPresignedURL = getPresignedURL;

package/dist/ssm.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Retrieve a variable from the SSM Parameter store.
+ *
+ * @param key The name of the variable to retrieve.
+ * @returns The value of the variable, or undefined if the variable could not be found.
+ * @throws
+ */
+export declare const getSSMParameter: (key: string) => Promise<string | undefined>;

package/dist/ssm.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSSMParameter = void 0;
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const general_1 = require("./general");
+// Create an SSM client
+const client = new client_ssm_1.SSMClient();
+const ENV = process.env.NODE_ENV === 'production'
+    ? 'prd' : (process.env.NODE_ENV === 'staging'
+    ? 'stg' : 'dev');
+const KEY_PREFIX = `/uc3/dmp/tool/${ENV}/`;
+/**
+ * Retrieve a variable from the SSM Parameter store.
+ *
+ * @param key The name of the variable to retrieve.
+ * @returns The value of the variable, or undefined if the variable could not be found.
+ * @throws
+ */
+const getSSMParameter = async (key) => {
+    var _a;
+    if (key && key.trim() !== '') {
+        const command = new client_ssm_1.GetParameterCommand({
+            Name: `${KEY_PREFIX}${key}`,
+            WithDecryption: true
+        });
+        const response = await client.send(command);
+        if (!(0, general_1.isNullOrUndefined)(response) && !(0, general_1.isNullOrUndefined)(response.Parameter)) {
+            return (_a = response.Parameter) === null || _a === void 0 ? void 0 : _a.Value;
+        }
+    }
+    return undefined;
+};
+exports.getSSMParameter = getSSMParameter;

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@dmptool/utils",
+  "version": "1.0.0",
+  "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",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "schemas"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "clean": "rm -rf dist",
+    "lint": "eslint . --ignore-pattern dist/ --ignore-pattern node_modules/",
+    "prepublishOnly": "npm run build",
+    "test": "jest --config jest.config.ts",
+    "prepare": "npm run build",
+    "postinstall": "husky || true",
+    "type-check": "tsc --noEmit",
+    "trivy-high": "./scripts/trivy-high.sh",
+    "trivy-med": "./scripts/trivy-med.sh"
+  },
+  "dependencies": {
+    "@aws-sdk/client-cloudformation": "^3.966.0",
+    "@aws-sdk/client-dynamodb": "^3.966.0",
+    "@aws-sdk/client-eventbridge": "^3.968.0",
+    "@aws-sdk/client-s3": "^3.966.0",
+    "@aws-sdk/client-sns": "^3.967.0",
+    "@aws-sdk/client-ssm": "^3.966.0",
+    "@aws-sdk/s3-request-presigner": "^3.966.0",
+    "@aws-sdk/util-dynamodb": "^3.966.0",
+    "@dmptool/types": "2.3.0",
+    "@elastic/ecs-pino-format": "^1.5.0",
+    "date-fns": "^4.1.0",
+    "jsonschema": "^1.5.0",
+    "mysql2": "^3.16.0",
+    "pino": "^10.1.1",
+    "pino-lambda": "^4.4.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.26.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^20.4.3",
+    "aws-sdk-client-mock": "^4.1.0",
+    "eslint": "^9.26.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "jest-expect-message": "^1.1.3",
+    "ts-jest": "^29.3.3",
+    "ts-node": "^10.9.2",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.2.2",
+    "typescript-eslint": "^8.32.1"
+  }
+}