deployable-awscdk-app-ts 0.0.1

package/.gitattributes

@@ -0,0 +1,22 @@
+# ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen".
+
+*.snap                                  	linguist-generated
+/.eslintrc.json                         	linguist-generated
+/.gitattributes                         	linguist-generated
+/.github/pull_request_template.md       	linguist-generated
+/.github/workflows/build.yml            	linguist-generated
+/.github/workflows/pull-request-lint.yml	linguist-generated
+/.github/workflows/release.yml          	linguist-generated
+/.github/workflows/stale.yml            	linguist-generated
+/.github/workflows/upgrade-main.yml     	linguist-generated
+/.gitignore                             	linguist-generated
+/.mergify.yml                           	linguist-generated
+/.npmignore                             	linguist-generated
+/.nvmrc                                 	linguist-generated
+/.projen/**                             	linguist-generated
+/.projen/deps.json                      	linguist-generated
+/.projen/tasks.json                     	linguist-generated
+/LICENSE                                	linguist-generated
+/package-lock.json                      	linguist-generated
+/package.json                           	linguist-generated
+/tsconfig.dev.json                      	linguist-generated

package/.jsii

@@ -0,0 +1,408 @@
+{
+  "author": {
+    "email": "amin.fazl@mondo.com.au",
+    "name": "Amin Fazl",
+    "roles": [
+      "author"
+    ]
+  },
+  "dependencies": {
+    "projen": "^0.34.26"
+  },
+  "dependencyClosure": {
+    "projen": {
+      "submodules": {
+        "projen.awscdk": {},
+        "projen.deps": {},
+        "projen.git": {},
+        "projen.github": {},
+        "projen.github.workflows": {},
+        "projen.java": {},
+        "projen.javascript": {},
+        "projen.json": {},
+        "projen.python": {},
+        "projen.release": {},
+        "projen.tasks": {},
+        "projen.typescript": {},
+        "projen.vscode": {},
+        "projen.web": {}
+      },
+      "targets": {
+        "java": {
+          "maven": {
+            "artifactId": "projen",
+            "groupId": "io.github.cdklabs"
+          },
+          "package": "io.github.cdklabs.projen"
+        },
+        "js": {
+          "npm": "projen"
+        },
+        "python": {
+          "distName": "projen",
+          "module": "projen"
+        }
+      }
+    }
+  },
+  "description": "A projen project for Typescript AWS CDK App",
+  "docs": {
+    "stability": "stable"
+  },
+  "homepage": "https://github.com/amin.fazl/deployable-awscdk-app-ts.git",
+  "jsiiVersion": "1.46.0 (build cd08c55)",
+  "keywords": [
+    "AWS CDK",
+    "Deployment",
+    "Typescript",
+    "projen"
+  ],
+  "license": "Apache-2.0",
+  "metadata": {
+    "jsii": {
+      "pacmak": {
+        "hasDefaultInterfaces": true
+      }
+    }
+  },
+  "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"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/amin.fazl/deployable-awscdk-app-ts.git"
+  },
+  "schema": "jsii/0.10.0",
+  "targets": {
+    "js": {
+      "npm": "deployable-awscdk-app-ts"
+    }
+  },
+  "types": {
+    "deployable-awscdk-app-ts.AWSCredentialsBase": {
+      "assembly": "deployable-awscdk-app-ts",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "deployable-awscdk-app-ts.AWSCredentialsBase",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/types.ts",
+        "line": 55
+      },
+      "name": "AWSCredentialsBase",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "example": "\"us-east-2\"",
+            "stability": "stable",
+            "summary": "Default AWS region for the account."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 71
+          },
+          "name": "region",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "300",
+            "stability": "stable",
+            "summary": "Duration of assume role session."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 65
+          },
+          "name": "assumeRoleDurationSeconds",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "ARN of AWS role to be assumed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 59
+          },
+          "name": "roleToAssume",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "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."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 35
+          },
+          "name": "accessKeyIdSecretName",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "GitHub Secret name for AWS Secret Access Key."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 40
+          },
+          "name": "secretAccessKeySecretName",
+          "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"
+    },
+    "deployable-awscdk-app-ts.DeployOptions": {
+      "assembly": "deployable-awscdk-app-ts",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "deployable-awscdk-app-ts.DeployOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/types.ts",
+        "line": 10
+      },
+      "name": "DeployOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "AWS credential details for deployment."
+          },
+          "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
+          },
+          "name": "environments",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "if not provided matches all of the stacks in the CDK App.",
+            "stability": "stable",
+            "summary": "Regex for stacks to be deployed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 21
+          },
+          "name": "stackPattern",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/types:DeployOptions"
+    },
+    "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp": {
+      "assembly": "deployable-awscdk-app-ts",
+      "base": "projen.AwsCdkTypeScriptApp",
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptApp",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/index.ts",
+          "line": 12
+        },
+        "parameters": [
+          {
+            "name": "options",
+            "type": {
+              "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/index.ts",
+        "line": 8
+      },
+      "name": "DeployableAwsCdkTypeScriptApp",
+      "symbolId": "src/index:DeployableAwsCdkTypeScriptApp"
+    },
+    "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions": {
+      "assembly": "deployable-awscdk-app-ts",
+      "datatype": true,
+      "docs": {
+        "stability": "stable"
+      },
+      "fqn": "deployable-awscdk-app-ts.DeployableAwsCdkTypeScriptAppOptions",
+      "interfaces": [
+        "projen.AwsCdkTypeScriptAppOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/types.ts",
+        "line": 3
+      },
+      "name": "DeployableAwsCdkTypeScriptAppOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "Deployment options."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/types.ts",
+            "line": 7
+          },
+          "name": "deployOptions",
+          "type": {
+            "fqn": "deployable-awscdk-app-ts.DeployOptions"
+          }
+        }
+      ],
+      "symbolId": "src/types:DeployableAwsCdkTypeScriptAppOptions"
+    }
+  },
+  "version": "0.0.1",
+  "fingerprint": "+TO8Vco2CMpIavkGQ6VrdWgKqzU7O+ardmdrk/JdZH4="
+}

package/.nvmrc

@@ -0,0 +1 @@
+14.18.1

package/.projenrc.ts

@@ -0,0 +1,55 @@
+import {JsiiProject, NodePackageManager, NpmAccess, TextFile} from 'projen'
+
+const nodeVersion = '14.18.1'
+
+const project = new JsiiProject({
+  author: 'Amin Fazl',
+  authorAddress: 'amin.fazl@mondo.com.au',
+  defaultReleaseBranch: 'main',
+  name: 'deployable-awscdk-app-ts',
+  description: 'A projen project for Typescript AWS CDK App',
+  keywords: [
+    'projen',
+    'Typescript',
+    'AWS CDK',
+    'Deployment',
+  ],
+  projenrcTs: true,
+  repositoryUrl: 'https://github.com/amin.fazl/deployable-awscdk-app-ts.git',
+  packageManager: NodePackageManager.NPM,
+  npmAccess: NpmAccess.PUBLIC,
+  deps: [
+    'projen',
+  ],
+  peerDeps: [
+    'projen',
+  ],
+  devDeps: [
+    'fs-extra',
+    '@types/fs-extra',
+  ],
+  workflowNodeVersion: nodeVersion,
+  depsUpgradeOptions: {
+    ignoreProjen: false,
+  },
+})
+
+new TextFile(project, '.nvmrc', {
+  lines: [nodeVersion],
+})
+
+project.eslint?.addRules({
+  'curly': [
+    'error',
+    'multi',
+    'consistent',
+  ],
+  'semi': [
+    'error',
+    'never',
+  ],
+  'object-curly-spacing': 'error',
+  'nonblock-statement-body-position': ['error', 'below'],
+})
+
+project.synth()