@mbc-cqrs-serverless/cli 0.1.49-beta.0 → 0.1.51-beta.0

package/dist/utils/formatting.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeToKebabOrSnakeCase = normalizeToKebabOrSnakeCase;
+/**
+ *
+ * @param str
+ * @returns formated string
+ * @description normalizes input to supported path and file name format.
+ * Changes camelCase strings to kebab-case, replaces spaces with dash and keeps underscores.
+ */
+function normalizeToKebabOrSnakeCase(str) {
+    const STRING_DASHERIZE_REGEXP = /\s/g;
+    const STRING_DECAMELIZE_REGEXP = /([a-z\d])([A-Z])/g;
+    return str
+        .replace(STRING_DECAMELIZE_REGEXP, '$1-$2')
+        .toLowerCase()
+        .replace(STRING_DASHERIZE_REGEXP, '-');
+}

package/dist/utils/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./formatting"), exports);
+__exportStar(require("./local-binaries"), exports);

package/dist/utils/local-binaries.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.localBinExists = localBinExists;
+exports.loadLocalBinCommandLoader = loadLocalBinCommandLoader;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const localBinPathSegments = [
+    process.cwd(),
+    'node_modules',
+    '@mbc-cqrs-serverless',
+    'cli',
+];
+function localBinExists() {
+    return (0, fs_1.existsSync)((0, path_1.join)(...localBinPathSegments));
+}
+function loadLocalBinCommandLoader() {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const commandLoader = require(path_1.posix.join(...localBinPathSegments, 'dist', 'commands'));
+    return commandLoader;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mbc-cqrs-serverless/cli",
-  "version": "0.1.49-beta.0",
+  "version": "0.1.51-beta.0",
   "description": "a CLI to get started with MBC CQRS serverless framework",
   "keywords": [
     "mbc",
@@ -15,8 +15,9 @@
     "fargate",
     "step-functions",
     "sqs",
-    "typpescript"
+    "typescript"
   ],
+  "schematics": "./dist/schematics/collection.json",
   "bin": {
     "mbc": "./dist/index.js"
   },
@@ -27,7 +28,7 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "postbuild": "copyfiles ./schematics/collection.json ./schematics/**/schema.json ./schematics/**/files/** ./schematics/**/units/** dist && copyfiles -u 2 -a dist/src/**/* dist && copyfiles -u 2 -a dist/src/index.js dist && rm -rf dist/src"
   },
   "repository": {
     "type": "git",
@@ -43,11 +44,19 @@
     "access": "public"
   },
   "dependencies": {
+    "@angular-devkit/core": "^17.3.11",
+    "@angular-devkit/schematics": "^17.3.11",
+    "@angular-devkit/schematics-cli": "^17.3.11",
+    "@schematics/angular": "^17.3.11",
+    "chalk": "^4.1.2",
+    "cli-table3": "^0.6.5",
     "commander": "^11.1.0",
+    "js-yaml": "^4.1.0",
     "rimraf": "^5.0.5"
   },
   "devDependencies": {
-    "@faker-js/faker": "^8.3.1"
+    "@faker-js/faker": "^8.3.1",
+    "copyfiles": "^2.4.1"
   },
-  "gitHead": "4fb13a54044022d4423830c985b51dd8ec58259a"
+  "gitHead": "6935a6c2f929944e111d953a06929dcc26321624"
 }

package/templates/.env.local

@@ -54,4 +54,4 @@ SES_FROM_EMAIL=email@example.com
 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
+LOCAL_DDB_SAMPLE_STREAM=arn:aws:dynamodb:ddblocal:000000000000:table/local-test-cli-sample-command/stream/2025-01-14T12:05:57.881

package/templates/README.md

@@ -46,7 +46,7 @@ $ npm run offline:docker
 $ 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
+#LOCAL_DDB_SAMPLE_STREAM=arn:aws:dynamodb:ddblocal:000000000000:table/local-test-cli-sample-command/stream/2025-01-14T12:05:57.881
 
 # serverless, open in other terminal session
 $ npm run offline:sls

package/templates/infra/README.md

@@ -1,9 +1,14 @@
 # Welcome to your CDK TypeScript project
 
-This is a blank project for CDK development with TypeScript.
+This is a project for CDK development with TypeScript.
 
 The `cdk.json` file tells the CDK Toolkit how to execute your app.
 
+## Instruction
+
+- Install requirement package by using command `pnpm install`
+- Update test snapshot by using command `npm run test -- --updateSnapshot`
+
 ## Use SSO profile
 
 ```bash

package/templates/infra/libs/infra-stack.ts

@@ -779,7 +779,7 @@ export class InfraStack extends cdk.Stack {
       }),
     )
     // dynamodb event source
-    const tableNames = ['tasks', 'master-command']
+    const tableNames = ['tasks', 'sample-command']
     for (const tableName of tableNames) {
       const tableDesc = new cdk.custom_resources.AwsCustomResource(
         this,

package/templates/infra-local/docker-compose.yml

@@ -38,7 +38,7 @@ services:
   dynamodb-admin:
     image: aaronshaf/dynamodb-admin
     environment:
-      - DYNAMO_ENDPOINT=dynamodb-local:8000
+      - DYNAMO_ENDPOINT=http://dynamodb-local:8000
       - AWS_REGION=ap-northeast-1
       - AWS_ACCESS_KEY_ID=local
       - AWS_SECRET_ACCESS_KEY=local

package/templates/infra-local/serverless.yml

@@ -29,16 +29,12 @@ custom:
       - topic:
           topicName: CqrsSnsTopic
           rawMessageDelivery: 'true'
-          filterPolicy: { 'action': ['task-execute'] }
+          filterPolicy: { 'action': [ 'task-execute' ] }
         queue: http://localhost:9324/101010101010/task-action-queue
       - topic:
           topicName: CqrsSnsTopic
           rawMessageDelivery: 'true'
-          filterPolicy:
-            {
-              'action':
-                ['notification-action', 'command-status', 'task-status'],
-            }
+          filterPolicy: { 'action': [ 'notification-action', 'command-status', 'task-status' ] }
         queue: http://localhost:9324/101010101010/notification-queue
       - topic:
           topicName: AlarmSnsTopic
@@ -106,35 +102,37 @@ provider:
         issuerUrl: http://localhost:9229/local_2G7noHgW
         audience:
           - dnk8y7ii3wled35p3lw0l2cd7
-      keycloakAuthorizer:
-        type: jwt
-        identitySource: $request.header.Authorization
-        issuerUrl: http://localhost:8180/realms/master
-        # issuerUrl: http://localhost:8180/auth/realms/master # old version
-        audience:
-          - cqrs-demo
+      # keycloakAuthorizer:
+      #   type: jwt
+      #   identitySource: $request.header.Authorization
+      #   issuerUrl: http://localhost:8180/realms/master
+      #   # issuerUrl: http://localhost:8180/auth/realms/master # old version
+      #   audience:
+      #     - cqrs-demo
 
 functions:
   main:
     handler: ../dist/main.handler
     events:
-      - httpApi: # public api
+      - httpApi:
+          # public api
           method: GET
           path: /
       - httpApi:
           method: ANY
           path: '/swagger-ui/{proxy+}'
-      - httpApi: # protected api
+      - httpApi:
+          # protected api
           method: ANY
           path: '/{proxy+}'
           authorizer:
             name: localAuthorizer
           # authorizer:
           #   name: keycloakAuthorizer
-      # - eventBridge:
-      #     eventBus: marketing
-      #     # run every 5 minutes
-      #     schedule: "cron(0/5 * * * ? *)"
+          # - eventBridge:
+          #     eventBus: marketing
+          #     # run every 5 minutes
+          #     schedule: "cron(0/5 * * * ? *)"
       - sqs:
           arn:
             Fn::GetAtt:
@@ -148,9 +146,9 @@ functions:
       - stream:
           type: dynamodb
           maximumRetryAttempts: 10
-          arn: ${env:LOCAL_DDB_MASTER_STREAM}
+          arn: ${env:LOCAL_DDB_SAMPLE_STREAM}
           filterPatterns:
-            - eventName: [INSERT]
+            - eventName: [ INSERT ]
 
 stepFunctions:
   # https://goessner.net/articles/JsonPath/index.html

package/templates/infra-local/swagger.json

@@ -0,0 +1,396 @@
+{
+  "openapi": "3.0.0",
+  "paths": {
+    "/": {
+      "get": {
+        "operationId": "AppController_getHello",
+        "parameters": [
+          {
+            "in": "header",
+            "required": false,
+            "name": "x-tenant-code",
+            "schema": {}
+          }
+        ],
+        "responses": { "200": { "description": "" } },
+        "tags": ["main"]
+      }
+    },
+    "/api/sample": {
+      "post": {
+        "operationId": "SampleController_publishCommand",
+        "parameters": [
+          {
+            "in": "header",
+            "required": false,
+            "name": "x-tenant-code",
+            "schema": {}
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": { "$ref": "#/components/schemas/SampleCommandDto" }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/SampleDataEntity" }
+              }
+            }
+          }
+        },
+        "tags": ["sample"]
+      }
+    },
+    "/api/sample/command/{pk}/{sk}": {
+      "get": {
+        "operationId": "SampleController_getCommand",
+        "parameters": [
+          {
+            "name": "pk",
+            "required": true,
+            "in": "path",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "sk",
+            "required": true,
+            "in": "path",
+            "schema": { "type": "string" }
+          },
+          {
+            "in": "header",
+            "required": false,
+            "name": "x-tenant-code",
+            "schema": {}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/SampleCommandEntity" }
+              }
+            }
+          }
+        },
+        "tags": ["sample"]
+      }
+    },
+    "/api/sample/data/{pk}/{sk}": {
+      "get": {
+        "operationId": "SampleController_getData",
+        "parameters": [
+          {
+            "name": "pk",
+            "required": true,
+            "in": "path",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "sk",
+            "required": true,
+            "in": "path",
+            "schema": { "type": "string" }
+          },
+          {
+            "in": "header",
+            "required": false,
+            "name": "x-tenant-code",
+            "schema": {}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/SampleDataEntity" }
+              }
+            }
+          }
+        },
+        "tags": ["sample"]
+      }
+    },
+    "/api/sample/data/{pk}": {
+      "get": {
+        "operationId": "SampleController_listDataByPk",
+        "parameters": [
+          {
+            "name": "pk",
+            "required": true,
+            "in": "path",
+            "schema": { "type": "string" }
+          },
+          {
+            "in": "header",
+            "required": false,
+            "name": "x-tenant-code",
+            "schema": {}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SampleDataListEntity"
+                }
+              }
+            }
+          }
+        },
+        "tags": ["sample"]
+      }
+    },
+    "/api/sample/data": {
+      "get": {
+        "operationId": "SampleController_searchData",
+        "parameters": [
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "number" }
+          },
+          {
+            "name": "pageSize",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "number" }
+          },
+          {
+            "name": "keyword",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "id",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "pk",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "sk",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "string" }
+          },
+          {
+            "name": "orderBys",
+            "required": false,
+            "in": "query",
+            "schema": { "type": "array", "items": { "type": "string" } }
+          },
+          {
+            "in": "header",
+            "required": false,
+            "name": "x-tenant-code",
+            "schema": {}
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SampleDataListEntity"
+                }
+              }
+            }
+          }
+        },
+        "tags": ["sample"]
+      }
+    }
+  },
+  "info": {
+    "title": "serverless",
+    "description": "The serverless API",
+    "version": "1.0.0",
+    "contact": {}
+  },
+  "tags": [],
+  "servers": [{ "url": "http://localhost:3000/", "description": "local" }],
+  "components": {
+    "securitySchemes": {
+      "Api-Key": { "type": "apiKey", "in": "header", "name": "Authorization" }
+    },
+    "schemas": {
+      "SampleAttributes": {
+        "type": "object",
+        "properties": { "value": { "type": "object" } },
+        "required": ["value"]
+      },
+      "SampleCommandDto": {
+        "type": "object",
+        "properties": {
+          "pk": { "type": "string" },
+          "sk": { "type": "string" },
+          "id": { "type": "string" },
+          "code": { "type": "string" },
+          "name": { "type": "string" },
+          "version": { "type": "number" },
+          "tenantCode": { "type": "string" },
+          "type": { "type": "string" },
+          "seq": { "type": "number" },
+          "ttl": { "type": "number" },
+          "isDeleted": { "type": "boolean" },
+          "attributes": { "$ref": "#/components/schemas/SampleAttributes" }
+        },
+        "required": [
+          "pk",
+          "sk",
+          "id",
+          "code",
+          "name",
+          "version",
+          "tenantCode",
+          "type",
+          "attributes"
+        ]
+      },
+      "SampleDataEntity": {
+        "type": "object",
+        "properties": {
+          "cpk": { "type": "string" },
+          "csk": { "type": "string" },
+          "source": { "type": "string" },
+          "requestId": { "type": "string" },
+          "createdAt": { "format": "date-time", "type": "string" },
+          "updatedAt": { "format": "date-time", "type": "string" },
+          "createdBy": { "type": "string" },
+          "updatedBy": { "type": "string" },
+          "createdIp": { "type": "string" },
+          "updatedIp": { "type": "string" },
+          "pk": { "type": "string" },
+          "sk": { "type": "string" },
+          "id": { "type": "string" },
+          "code": { "type": "string" },
+          "name": { "type": "string" },
+          "version": { "type": "number" },
+          "tenantCode": { "type": "string" },
+          "type": { "type": "string" },
+          "seq": { "type": "number" },
+          "ttl": { "type": "number" },
+          "isDeleted": { "type": "boolean" },
+          "attributes": { "$ref": "#/components/schemas/SampleAttributes" }
+        },
+        "required": [
+          "pk",
+          "sk",
+          "id",
+          "code",
+          "name",
+          "version",
+          "tenantCode",
+          "type",
+          "attributes"
+        ]
+      },
+      "SampleCommandEntity": {
+        "type": "object",
+        "properties": {
+          "source": { "type": "string" },
+          "isDeleted": { "type": "boolean" },
+          "status": { "type": "string" },
+          "requestId": { "type": "string" },
+          "createdAt": { "format": "date-time", "type": "string" },
+          "updatedAt": { "format": "date-time", "type": "string" },
+          "createdBy": { "type": "string" },
+          "updatedBy": { "type": "string" },
+          "createdIp": { "type": "string" },
+          "updatedIp": { "type": "string" },
+          "pk": { "type": "string" },
+          "sk": { "type": "string" },
+          "id": { "type": "string" },
+          "code": { "type": "string" },
+          "name": { "type": "string" },
+          "version": { "type": "number" },
+          "tenantCode": { "type": "string" },
+          "type": { "type": "string" },
+          "seq": { "type": "number" },
+          "ttl": { "type": "number" },
+          "attributes": { "$ref": "#/components/schemas/SampleAttributes" }
+        },
+        "required": [
+          "pk",
+          "sk",
+          "id",
+          "code",
+          "name",
+          "version",
+          "tenantCode",
+          "type",
+          "attributes"
+        ]
+      },
+      "DataEntity": {
+        "type": "object",
+        "properties": {
+          "cpk": { "type": "string" },
+          "csk": { "type": "string" },
+          "source": { "type": "string" },
+          "requestId": { "type": "string" },
+          "createdAt": { "format": "date-time", "type": "string" },
+          "updatedAt": { "format": "date-time", "type": "string" },
+          "createdBy": { "type": "string" },
+          "updatedBy": { "type": "string" },
+          "createdIp": { "type": "string" },
+          "updatedIp": { "type": "string" },
+          "pk": { "type": "string" },
+          "sk": { "type": "string" },
+          "id": { "type": "string" },
+          "code": { "type": "string" },
+          "name": { "type": "string" },
+          "version": { "type": "number" },
+          "tenantCode": { "type": "string" },
+          "type": { "type": "string" },
+          "seq": { "type": "number" },
+          "ttl": { "type": "number" },
+          "isDeleted": { "type": "boolean" }
+        },
+        "required": [
+          "pk",
+          "sk",
+          "id",
+          "code",
+          "name",
+          "version",
+          "tenantCode",
+          "type"
+        ]
+      },
+      "SampleDataListEntity": {
+        "type": "object",
+        "properties": {
+          "total": { "type": "number" },
+          "lastSk": { "type": "string" },
+          "items": {
+            "type": "array",
+            "items": { "$ref": "#/components/schemas/DataEntity" }
+          }
+        },
+        "required": ["items"]
+      }
+    }
+  },
+  "security": [{ "Api-Key": [] }]
+}

package/templates/package.json

@@ -45,6 +45,7 @@
     "prisma": "^5.7.1"
   },
   "devDependencies": {
+    "@golevelup/ts-jest": "^0.6.1",
     "@mbc-cqrs-serverless/cli": "",
     "@nestjs/cli": "^10.2.1",
     "@nestjs/common": "^10.3.0",

package/templates/prisma/dynamodbs/cqrs.json

@@ -1 +1 @@
-["master"]
+["sample"]