@aptos-scp/isl-component-resource-definition 1.0.0

package/LICENSE.md

@@ -0,0 +1 @@
+Copyright (c) 2025 Aptos, Inc. All rights reserved.

package/README.md

@@ -0,0 +1,83 @@
+# isl-component-resource-definition
+
+Component is used to automate the initialization of AWS resources, specifically AWS EventBridge, based on user-defined metadata. 
+
+## Establish environment variables (workstation installation)
+
+Copy the .env.example file with default/sample environment variables for development to .env.
+Examine the variables and edit as necessary/appropriate for your workstation environment.
+
+```
+cp .env.example .env
+```
+
+## Installation
+
+First, make sure you are logged-in to the private NPM registry:
+
+```
+npm adduser --registry=https://registry.npmjs.org/ --scope=@aptos-scp
+```
+
+Then install the dependency packages:
+
+```
+npm install
+```
+
+## Building the component library
+
+First, make sure you've followed the instructions in the [Installation](installation) section so you're logged into the
+private NPM registry and have installed dependency packages.
+
+Then, to build the component library:
+
+```
+$ npm run build
+```
+
+You can then also run tests and coverage:
+
+```
+$ npm run test
+$ npm run test:ci
+```
+
+## Publishing changes
+
+To publish a new version to the NPM registry:
+
+1. Do these steps only on the master branch -- that is, not on a feature branch. Feature branches should be
+   merged to master before these steps.
+
+1. Commit and push the changes (on master).
+
+1. Update the version of the package using one of the following:
+
+   ```
+   npm version patch
+   ```
+
+   or
+
+   ```
+   npm version minor
+   ```
+
+   or one of the other variations (see [npm-version](https://docs.npmjs.com/cli/version))
+
+1. Push the version commit and all version tags to trigger the CircleCI build that will build and publish the updated component:
+
+   ```
+   git push origin master --follow-tags
+   ```
+
+   or
+
+   From WebStorm or IntelliJ make sure that the Push Tags check-box is checked, when you push changes.
+
+When the build in Circle CI sees the version tag, it will publish the changes to the NPM repository.
+
+## License
+
+Please see [LICENSE.md](LICENSE.md).

package/lib/resource-definition/bin/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/resource-definition/bin/index.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv = require("dotenv");
+const ResourceDefinitionFactory_1 = require("../factories/ResourceDefinitionFactory");
+dotenv.config();
+const [command, ...args] = process.argv.slice(2);
+const resourceDefinition = ResourceDefinitionFactory_1.ResourceDefinitionFactory.create("sam");
+resourceDefinition
+    .execute(command, args)
+    .then(() => {
+    console.log("Command executed successfully.");
+})
+    .catch((error) => {
+    console.error("Error executing command:", error);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/lib/resource-definition/factories/ResourceDefinitionFactory.d.ts

@@ -0,0 +1,4 @@
+import { IResourceDefinition } from "../interfaces/IResourceDefinition";
+export declare class ResourceDefinitionFactory {
+    static create(type: string): IResourceDefinition;
+}

package/lib/resource-definition/factories/ResourceDefinitionFactory.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceDefinitionFactory = void 0;
+const SamResourceDefinition_1 = require("../implementations/SamResourceDefinition");
+class ResourceDefinitionFactory {
+    static create(type) {
+        if (type === "sam") {
+            return new SamResourceDefinition_1.SamResourceDefinition();
+        }
+        else {
+            throw new Error(`Unknown resource definition type: ${type}`);
+        }
+    }
+}
+exports.ResourceDefinitionFactory = ResourceDefinitionFactory;
+//# sourceMappingURL=ResourceDefinitionFactory.js.map

package/lib/resource-definition/implementations/SamResourceDefinition.d.ts

@@ -0,0 +1,5 @@
+import { IResourceDefinition } from "../interfaces/IResourceDefinition";
+export declare class SamResourceDefinition implements IResourceDefinition {
+    execute(inputCommand: string, args: string[]): Promise<void>;
+    private evaluateEnvVars;
+}

package/lib/resource-definition/implementations/SamResourceDefinition.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SamResourceDefinition = void 0;
+const util = require("util");
+const child_process_1 = require("child_process");
+class SamResourceDefinition {
+    execute(inputCommand, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const execPromise = util.promisify(child_process_1.exec);
+            const evaluatedArgs = this.evaluateEnvVars(args);
+            const samCommand = `sam ${inputCommand} ${evaluatedArgs.join(" ")}`;
+            console.log(`Executing command: ${samCommand}`);
+            const { stdout, stderr } = yield execPromise(samCommand);
+            console.log(`SAM Execute Output: ${stdout}`);
+            if (stderr) {
+                console.error(`SAM Execute Error: ${stderr}`);
+            }
+        });
+    }
+    evaluateEnvVars(args) {
+        return args.map((arg) => {
+            if (arg.startsWith("%") && arg.endsWith("%")) {
+                const envVar = arg.slice(1, -1);
+                return process.env[envVar] || "";
+            }
+            return arg;
+        });
+    }
+}
+exports.SamResourceDefinition = SamResourceDefinition;
+//# sourceMappingURL=SamResourceDefinition.js.map

package/lib/resource-definition/interfaces/IResourceDefinition.d.ts

@@ -0,0 +1,3 @@
+export interface IResourceDefinition {
+    execute(inputCommand: string, args: string[]): Promise<void>;
+}

package/lib/resource-definition/interfaces/IResourceDefinition.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IResourceDefinition.js.map

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@aptos-scp/isl-component-resource-definition",
+  "version": "1.0.0",
+  "description": "Component is used to create Serverless application",
+  "private": false,
+  "license": "SEE LICENSE IN LICENSE.md",
+  "repository": {
+    "type": "git",
+    "url": "https://bitbucket.org/aptosretail/isl-component-resource-definition.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.com/"
+  },
+  "files": [
+    "/lib",
+    "!/lib/**/*.js.map",
+    "/types"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "bin": {
+    "resource-definition": "lib/resource-definition/bin/index.js"
+  },
+  "scripts": {
+    "commit": "git-cz",
+    "clean:node_modules": "rimraf \"node_modules\"",
+    "clean:build": "rimraf \"lib\" \"test-js\"",
+    "clean:test": "rimraf \"coverage\"",
+    "clean": "npm run clean:build && npm run clean:test",
+    "build:ci": "tsc && tsc --project ./test && npm run lint",
+    "build": "npm run build:ci",
+    "lint": "eslint -c .eslintrc.json --ext .ts \"@(src|test)/**/*.ts?(x)\"",
+    "pretest": "npm run clean:test",
+    "next-version": "./node_modules/@aptos-scp/scp-component-commit-configs/next-version.sh",
+    "test:ci": "LOG_LEVEL=ALL JEST_JUNIT_OUTPUT_FILE=./reports/test-results.xml jest --silent --coverage  --ci --reporters=default --reporters=jest-junit",
+    "test": "jest --coverage",
+    "publishPacts:ci": "node test-js/test-helpers/publish-pacts",
+    "watch": "tsc --watch",
+    "rb-post-patch": "./node_modules/@aptos-scp/scp-component-commit-configs/post-patch.sh",
+    "release": "npx semantic-release",
+    "prettier:format": "prettier --write ."
+  },
+  "dependencies": {
+    "dotenv": "^16.0.3"
+  },
+  "devDependencies": {
+    "@aptos-scp/eslint-config-scp": "^1.1.15",
+    "@aptos-scp/scp-component-commit-configs": "^5.0.9",
+    "@types/jest": "^29.5.14",
+    "eslint": "^8.35.0",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "mocha": "^10.2.0",
+    "node-fetch": "^3.3.0",
+    "nyc": "^15.1.0",
+    "path": "^0.12.7",
+    "pjson": "^1.0.9",
+    "prettier": "^2.8.4",
+    "reflect-metadata": "^0.2.2",
+    "rimraf": "^6.0.1",
+    "source-map-support": "^0.5.21",
+    "ts-jest": "^29.3.4",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5"
+  },
+  "config": {
+    "pact_do_not_track": true,
+    "commitizen": {
+      "path": "./node_modules/cz-customizable"
+    },
+    "cz-customizable": {
+      "config": "./node_modules/@aptos-scp/scp-component-commit-configs/.cz-config.js"
+    }
+  },
+  "mocha": {
+    "require": [
+      "ts-node/register",
+      "source-map-support/register",
+      "reflect-metadata",
+      "./test-js/test/test-helpers/commonChaiSetup",
+      "./test-js/test/test-helpers/initializeLogging",
+      "./test-js/test/test-helpers/node-fetch-polyfill"
+    ],
+    "recursive": true,
+    "full-trace": true,
+    "spec": "test/**/*.spec.ts"
+  },
+  "nyc": {
+    "include": [
+      "src/**/*"
+    ],
+    "exclude": [
+      "**/test-helpers/**"
+    ],
+    "extension": [
+      ".ts"
+    ],
+    "reporter": [
+      "text-summary",
+      "html",
+      "lcov"
+    ],
+    "all": true,
+    "sourceMap": true,
+    "instrument": true,
+    "check-coverage": true,
+    "lines": 99,
+    "statements": 99,
+    "functions": 99,
+    "branches": 99
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "commitlint": {
+    "extends": [
+      "@aptos-scp/scp-component-commit-configs/.commitlintrc.js"
+    ]
+  }
+}