@mbc-cqrs-serverless/cli 0.1.4-beta.0

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@mbc-cqrs-serverless/cli",
+  "version": "0.1.4-beta.0",
+  "description": "a CLI to get started with MBC CQRS serverless framework",
+  "bin": {
+    "mbc": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "templates"
+  ],
+  "scripts": {
+    "build": "rm -rf dist && tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mbc-net/mbc-cqrs-serverless.git"
+  },
+  "author": "MBC",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mbc-net/mbc-cqrs-serverless/issues"
+  },
+  "homepage": "https://mbc-net.github.io/mbc-cqrs-serverless-doc/",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "commander": "^11.1.0",
+    "rimraf": "^5.0.5"
+  },
+  "devDependencies": {
+    "@faker-js/faker": "^8.3.1",
+    "@mbc-cqrs-serverless/core": "^0.1.4-beta.0"
+  },
+  "gitHead": "f9bee15b584659c103ee0439b6b442cff12e0067"
+}

package/templates/.env.local

@@ -0,0 +1,54 @@
+# AWS_PROFILE=local
+AWS_ACCESS_KEY_ID=local
+AWS_SECRET_ACCESS_KEY=local
+AWS_DEFAULT_REGION=ap-northeast-1
+# running environment
+NODE_ENV=local # local, dev, stg, prod
+# name of application
+APP_NAME=demo
+# set log levels
+LOG_LEVEL=verbose # debug, verbose, info, warn, error, fatal
+# disable event route for API GW integration
+EVENT_SOURCE_DISABLED=false
+# DynamoDB endpoint, useful for local development
+DYNAMODB_ENDPOINT=http://localhost:8000
+DYNAMODB_REGION=ap-northeast-1
+# set the limit size for `attributes` of object in DDB
+ATTRIBUTE_LIMIT_SIZE=389120 # bytes, refer to https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ServiceQuotas.html#limits-attributes
+# S3 endpoint, useful for local development
+S3_ENDPOINT=http://localhost:4566
+S3_REGION=ap-northeast-1
+# save DDB attributes
+S3_BUCKET_NAME=local-bucket
+# Step Function endpoint, useful for local development
+SFN_ENDPOINT=http://localhost:8083
+SFN_REGION=ap-northeast-1
+SFN_COMMAND_ARN=arn:aws:states:ap-northeast-1:101010101010:stateMachine:command
+# SNS endpoint, useful for local development
+SNS_ENDPOINT=http://localhost:4002
+SNS_REGION=ap-northeast-1
+SNS_TOPIC_ARN=arn:aws:sns:ap-northeast-1:101010101010:CqrsSnsTopic
+# Cognito endpoint, useful for local development
+COGNITO_URL=http://localhost:9229
+COGNITO_USER_POOL_ID=local_2G7noHgW
+COGNITO_USER_POLL_CLIENT_ID=dnk8y7ii3wled35p3lw0l2cd7
+COGNITO_REGION=ap-northeast-1
+# AppSync endpoint, useful for local development
+APPSYNC_ENDPOINT=http://localhost:4001/graphql
+APPSYNC_API_KEY=da2-fakeApiId123456
+# SES email endpoint, useful for local development
+SES_ENDPOINT=http://localhost:8005
+SES_REGION=ap-northeast-1
+SES_FROM_EMAIL=email@example.com
+
+# This was inserted by `prisma init`:
+# Environment variables declared in this file are automatically made available to Prisma.
+# See the documentation for more detail: https://pris.ly/d/prisma-schema#accessing-environment-variables-from-the-schema
+
+# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
+# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
+
+DATABASE_URL="mysql://root:RootCqrs@localhost:3306/cqrs?schema=public&connection_limit=1"
+
+# serverless dynamodb local stream
+LOCAL_DDB_MASTER_STREAM=arn:aws:dynamodb:ddblocal:000000000000:table/local-demo-master-command/stream/2024-01-02T02:49:43.692

package/templates/.envrc

@@ -0,0 +1,3 @@
+export NEST_DEBUG=true
+export NODE_OPTIONS=--enable-source-maps
+export AWS_PROFILE=default

package/templates/.eslintrc.js

@@ -0,0 +1,50 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir: __dirname,
+    sourceType: 'module',
+  },
+  plugins: [
+    '@typescript-eslint/eslint-plugin',
+    'simple-import-sort',
+    'prettier',
+  ],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+    'prettier',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: [
+    '.eslintrc.js',
+    'prisma',
+    '**/*.spec.ts',
+    '**/*.test.ts',
+    'infra*',
+  ],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    'prettier/prettier': [
+      'error',
+      {
+        semi: false,
+        singleQuote: true,
+        trailingComma: 'all',
+        endOfLine: 'auto',
+        tabWidth: 2,
+        useTabs: false,
+      },
+    ],
+    'simple-import-sort/exports': 'error',
+    'simple-import-sort/imports': 'error',
+    'no-console': 'error',
+  },
+}

package/templates/.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "endOfLine": "auto",
+  "tabWidth": 2,
+  "useTabs": false
+}

package/templates/README.md

@@ -0,0 +1,168 @@
+## Description
+
+CQRS framework based on [Nest](https://github.com/nestjs/nest).
+
+TechStack:
+
+- [Nest](https://github/nestjs/nest)
+- TypeScript
+- AWS Serverless
+
+  - API GW
+  - Lambda
+  - Step Functions
+  - EventBridge
+  - DynamoDB
+
+- RDS - PostgreSQL
+- Serverless fw && Localstack for local development
+
+## Prepare
+
+- [Nodejs](https://nodejs.org/en/download)
+- [JQ cli](https://jqlang.github.io/jq/download/)
+- [AWS cli](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+- [Docker](https://docs.docker.com/engine/install/)
+
+## Installation
+
+```bash
+$ cp .env.local .env
+$ npm install
+```
+
+## Running the app
+
+```bash
+# development build
+$ npm run build
+
+# docker, open in other terminal session
+$ npm run offline:docker
+
+# create resources such as S3 buckets
+$ sh infra-local/resources.sh
+
+# migrate tables, open in other terminal session
+$ npm run migrate
+
+# copy dynamodb stream arn to `.env` file
+      # LOCAL_DDB_MASTER_STREAM=arn:aws:dynamodb:ddblocal:000000000000:table/local-demo-master-command/stream/2024-01-02T03:07:49.349
+
+# serverless, open in other terminal session
+$ npm run offline:sls
+```
+
+- After successfully running
+
+```bash
+DEBUG[serverless-offline-sns][adapter]: successfully subscribed queue "http://localhost:9324/101010101010/notification-queue" to topic: "arn:aws:sns:ap-northeast-1:101010101010:CqrsSnsTopic"
+Offline Lambda Server listening on http://localhost:4000
+serverless-offline-aws-eventbridge :: Plugin ready
+serverless-offline-aws-eventbridge :: Mock server running at port: 4010
+Starting Offline SQS at stage dev (ap-northeast-1)
+Starting Offline Dynamodb Streams at stage dev (ap-northeast-1)
+
+Starting Offline at stage dev (ap-northeast-1)
+
+Offline [http for lambda] listening on http://localhost:3002
+Function names exposed for local invocation by aws-sdk:
+           * main: serverless-example-dev-main
+Configuring JWT Authorization: ANY /{proxy+}
+
+   ┌────────────────────────────────────────────────────────────────────────┐
+   │                                                                        │
+   │   ANY | http://localhost:3000/api/public                               │
+   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
+   │   ANY | http://localhost:3000/swagger-ui/{proxy*}                      │
+   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
+   │   ANY | http://localhost:3000/{proxy*}                                 │
+   │   POST | http://localhost:3000/2015-03-31/functions/main/invocations   │
+   │                                                                        │
+   └────────────────────────────────────────────────────────────────────────┘
+
+Server ready: http://localhost:3000 🚀
+
+```
+
+## Helpers
+
+```bash
+# prisma command
+$ npx prisma
+```
+
+## Test
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Before use Keycloak
+
+Go to http://localhost:8180/admin/master/console/#/master/clients
+
+- create a new client
+
+  - Client type: `OpenID Connect`
+  - Client ID: `hello-world`
+  - Valid redirect URIs: `*`
+  - Web origins: `*`
+
+- go to Client scopes tab, then add new mapper
+
+  - Mapper type: `Audience`
+  - Name: `hello-world`
+  - Included Client Audience: `hello-world`
+  - Add to access token: `true`
+
+- Ref: https://www.keycloak.org/getting-started/getting-started-docker
+
+### Update `frontend/aws-export.js`
+
+```bash
+$ cp frontend/aws-export.local.js frontend/src/aws-export.js
+```
+
+## Step function execution
+
+```bash
+$ aws stepfunctions --endpoint-url http://localhost:8083 start-execution --state-machine-arn arn:aws:states:ap-northeast-1:101010101010:stateMachine:foo1
+```
+
+## Endpoints
+
+- api gw: http://localhost:3000
+- lambda: http://localhost:4000
+- lambda http: http://localhost:3002
+- step functions: http://localhost:8083
+- dynamodb: http://localhost:8000
+- dynamodb admin: http://localhost:8001
+- sns: http://localhost:4002
+- sqs: http://localhost:9324
+- sqs admin: http://localhost:9325
+- localstack: http://localhost:4566
+  - S3
+- appsync: http://localhost:4001
+- cognito: http://localhost:9229
+- eventbridge: http://localhost:4010
+- ses email: http://localhost:8005
+- prisma studio: http://localhost:5000
+  - run `npx prisma studio` to open studio web
+
+## Nestjs Debug mode
+
+Run the following cmd to open nestjs debug mode
+
+```
+$ npm run start:repl
+```
+
+- Ref: https://docs.nestjs.com/recipes/repl

package/templates/gitignore

@@ -0,0 +1,46 @@
+# compiled output
+/dist
+/dist_layer
+node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+pnpm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# docker volumn
+docker-data
+
+#cognito local
+.cognito
+
+.nestjs_repl_history
+
+.env

package/templates/infra-local/appsync-simulator/.dockerignore

@@ -0,0 +1 @@
+node_modules

package/templates/infra-local/appsync-simulator/Dockerfile

@@ -0,0 +1,8 @@
+FROM node:18-alpine
+WORKDIR /app
+
+COPY ./package.json ./
+COPY ./package-lock.json ./
+RUN npm install --legacy-peer-deps
+COPY . .
+CMD ["npm", "run", "serve"]