feat: add instance service (#510)

Signed-off-by: hxtree <[email protected]>

commitlint.config.js

@@ -1,7 +1,11 @@
 module.exports = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'scope-enum': [2, 'always', ['character', 'platform', 'user', 'library']],
+    'scope-enum': [
+      2,
+      'always',
+      ['character', 'platform', 'user', 'library', 'deps'],
+    ],
     'type-enum': [
       2,
       'always',

common/changes/@cats-cradle/nestjs-modules/feature-add-message-factory_2023-11-08-05-00.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cats-cradle/nestjs-modules",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cats-cradle/nestjs-modules"
+}

common/config/rush/repo-state.json

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "35dba17277aaf467f308553d1ab16371c6243f4b",
+  "pnpmShrinkwrapHash": "1bc5aceff8d614bebbd5f8c51cfef9dd3a538497",
   "preferredVersionsHash": "8ae0ba5bd02ec9c5763773a15e27aee08a6567f6"
 }

rush.json

@@ -323,6 +323,18 @@
         "@cats-cradle/create-bundle"
       ],
       "tags": ["service-package", "deploy-app"]
+    },
+    {
+      "packageName": "@cats-cradle/instances",
+      "projectFolder": "services/instances",
+      "reviewCategory": "apis",
+      "decoupledLocalDependencies": [
+        "@cats-cradle/eslint-config",
+        "@cats-cradle/nestjs-modules",
+        "@cats-cradle/create-artifact",
+        "@cats-cradle/create-bundle"
+      ],
+      "tags": ["service-package", "deploy-app"]
     }
   ]
 }

services/instances/.env.dist

@@ -0,0 +1,11 @@
+AWS_ACCOUNT_ID=123456789012
+AWS_REGION=us-east-2
+STAGE_NAME=default
+BASE_URL=unknown
+
+APP_NAME=instance
+ENVIROMENT=local
+
+MONGO_DATABASE_URI=
+MONGO_DATABASE_USER=
+MONGO_DATABASE_PASSWORD=

services/instances/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['@cats-cradle/eslint-config/profile/base'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+  },
+};

services/instances/README.md

@@ -0,0 +1,15 @@
+# cats-cradle/instances
+
+[![GitHub Stars](https://img.shields.io/github/stars/hxtree/cats-cradle?style=social)](https://github.com/hxtree/cats-cradle/stargazers)
+
+This service tracks instances. A instance is a unique Id used to define
+boundaries of other systems. Other than when it was created and whether it
+exists, not much else is managed by this service.
+
+For example, when playing a game each user could be assigned to an instance. If
+two or more players were assigned to the same instance, they would share the
+game experience. Meaning what happens in one users game would happen in the
+others user game.
+
+This concept can be applied to many other business use cases, but the service is
+primarily useful for maintaining isolation of data that spans multiple services.

services/instances/bin/app.ts

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+import * as cdk from 'aws-cdk-lib';
+import { InstanceStack } from '../stacks/instance.stack';
+
+const app = new cdk.App();
+new InstanceStack(app, 'InstanceStack');

services/instances/cdk.json

@@ -0,0 +1,17 @@
+{
+  "app": "create-bundle && npx ts-node --prefer-ts-exts bin/app.ts",
+  "watch": {
+    "include": ["src/", "stacks/"],
+    "exclude": ["__tests__", "*.test.ts", "*.e2e-spec.ts"]
+  },
+  "context": {
+    "@aws-cdk/aws-apigateway:usagePlanKeyOrderInsensitiveId": true,
+    "@aws-cdk/core:stackRelativeExports": true,
+    "@aws-cdk/aws-rds:lowercaseDbIdentifier": true,
+    "@aws-cdk/aws-lambda:recognizeVersionProps": true,
+    "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true,
+    "@aws-cdk-containers/ecs-service-extensions:enableDefaultLogDriver": true,
+    "@aws-cdk/aws-ec2:uniqueImdsv2TemplateName": true,
+    "@aws-cdk/core:target-partitions": ["aws", "aws-cn"]
+  }
+}

services/instances/jest-mongodb-config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  mongodbMemoryServerOptions: {
+    binary: {
+      version: '6.0.0',
+      skipMD5: true,
+    },
+    instance: {},
+    autoStart: false,
+  },
+  mongoURLEnvName: 'MONGO_DATABASE_URI',
+};

services/instances/jest.config.json

@@ -0,0 +1,3 @@
+{
+  "preset": "./node_modules/@cats-cradle/base-nodejs/profiles/nestjs-app/jest.config.json"
+}