@dmptool/utils 1.0.0

package/dist/cloudFormation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Fetch the value for the specified CloudFormation stack export.
+ *
+ * @param name The name of the CloudFormation stack export to fetch.
+ * @returns The value of the CloudFormation stack export, or undefined if the
+ * export could not be found.
+ */
+export declare const getExport: (name: string) => Promise<string | undefined>;

package/dist/cloudFormation.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExport = void 0;
+const client_cloudformation_1 = require("@aws-sdk/client-cloudformation");
+// If you want to make a CloudFormation stack output available for to this Lambda Layer, you need to
+// ensure that your CloudFormation template "exports" the output variable. Note that you should try
+// to make sure that the "Name" you use for your export is namespaced to make it unique!
+//
+//    Outputs:
+//      UserPoolArn:
+//        Value: !GetAtt UserPool.Arn
+//          Export:
+//            Name: !Sub 'my-namespace-CognitoUserPoolArn'
+//
+// You would then import the `getExport` function below into your Lambda function and pass in the
+// export name. e.g. `const val = await getExport("my-namespace-CognitoUserPoolArn");`
+const cfClient = new client_cloudformation_1.CloudFormationClient({});
+// Example of a CloudFormation stack export:
+//   {
+//     ExportingStackId: 'arn:aws:cloudformation:us-west-2:00000000:stack/my-stack-name/unique-id',
+//     Name: 'DynamoDBTable1234',
+//     Value: 'arn:aws:dynamodb:us-west-2:00000000:table/my-dynamo-table-19RCAN1IAZXQ4'
+//   }
+const cfExports = [];
+// Collect all the CloudFormation exported outputs
+const loadExports = async () => {
+    let nextToken;
+    // if the cfExports have already been collected
+    if (!cfExports || !Array.isArray(cfExports) || cfExports.length === 0) {
+        do {
+            const command = new client_cloudformation_1.ListExportsCommand({ NextToken: nextToken });
+            const response = await cfClient.send(command);
+            for (const exp of response.Exports) {
+                cfExports.push(exp);
+            }
+            nextToken = response.NextToken;
+        } while (nextToken);
+    }
+};
+/**
+ * Fetch the value for the specified CloudFormation stack export.
+ *
+ * @param name The name of the CloudFormation stack export to fetch.
+ * @returns The value of the CloudFormation stack export, or undefined if the
+ * export could not be found.
+ */
+const getExport = async (name) => {
+    await loadExports();
+    const response = cfExports.find((exp) => {
+        return (exp === null || exp === void 0 ? void 0 : exp.Name.toLowerCase().trim()) === name.toLowerCase().trim();
+    });
+    return response ? response.Value : undefined;
+};
+exports.getExport = getExport;

package/dist/dynamo.d.ts

@@ -0,0 +1,105 @@
+import { DMPToolDMPType } from '@dmptool/types';
+export declare const DMP_LATEST_VERSION = "latest";
+export declare const DMP_TOMBSTONE_VERSION = "tombstone";
+interface DMPVersionType {
+    PK: string;
+    SK: string;
+    modified: string;
+}
+/**
+ * Lightweight query just to check if the DMP exists.
+ *
+ * @param dmpId
+ * @returns true if the DMP exists, false otherwise.
+ * @throws DMPToolDynamoError if the record could not be fetched due to an error
+ */
+export declare const DMPExists: (dmpId: string) => Promise<boolean>;
+/**
+ * Fetch the version timestamps (including DMP_LATEST_VERSION) for the specified DMP ID.
+ *
+ * @param dmpId
+ * @returns The timestamps as strings (e.g. '2026-11-01T13:08:19Z' or 'latest')
+ * @throws DMPToolDynamoError if the records could not be fetched due to an error
+ */
+export declare const getDMPVersions: (dmpId: string) => Promise<DMPVersionType[] | []>;
+/**
+ * Fetch the RDA Common Standard metadata record with DMP Tool specific extensions
+ * for the specified DMP ID.
+ *
+ * @param dmpId
+ * @param version The version of the DMP metadata record to persist
+ * (e.g. '2026-11-01T13:08:19Z').
+ * If not provided, the latest version will be used. Defaults to DMP_LATEST_VERSION.
+ * @param includeExtensions Whether or not to include the DMP Tool specific
+ * extensions in the returned record. Defaults to true.
+ * @returns The complete RDA Common Standard metadata record with the DMP extension
+ * metadata or an empty array if none were found.
+ * @throws DMPToolDynamoError if the records could not be fetched due to an error
+ */
+export declare const getDMPs: (dmpId: string, version: string | null, includeExtensions?: boolean) => Promise<DMPToolDMPType[] | []>;
+/**
+ * Persists the specified DMP metadata record to the DynamoDB table.
+ * This function will handle the separation of RDA Common Standard and DMP Tool
+ * specific metadata.
+ *
+ * @param dmpId The DMP ID (e.g. '123456789')
+ * @param dmp The DMP metadata record to persist as either an RDA Common Standard
+ * or the standard with DMP Tool specific extensions.
+ * @param version The version of the DMP metadata record to persist
+ * (e.g. '2026-11-01T13:08:19Z').
+ * If not provided, the latest version will be used. Defaults to DMP_LATEST_VERSION.
+ * @param includeExtensions Whether or not to include the DMP Tool specific
+ * extensions in the returned record. Defaults to true.
+ * @returns The persisted DMP metadata record as an RDA Common Standard DMP
+ * metadata record with the DMP Tool specific extensions merged in.
+ * @throws DMPToolDynamoError if the record could not be persisted
+ */
+export declare const createDMP: (dmpId: string, dmp: DMPToolDMPType, version?: string, includeExtensions?: boolean) => Promise<DMPToolDMPType | undefined>;
+/**
+ * Update the specified DMP metadata record.
+ * This function will handle the separation of RDA Common Standard and DMP Tool
+ * specific metadata. We always update the latest version of the DMP metadata record.
+ * Historical versions are immutable.
+ *
+ * A snapshot of the current "latest" version of the DMP's metadata will be taken
+ * under the following circumstances:
+ *   - If the `provenance` of the incoming record does not match the one on the
+ *     latest record
+ *   - If the `modified` timestamp of the latest record is older than 2 hours ago
+ *
+ * If a snapshot is made, the timestamp and link to retrieve it will appear
+ * in the `versions` array
+ *
+ * @param dmp
+ * @param includeExtensions Whether or not to include the DMP Tool specific
+ * extensions in the returned record. Defaults to true.
+ * @returns The persisted DMP metadata record as an RDA Common Standard DMP
+ * metadata record with the DMP Tool specific extensions merged in.
+ * @throws DMPToolDynamoError if the record could not be persisted
+ */
+export declare const updateDMP: (dmp: DMPToolDMPType, includeExtensions?: boolean) => Promise<DMPToolDMPType>;
+/**
+ * Create a Tombstone for the specified DMP metadata record
+ * (registered/published DMPs only!)
+ *
+ * @param dmpId The DMP ID (e.g. '11.12345/A1B2C3')
+ * @param includeExtensions Whether or not to include the DMP Tool specific
+ * extensions in the returned record. Defaults to true.
+ * @returns The new tombstone DMP metadata record as an RDA Common Standard DMP
+ * metadata record with the DMP Tool specific extensions merged in.
+ * @throws DMPToolDynamoError if a tombstone could not be created
+ */
+export declare const tombstoneDMP: (dmpId: string, includeExtensions?: boolean) => Promise<DMPToolDMPType>;
+/**
+ * Delete the specified DMP metadata record and any associated DMP Tool extension records.
+ * This will NOT work on DMPs that have been registered/published.
+ *
+ * @param dmpId The DMP ID (e.g. '11.12345/A1B2C3')
+ * @param includeExtensions Whether or not to include the DMP Tool specific extensions
+ * in the returned record. Defaults to true.
+ * @returns The deleted DMP metadata record as an RDA Common Standard DMP metadata
+ * record with the DMP Tool specific extensions merged in.
+ * @throws DMPToolDynamoError if the record could not be deleted
+ */
+export declare const deleteDMP: (dmpId: string, includeExtensions?: boolean) => Promise<DMPToolDMPType>;
+export {};