deployable-awscdk-app-ts 0.0.1 → 0.0.5

package/.jsii

@@ -7,22 +7,21 @@
     ]
   },
   "dependencies": {
-    "projen": "^0.34.26"
+    "projen": "^0.37.1"
   },
   "dependencyClosure": {
     "projen": {
       "submodules": {
         "projen.awscdk": {},
-        "projen.deps": {},
-        "projen.git": {},
+        "projen.cdk": {},
+        "projen.cdk8s": {},
+        "projen.cdktf": {},
         "projen.github": {},
         "projen.github.workflows": {},
         "projen.java": {},
         "projen.javascript": {},
-        "projen.json": {},
         "projen.python": {},
         "projen.release": {},
-        "projen.tasks": {},
         "projen.typescript": {},
         "projen.vscode": {},
         "projen.web": {}
@@ -67,7 +66,7 @@
   },
   "name": "deployable-awscdk-app-ts",
   "readme": {
-    "markdown": "# Deployable Typescript AWS CDK App Projen Project\n\nInspired by [projen](https://github.com/projen/projen)\nThis is a projen project for typescript AWS CDK Applications deployed via github actions.\n\n## Getting started\n\nTo create a new project, run the following command and follow the instructions:\n\n```\nconsole\n$ mkdir my-project\n$ cd my-project\n$ git init\n$ npx projen new --from deployable-awscdk-app-ts\n🤖 Synthesizing project...\n...\n```\n\nThis will initialize a projen project and will create `.projenrc.js` file for capturing the project details and options. Below is an example of the contents in this file\n\n### Example\n```javascript\nconst { DeployableAwsCdkTypeScriptApp } = require('deployable-awscdk-app-ts');\n\nconst project = new TypeScriptProject({\n  name: 'my-test-app',\n  defaultReleaseBranch: 'main',\n  cdkVersion: '1.129.0',\n  workflowNodeVersion: '14.18.1',\n  deployOptions: {\n    environments: ['dev', 'prod'],\n    awsCredentials: {\n      accessKeyIdSecretName: 'secret-1',\n      secretAccessKeySecretName: 'secret-2',\n      region: 'aws-region-1',\n    },\n  }\n});\n\nproject.synth()\n```\n"
+    "markdown": "# Deployable Typescript AWS CDK App Projen Project\n\nInspired by [projen](https://github.com/projen/projen)\nThis is a projen project for typescript AWS CDK Applications deployed via github actions.\n\n## Getting started\n\nTo create a new project, run the following command and follow the instructions:\n\n```\nconsole\n$ mkdir my-project\n$ cd my-project\n$ git init\n$ npx projen new --from deployable-awscdk-app-ts\n🤖 Synthesizing project...\n...\n```\n\nThis will initialize a projen project and will create `.projenrc.js` file for capturing the project details and options. Below is an example of the contents in this file\n\n### Example\n```javascript\nconst { DeployableAwsCdkTypeScriptApp } = require('deployable-awscdk-app-ts');\n\nconst project = new TypeScriptProject({\n  name: 'my-test-app',\n  defaultReleaseBranch: 'main',\n  cdkVersion: '1.129.0',\n  workflowNodeVersion: '14.18.1',\n  deployOptions: {\n    environments: [\n      {\n        name: 'dev',\n        awsCredentials: {\n          accessKeyIdSecretName: 'dev-secret-1',\n          secretAccessKeySecretName: 'dev-secret-2',\n          region: 'dev-aws-region-1',\n        },\n      },\n      {\n        name: 'staging',\n        awsCredentials: {\n          accessKeyIdSecretName: 'staging-secret-1',\n          secretAccessKeySecretName: 'staging-secret-2',\n          region: 'staging-aws-region-1',\n        },\n      },\n    ]\n  }\n});\n\nproject.synth()\n```\n"
   },
   "repository": {
     "type": "git",
@@ -80,19 +79,19 @@
     }
   },
   "types": {
-    "deployable-awscdk-app-ts.AWSCredentialsBase": {
+    "deployable-awscdk-app-ts.AWSCredentials": {
       "assembly": "deployable-awscdk-app-ts",
       "datatype": true,
       "docs": {
         "stability": "stable"
       },
-      "fqn": "deployable-awscdk-app-ts.AWSCredentialsBase",
+      "fqn": "deployable-awscdk-app-ts.AWSCredentials",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 55
+        "line": 42
       },
-      "name": "AWSCredentialsBase",
+      "name": "AWSCredentials",
       "properties": [
         {
           "abstract": true,
@@ -104,7 +103,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 71
+            "line": 70
           },
           "name": "region",
           "type": {
@@ -114,70 +113,52 @@
         {
           "abstract": true,
           "docs": {
-            "default": "300",
+            "default": "\"AWS_ACCESS_KEY_ID\"",
             "stability": "stable",
-            "summary": "Duration of assume role session."
+            "summary": "GitHub Secret name for AWS Access Key Id."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 65
+            "line": 47
           },
-          "name": "assumeRoleDurationSeconds",
+          "name": "accessKeyIdSecretName",
           "optional": true,
           "type": {
-            "primitive": "number"
+            "primitive": "string"
           }
         },
         {
           "abstract": true,
           "docs": {
+            "default": "300",
             "stability": "stable",
-            "summary": "ARN of AWS role to be assumed."
+            "summary": "Duration of assume role session."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 59
+            "line": 64
           },
-          "name": "roleToAssume",
+          "name": "assumeRoleDurationSeconds",
           "optional": true,
           "type": {
-            "primitive": "string"
+            "primitive": "number"
           }
-        }
-      ],
-      "symbolId": "src/types:AWSCredentialsBase"
-    },
-    "deployable-awscdk-app-ts.AWSCredentialsGitHubSecrets": {
-      "assembly": "deployable-awscdk-app-ts",
-      "datatype": true,
-      "docs": {
-        "stability": "stable"
-      },
-      "fqn": "deployable-awscdk-app-ts.AWSCredentialsGitHubSecrets",
-      "interfaces": [
-        "deployable-awscdk-app-ts.AWSCredentialsBase"
-      ],
-      "kind": "interface",
-      "locationInModule": {
-        "filename": "src/types.ts",
-        "line": 31
-      },
-      "name": "AWSCredentialsGitHubSecrets",
-      "properties": [
+        },
         {
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "GitHub Secret name for AWS Access Key Id."
+            "summary": "ARN of AWS role to be assumed."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 35
+            "line": 58
           },
-          "name": "accessKeyIdSecretName",
+          "name": "roleToAssume",
+          "optional": true,
           "type": {
             "primitive": "string"
           }
@@ -185,73 +166,23 @@
         {
           "abstract": true,
           "docs": {
+            "default": "\"AWS_SECRET_ACCESS_KEY\"",
             "stability": "stable",
             "summary": "GitHub Secret name for AWS Secret Access Key."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 40
+            "line": 53
           },
           "name": "secretAccessKeySecretName",
+          "optional": true,
           "type": {
             "primitive": "string"
           }
         }
       ],
-      "symbolId": "src/types:AWSCredentialsGitHubSecrets"
-    },
-    "deployable-awscdk-app-ts.AWSCredentialsValues": {
-      "assembly": "deployable-awscdk-app-ts",
-      "datatype": true,
-      "docs": {
-        "stability": "stable"
-      },
-      "fqn": "deployable-awscdk-app-ts.AWSCredentialsValues",
-      "interfaces": [
-        "deployable-awscdk-app-ts.AWSCredentialsBase"
-      ],
-      "kind": "interface",
-      "locationInModule": {
-        "filename": "src/types.ts",
-        "line": 43
-      },
-      "name": "AWSCredentialsValues",
-      "properties": [
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "stable",
-            "summary": "AWS Access Key Id."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/types.ts",
-            "line": 47
-          },
-          "name": "accessKeyId",
-          "type": {
-            "primitive": "string"
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "stable",
-            "summary": "AWS Secret Access Key."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/types.ts",
-            "line": 52
-          },
-          "name": "secretAccessKey",
-          "type": {
-            "primitive": "string"
-          }
-        }
-      ],
-      "symbolId": "src/types:AWSCredentialsValues"
+      "symbolId": "src/types:AWSCredentials"
     },
     "deployable-awscdk-app-ts.DeployOptions": {
       "assembly": "deployable-awscdk-app-ts",
@@ -263,7 +194,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/types.ts",
-        "line": 10
+        "line": 16
       },
       "name": "DeployOptions",
       "properties": [
@@ -271,43 +202,18 @@
           "abstract": true,
           "docs": {
             "stability": "stable",
-            "summary": "AWS credential details for deployment."
+            "summary": "Environment settings to deploy to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 26
-          },
-          "name": "awsCredentials",
-          "type": {
-            "union": {
-              "types": [
-                {
-                  "fqn": "deployable-awscdk-app-ts.AWSCredentialsGitHubSecrets"
-                },
-                {
-                  "fqn": "deployable-awscdk-app-ts.AWSCredentialsValues"
-                }
-              ]
-            }
-          }
-        },
-        {
-          "abstract": true,
-          "docs": {
-            "stability": "stable",
-            "summary": "Environment names to deploy to."
-          },
-          "immutable": true,
-          "locationInModule": {
-            "filename": "src/types.ts",
-            "line": 14
+            "line": 20
           },
           "name": "environments",
           "type": {
             "collection": {
               "elementtype": {
-                "primitive": "string"
+                "fqn": "deployable-awscdk-app-ts.EnvironmentOptions"
               },
               "kind": "array"
             }
@@ -323,7 +229,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/types.ts",
-            "line": 21
+            "line": 27
           },
           "name": "stackPattern",
           "optional": true,
@@ -336,7 +242,7 @@
     },
     "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp": {
       "assembly": "deployable-awscdk-app-ts",
-      "base": "projen.AwsCdkTypeScriptApp",
+      "base": "projen.awscdk.AwsCdkTypeScriptApp",
       "docs": {
         "stability": "stable"
       },
@@ -347,7 +253,7 @@
         },
         "locationInModule": {
           "filename": "src/index.ts",
-          "line": 12
+          "line": 15
         },
         "parameters": [
           {
@@ -363,6 +269,21 @@
         "filename": "src/index.ts",
         "line": 8
       },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "1. Call \"this.preSynthesize()\"\n2. Delete all generated files\n3. Synthesize all sub-projects\n4. Synthesize all components of this project\n5. Call \"postSynthesize()\" for all components of this project\n6. Call \"this.postSynthesize()\"",
+            "stability": "stable",
+            "summary": "(experimental) Synthesize all project files into `outdir`."
+          },
+          "locationInModule": {
+            "filename": "src/index.ts",
+            "line": 33
+          },
+          "name": "synth",
+          "overrides": "projen.Project"
+        }
+      ],
       "name": "DeployableAwsCdkTypeScriptApp",
       "symbolId": "src/index:DeployableAwsCdkTypeScriptApp"
     },
@@ -374,7 +295,7 @@
       },
       "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions",
       "interfaces": [
-        "projen.AwsCdkTypeScriptAppOptions"
+        "projen.awscdk.AwsCdkTypeScriptAppOptions"
       ],
       "kind": "interface",
       "locationInModule": {
@@ -398,11 +319,78 @@
           "type": {
             "fqn": "deployable-awscdk-app-ts.DeployOptions"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "stable",
+            "summary": "Whether to generate nvmrc file for the node version of the project."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 13
+          },
+          "name": "generateNvmrc",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
         }
       ],
       "symbolId": "src/types:DeployableAwsCdkTypeScriptAppOptions"
+    },
+    "deployable-awscdk-app-ts.EnvironmentOptions": {
+      "assembly": "deployable-awscdk-app-ts",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "deployable-awscdk-app-ts.EnvironmentOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/types.ts",
+        "line": 30
+      },
+      "name": "EnvironmentOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "AWS credential details for deployment."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 39
+          },
+          "name": "awsCredentials",
+          "type": {
+            "fqn": "deployable-awscdk-app-ts.AWSCredentials"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Environment name to deploy to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 34
+          },
+          "name": "name",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/types:EnvironmentOptions"
     }
   },
-  "version": "0.0.1",
-  "fingerprint": "+TO8Vco2CMpIavkGQ6VrdWgKqzU7O+ardmdrk/JdZH4="
+  "version": "0.0.5",
+  "fingerprint": "bxQ9sr2mJai52+fKPoxVSD/IUpAOSNvgaoMN9gTizJ0="
 }

package/.projenrc.ts

@@ -1,8 +1,8 @@
-import {JsiiProject, NodePackageManager, NpmAccess, TextFile} from 'projen'
+import {javascript, cdk, TextFile} from 'projen'
 
 const nodeVersion = '14.18.1'
 
-const project = new JsiiProject({
+const project = new cdk.JsiiProject({
   author: 'Amin Fazl',
   authorAddress: 'amin.fazl@mondo.com.au',
   defaultReleaseBranch: 'main',
@@ -16,8 +16,8 @@ const project = new JsiiProject({
   ],
   projenrcTs: true,
   repositoryUrl: 'https://github.com/amin.fazl/deployable-awscdk-app-ts.git',
-  packageManager: NodePackageManager.NPM,
-  npmAccess: NpmAccess.PUBLIC,
+  packageManager: javascript.NodePackageManager.NPM,
+  npmAccess: javascript.NpmAccess.PUBLIC,
   deps: [
     'projen',
   ],