@mavogel/awscdk-rootmail 0.0.290 → 0.0.291

package/API.md

@@ -4,6 +4,8 @@
 
 ### Rootmail <a name="Rootmail" id="@mavogel/awscdk-rootmail.Rootmail"></a>
 
+Rootmail construct.
+
 #### Initializers <a name="Initializers" id="@mavogel/awscdk-rootmail.Rootmail.Initializer"></a>
 
 ```typescript
@@ -62,7 +64,7 @@ Returns a string representation of this construct.
 
 ---
 
-##### ~~`isConstruct`~~ <a name="isConstruct" id="@mavogel/awscdk-rootmail.Rootmail.isConstruct"></a>
+##### `isConstruct` <a name="isConstruct" id="@mavogel/awscdk-rootmail.Rootmail.isConstruct"></a>
 
 ```typescript
 import { Rootmail } from '@mavogel/awscdk-rootmail'
@@ -72,6 +74,20 @@ Rootmail.isConstruct(x: any)
 
 Checks if `x` is a construct.
 
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
 ###### `x`<sup>Required</sup> <a name="x" id="@mavogel/awscdk-rootmail.Rootmail.isConstruct.parameter.x"></a>
 
 - *Type:* any
@@ -85,8 +101,8 @@ Any object.
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#@mavogel/awscdk-rootmail.Rootmail.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
-| <code><a href="#@mavogel/awscdk-rootmail.Rootmail.property.emailBucket">emailBucket</a></code> | <code>aws-cdk-lib.aws_s3.Bucket</code> | *No description.* |
-| <code><a href="#@mavogel/awscdk-rootmail.Rootmail.property.hostedZoneParameterName">hostedZoneParameterName</a></code> | <code>string</code> | *No description.* |
+| <code><a href="#@mavogel/awscdk-rootmail.Rootmail.property.emailBucket">emailBucket</a></code> | <code>aws-cdk-lib.aws_s3.Bucket</code> | S3 bucket to store the root mails in. |
+| <code><a href="#@mavogel/awscdk-rootmail.Rootmail.property.hostedZoneParameterName">hostedZoneParameterName</a></code> | <code>string</code> | The name parameter in SSM to store the domain name server. |
 
 ---
 
@@ -110,6 +126,8 @@ public readonly emailBucket: Bucket;
 
 - *Type:* aws-cdk-lib.aws_s3.Bucket
 
+S3 bucket to store the root mails in.
+
 ---
 
 ##### `hostedZoneParameterName`<sup>Required</sup> <a name="hostedZoneParameterName" id="@mavogel/awscdk-rootmail.Rootmail.property.hostedZoneParameterName"></a>
@@ -120,11 +138,15 @@ public readonly hostedZoneParameterName: string;
 
 - *Type:* string
 
+The name parameter in SSM to store the domain name server.
+
 ---
 
 
 ### SESReceive <a name="SESReceive" id="@mavogel/awscdk-rootmail.SESReceive"></a>
 
+SES Receive construct.
+
 #### Initializers <a name="Initializers" id="@mavogel/awscdk-rootmail.SESReceive.Initializer"></a>
 
 ```typescript
@@ -183,7 +205,7 @@ Returns a string representation of this construct.
 
 ---
 
-##### ~~`isConstruct`~~ <a name="isConstruct" id="@mavogel/awscdk-rootmail.SESReceive.isConstruct"></a>
+##### `isConstruct` <a name="isConstruct" id="@mavogel/awscdk-rootmail.SESReceive.isConstruct"></a>
 
 ```typescript
 import { SESReceive } from '@mavogel/awscdk-rootmail'
@@ -193,6 +215,20 @@ SESReceive.isConstruct(x: any)
 
 Checks if `x` is a construct.
 
+Use this method instead of `instanceof` to properly detect `Construct`
+instances, even when the construct library is symlinked.
+
+Explanation: in JavaScript, multiple copies of the `constructs` library on
+disk are seen as independent, completely different libraries. As a
+consequence, the class `Construct` in each copy of the `constructs` library
+is seen as a different class, and an instance of one class will not test as
+`instanceof` the other class. `npm install` will not create installations
+like this, but users may manually symlink construct libraries together or
+use a monorepo tool: in those cases, multiple copies of the `constructs`
+library can be accidentally installed, and `instanceof` will behave
+unpredictably. It is safest to avoid using `instanceof`, and using
+this type-testing method instead.
+
 ###### `x`<sup>Required</sup> <a name="x" id="@mavogel/awscdk-rootmail.SESReceive.isConstruct.parameter.x"></a>
 
 - *Type:* any
@@ -226,6 +262,8 @@ The tree node.
 
 ### RootmailProps <a name="RootmailProps" id="@mavogel/awscdk-rootmail.RootmailProps"></a>
 
+Properties for the construct.
+
 #### Initializer <a name="Initializer" id="@mavogel/awscdk-rootmail.RootmailProps.Initializer"></a>
 
 ```typescript
@@ -268,6 +306,7 @@ public readonly customSesReceiveFunction: Function;
 ```
 
 - *Type:* aws-cdk-lib.aws_lambda.Function
+- *Default:* the provided functions within the construct
 
 The custom SES receive function to use.
 
@@ -349,7 +388,7 @@ public readonly wireDNSToHostedZoneID: string;
 ```
 
 - *Type:* string
-- *Default:* undefined
+- *Default:* emtpy string
 
 The hosted zone ID of the domain that is registered Route53 AND in the same AWS account to enable autowiring of the DNS records.
 
@@ -357,6 +396,8 @@ The hosted zone ID of the domain that is registered Route53 AND in the same AWS
 
 ### SESReceiveProps <a name="SESReceiveProps" id="@mavogel/awscdk-rootmail.SESReceiveProps"></a>
 
+Properties for the SESReceive construct.
+
 #### Initializer <a name="Initializer" id="@mavogel/awscdk-rootmail.SESReceiveProps.Initializer"></a>
 
 ```typescript
@@ -421,6 +462,7 @@ public readonly customSesReceiveFunction: Function;
 ```
 
 - *Type:* aws-cdk-lib.aws_lambda.Function
+- *Default:* the provided functions within the construct
 
 The custom SES receive function to use.
 
@@ -433,6 +475,7 @@ public readonly filteredEmailSubjects: string[];
 ```
 
 - *Type:* string[]
+- *Default:* 2 subjects: 'Your AWS Account is Ready - Get Started Now' and 'Welcome to Amazon Web Services'
 
 Filtered email subjects.
 
@@ -447,6 +490,7 @@ public readonly setDestroyPolicyToAllResources: boolean;
 ```
 
 - *Type:* boolean
+- *Default:* false
 
 Whether to set all removal policies to DESTROY.
 

package/CONTRIBUTING.md

@@ -31,9 +31,20 @@ To send us a pull request, please:
 
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass -> `yarn run test`
+3. Ensure local tests pass -> `npm test`
 4. The integ tests will run separately in the AWS account of the owner of the project.
-5. Build the project -> `yarn run build` to also update the `API.md` file.
+5. Build the project -> `npm build` to also update the `API.md` file.
+```bash
+# do this within the container as we build jsii for multiple targets
+docker run -it --rm -v $(pwd):/source -w /source --user 0:0 public.ecr.aws/jsii/superchain:1-bookworm-slim-node22 bash
+# clean node_modules for fresh dependencies for the OS within the container
+rm -rf node_modules
+npm ci
+# now build it
+npx projen build
+# also check for awscdk linting, which checks the API.md
+npm run awslint
+```
 6. Commit to your fork using clear commit messages.
 7. Send us a pull request, answering any default questions in the pull request interface.
 8. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

package/README.md

@@ -1,3 +1,11 @@
+![Source](https://img.shields.io/github/stars/MV-Consulting/awscdk-rootmail?logo=github&label=GitHub%20Stars)
+[![Build Status](https://github.com/MV-Consulting/awscdk-rootmail/actions/workflows/build.yml/badge.svg)](https://github.com/MV-Consulting/awscdk-rootmail/actions/workflows/build.yml)
+[![ESLint Code Formatting](https://img.shields.io/badge/code_style-eslint-brightgreen.svg)](https://eslint.org)
+[![Latest release](https://img.shields.io/github/release/MV-Consulting/awscdk-rootmail.svg)](https://github.com/MV-Consulting/awscdk-rootmail/releases)
+![GitHub](https://img.shields.io/github/license/MV-Consulting/awscdk-rootmail)
+[![npm](https://img.shields.io/npm/dt/@mavogel/awscdk-rootmail?label=npm&color=orange)](https://www.npmjs.com/package/@mavogel/awscdk-rootmail)
+[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@mavogel/cdk-vscode-server)
+
 # awscdk-rootmail
 
 A single email box for all your root user emails in all AWS accounts of the organization. 

package/integ-tests/functions/cleanup-handler.ts

@@ -24,10 +24,10 @@ export const handler = async (event: any) => {
   try {
     await emptyS3Bucket(s3, emailBucketName || '');
     // await deleteLogGroups(cwl, logGroupNamePrefixes);
-    return { success: 200 };
+    return 'OK';
   } catch (err) {
     console.log(`Error cleaning up: ${err}`);
-    return { success: 500, err: err };
+    return 'NOK';
   }
 };
 

package/integ-tests/functions/close-opsitem-handler.ts

@@ -89,7 +89,7 @@ export const handler = async (event: any) => {
       log({
         message: 'opsItem undefined',
       });
-      return { closeStatusCode: 500 };
+      return 'NOK';
     }
     log({
       message: 'Got opsItem',
@@ -114,7 +114,7 @@ export const handler = async (event: any) => {
         expected: `title: '${title}', source: '${source}', description: '${description}'`,
         got: `title: '${opsItemTitle}', source: '${opsItemSource}', description: '${opsItemDescription}'`,
       });
-      return { closeStatusCode: 500 };
+      return 'NOK';
     }
 
     // 2 close opsItem
@@ -130,7 +130,7 @@ export const handler = async (event: any) => {
         err: `httpStatusCode: ${resUpdate.$metadata.httpStatusCode}`,
       });
 
-      return { closeStatusCode: 500, err: resUpdate.$metadata.httpStatusCode };
+      return 'NOK';
     }
 
     log({
@@ -140,15 +140,13 @@ export const handler = async (event: any) => {
       res: resUpdate,
     });
 
-    // return { statusCode: res.$response.httpResponse.statusCode };
-    return { closeStatusCode: 200 };
+    return 'OK';
   } catch (err) {
     log({
       message: 'Error (catch) getting and closing opsItem',
       err: err,
     });
-    // return { statusCode: err.statusCode, err: err };
-    return { closeStatusCode: 500, err: err };
+    return 'NOK';
   }
 };
 

package/integ-tests/functions/send-email-handler.ts

@@ -41,7 +41,7 @@ export const handler = async (event: any) => {
         err: `httpStatusCode: ${res.$metadata.httpStatusCode}`,
       });
 
-      return { sendStatusCode: 500, err: res.$metadata.httpStatusCode };
+      return 'NOK';
     }
     log({
       message: 'Email sent',
@@ -49,15 +49,13 @@ export const handler = async (event: any) => {
       res: res,
     });
 
-    // return { statusCode: res.$response.httpResponse.statusCode };
-    return { sendStatusCode: 200 };
+    return 'OK';
   } catch (err) {
     log({
       message: 'Error (catch) sending email',
       err: err,
     });
-    // return { statusCode: err.statusCode, err: err };
-    return { sendStatusCode: 500, err: err };
+    return 'NOK';
   }
 };
 

package/integ-tests/integ.rootmail-custom-santa.ts

@@ -30,11 +30,6 @@ const customSesReceiveFunction = new NodejsFunction(stackUnderTest, 'custom-ses-
   runtime: lambda.Runtime.NODEJS_18_X,
   logRetention: 1,
   timeout: Duration.seconds(30),
-  bundling: {
-    esbuildArgs: {
-      "--packages": "bundle",
-    },
-  },
 });
 
 customSesReceiveFunction.addToRolePolicy(new iam.PolicyStatement({
@@ -92,11 +87,6 @@ const sendEmailHandler = new NodejsFunction(stackUnderTest, 'send-email-handler'
       resources: ['*'],
     }),
   ],
-  bundling: {
-    esbuildArgs: {
-      "--packages": "bundle",
-    },
-  },
 });
 
 /**
@@ -110,22 +100,14 @@ const sendTestEmailAssertion = integ.assertions
   .invokeFunction({
     functionName: sendEmailHandler.functionName,
     logType: LogType.TAIL,
-    invocationType: InvocationType.REQUEST_RESPONE, // to run it synchronously
+    invocationType: InvocationType.REQUEST_RESPONSE, // to run it synchronously
     payload: JSON.stringify({
       id: id,
       text: message,
       sourceMail: `test@${fullDomain}`,
       toMail: `root+${id}@${fullDomain}`,
     }),
-  }).expect(ExpectedResult.objectLike(
-    // as the object 'return { sendStatusCode: 200 };' is wrapped in a Payload object with other properties
-    {
-      Payload: {
-        sendStatusCode: 200,
-      },
-    },
-  ),
-  );
+  }).expect(ExpectedResult.objectLike({ Payload: '"OK"' }));
 
 const getHostedZoneParametersAssertion = integ.assertions
   /**

package/integ-tests/integ.rootmail-custom-santa.ts.snapshot/RootmailIntegTestStack.assets.json

@@ -1,28 +1,28 @@
 {
-  "version": "33.0.0",
+  "version": "39.0.0",
   "files": {
-    "9ac6d29f0cc4b20ec46e4c186d9a6f6448c7ea11b689e70a5dda69671a9d6848": {
+    "b01091642674a865788c271ec84db9d88a8dfbe14d4d95583aca8814cfa848b9": {
       "source": {
-        "path": "asset.9ac6d29f0cc4b20ec46e4c186d9a6f6448c7ea11b689e70a5dda69671a9d6848",
+        "path": "asset.b01091642674a865788c271ec84db9d88a8dfbe14d4d95583aca8814cfa848b9",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "9ac6d29f0cc4b20ec46e4c186d9a6f6448c7ea11b689e70a5dda69671a9d6848.zip",
+          "objectKey": "b01091642674a865788c271ec84db9d88a8dfbe14d4d95583aca8814cfa848b9.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
     },
-    "5cc92ed0cea39e2b8de2dbc527dfb5980a3af9564bd1084d840b9787c7d0467e": {
+    "2819175352ad1ce0dae768e83fc328fb70fb5f10b4a8ff0ccbcb791f02b0716d": {
       "source": {
-        "path": "asset.5cc92ed0cea39e2b8de2dbc527dfb5980a3af9564bd1084d840b9787c7d0467e",
+        "path": "asset.2819175352ad1ce0dae768e83fc328fb70fb5f10b4a8ff0ccbcb791f02b0716d",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "5cc92ed0cea39e2b8de2dbc527dfb5980a3af9564bd1084d840b9787c7d0467e.zip",
+          "objectKey": "2819175352ad1ce0dae768e83fc328fb70fb5f10b4a8ff0ccbcb791f02b0716d.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
@@ -40,15 +40,15 @@
         }
       }
     },
-    "f2d30cfc360482320a52a4fcde8a70f3569df79ab30be24650fda58eb60052cf": {
+    "bdc104ed9cab1b5b6421713c8155f0b753380595356f710400609664d3635eca": {
       "source": {
-        "path": "asset.f2d30cfc360482320a52a4fcde8a70f3569df79ab30be24650fda58eb60052cf",
+        "path": "asset.bdc104ed9cab1b5b6421713c8155f0b753380595356f710400609664d3635eca",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "f2d30cfc360482320a52a4fcde8a70f3569df79ab30be24650fda58eb60052cf.zip",
+          "objectKey": "bdc104ed9cab1b5b6421713c8155f0b753380595356f710400609664d3635eca.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
@@ -131,20 +131,20 @@
         }
       }
     },
-    "d2b520d86fd9d964c83dc0d5ce2e4456dbde5fa7ae0c791a71865cbdfe2fb855": {
+    "2b86f8b255c50c6eba274c368849bab1c7a3747c30ef5df4c96f8dea8fffa21e": {
       "source": {
-        "path": "asset.d2b520d86fd9d964c83dc0d5ce2e4456dbde5fa7ae0c791a71865cbdfe2fb855",
+        "path": "asset.2b86f8b255c50c6eba274c368849bab1c7a3747c30ef5df4c96f8dea8fffa21e",
         "packaging": "zip"
       },
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "d2b520d86fd9d964c83dc0d5ce2e4456dbde5fa7ae0c791a71865cbdfe2fb855.zip",
+          "objectKey": "2b86f8b255c50c6eba274c368849bab1c7a3747c30ef5df4c96f8dea8fffa21e.zip",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }
     },
-    "43f46a8a4352e5d8823b3dc3e2f367cf50c48a4b4d1da8ed6e0d1463299d34ba": {
+    "e89edaf4c95d4ec233759458c98b6c1e94ba575875cd992043e5a57f36a99f65": {
       "source": {
         "path": "RootmailIntegTestStack.template.json",
         "packaging": "file"
@@ -152,7 +152,7 @@
       "destinations": {
         "current_account-current_region": {
           "bucketName": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}",
-          "objectKey": "43f46a8a4352e5d8823b3dc3e2f367cf50c48a4b4d1da8ed6e0d1463299d34ba.json",
+          "objectKey": "e89edaf4c95d4ec233759458c98b6c1e94ba575875cd992043e5a57f36a99f65.json",
           "assumeRoleArn": "arn:${AWS::Partition}:iam::${AWS::AccountId}:role/cdk-hnb659fds-file-publishing-role-${AWS::AccountId}-${AWS::Region}"
         }
       }