@justworkflowit/cdk-constructs 0.0.1

package/README.md

@@ -0,0 +1,104 @@
+# @justworkflowit/cdk-constructs
+
+This package provides an easy-to-use AWS CDK construct for integrating your AWS environment with the [JustWorkflowIt](https://justworkflowit.com) platform.
+
+It sets up a secure integration by deploying:
+
+- An **integration Lambda** (deployed in your AWS account, maintained by JustWorkflowIt via NPM updates)
+- A **Secrets Manager secret** to store your JustWorkflowIt auth token
+- A **cross-account IAM role** that JustWorkflowIt can assume to perform actions on your behalf
+
+---
+
+## 🚀 Quick Start
+
+### 1. Install the package
+
+```bash
+npm install @justworkflowit/cdk-constructs
+```
+
+### 2. Add the construct to your CDK stack
+
+```ts
+import { JustWorkflowItConstruct } from "@justworkflowit/cdk-constructs";
+
+new JustWorkflowItConstruct(this, "JustWorkflowItIntegration");
+```
+
+---
+
+## 🔐 What It Deploys
+
+| Resource                 | Purpose                                                            |
+| ------------------------ | ------------------------------------------------------------------ |
+| `SecretsManager::Secret` | Created at `/justworkflowit/api/authToken` — paste your token here |
+| `IAM::Role`              | Named `JustWorkflowItExecutionRole` — assumed by JustWorkflowIt    |
+| `Lambda::Function`       | Runs inside your account and can call JustWorkflowIt APIs securely |
+
+---
+
+## 📥 Add Your Auth Token
+
+Once deployed, open [Secrets Manager](https://console.aws.amazon.com/secretsmanager/) and edit the secret:
+
+```
+/justworkflowit/api/authToken
+```
+
+Paste in your auth token from the JustWorkflowIt dashboard.
+
+---
+
+## ✅ Default Permissions Granted
+
+The IAM role created in your account will allow JustWorkflowIt to:
+
+- `lambda:InvokeFunction` – Call your Lambda functions
+- `sns:Publish` – Publish messages to SNS topics
+- `sqs:SendMessage` – Send messages to SQS queues
+
+This is designed to support typical event-driven integrations. Additional permissions can be added manually if needed.
+
+---
+
+## 📄 Outputs
+
+You may export the IAM Role ARN from your stack if you want to track or reference it elsewhere:
+
+```ts
+new cdk.CfnOutput(this, "WorkflowItRoleArn", {
+  value: myConstruct.crossAccountRole.roleArn,
+});
+```
+
+---
+
+## 🧠 Why Use This?
+
+- 🔐 Secure and isolated
+- ⚙️ Easy to deploy and revoke
+- ✅ Designed for least privilege and extensibility
+- 📦 Integrates seamlessly with the JustWorkflowIt ecosystem
+
+---
+
+## 🧪 Coming Soon
+
+- Pre-built Lambda integrations (e.g. syncers, processors)
+- Versioned permission sets
+- Auto token provisioning (via CDK parameter store or registration link)
+
+---
+
+## 🧰 Requirements
+
+- AWS CDK v2
+- Node.js 16+
+- Deployed into a CDK stack in your AWS account
+
+---
+
+## 🧑‍💻 License
+
+MIT License — © 2025 JustWorkflowIt

package/dist/lib/justWorkflowItConstruct.d.ts

@@ -0,0 +1,4 @@
+import { Construct } from 'constructs';
+export declare class JustWorkflowItConstruct extends Construct {
+    constructor(scope: Construct, id: string);
+}

package/dist/lib/justWorkflowItConstruct.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JustWorkflowItConstruct = void 0;
+const aws_cdk_lib_1 = require("aws-cdk-lib");
+const constructs_1 = require("constructs");
+const aws_lambda_1 = require("aws-cdk-lib/aws-lambda");
+const aws_iam_1 = require("aws-cdk-lib/aws-iam");
+const aws_secretsmanager_1 = require("aws-cdk-lib/aws-secretsmanager");
+class JustWorkflowItConstruct extends constructs_1.Construct {
+    constructor(scope, id) {
+        super(scope, id);
+        const secret = new aws_secretsmanager_1.Secret(this, 'JustWorkflowItAuthTokenSecret', {
+            secretName: '/justworkflowit/api/authToken',
+            description: 'Paste your JustWorkflowIt API auth token here to enable secure communication.',
+        });
+        const integrationLambda = new aws_lambda_1.Function(this, 'IntegrationLambda', {
+            runtime: aws_lambda_1.Runtime.NODEJS_18_X,
+            handler: 'index.handler',
+            code: aws_lambda_1.Code.fromInline(`
+            exports.handler = async () => {
+              console.log("Integration Lambda triggered.");
+            };
+          `),
+            timeout: aws_cdk_lib_1.Duration.seconds(10),
+            environment: {
+                AUTH_SECRET_NAME: '/justworkflowit/api/authToken',
+                API_BASE_URL: 'https://api.justworkflowit.com',
+            },
+        });
+        secret.grantRead(integrationLambda);
+        const executionRole = new aws_iam_1.Role(this, 'JustWorkflowItExecutionRole', {
+            roleName: 'JustWorkflowItExecutionRole',
+            assumedBy: new aws_iam_1.AccountPrincipal('588738588052'), // <-- Replace this with your actual account ID
+            description: 'Role assumed by JustWorkflowIt backend to perform actions inside this account.',
+        });
+        executionRole.addToPolicy(new aws_iam_1.PolicyStatement({
+            actions: ['lambda:InvokeFunction'],
+            resources: ['*'],
+        }));
+        executionRole.addToPolicy(new aws_iam_1.PolicyStatement({
+            actions: ['sns:Publish'],
+            resources: ['*'],
+        }));
+        executionRole.addToPolicy(new aws_iam_1.PolicyStatement({
+            actions: ['sqs:SendMessage'],
+            resources: ['*'],
+        }));
+    }
+}
+exports.JustWorkflowItConstruct = JustWorkflowItConstruct;

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export * from '../lib/justWorkflowItConstruct';

package/dist/src/index.js

@@ -0,0 +1,17 @@
+"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("../lib/justWorkflowItConstruct"), exports);

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@justworkflowit/cdk-constructs",
+  "description": "",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "lint": "eslint . --ext .ts"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "aws-cdk-lib": "^2.202.0",
+    "constructs": "^10.4.2"
+  },
+  "devDependencies": {
+    "cdk-cli": "^1.1.0",
+    "eslint": "^9.29.0",
+    "prettier": "^3.6.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "aws-cdk-lib": "^2.0.0",
+    "constructs": "^10.0.0"
+  }
+}