@friggframework/devtools 2.0.0--canary.520.6641121.0 → 2.0.0--canary.517.35ee143.0

package/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+    "extends": "@friggframework/eslint-config"
+}

package/CHANGELOG.md

@@ -0,0 +1,132 @@
+# v1.2.0 (Tue Aug 06 2024)
+
+#### 🚀 Enhancement
+
+- CLI for Frigg - Install command for now [#322](https://github.com/friggframework/frigg/pull/322) ([@seanspeaks](https://github.com/seanspeaks))
+
+#### 🐛 Bug Fix
+
+- Add READMEs that will need updating, but for version releasing [#324](https://github.com/friggframework/frigg/pull/324) ([@seanspeaks](https://github.com/seanspeaks))
+- Add READMEs that will need updating, but for version releasing ([@seanspeaks](https://github.com/seanspeaks))
+- small update to integration testing / tooling [#304](https://github.com/friggframework/frigg/pull/304) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Added missing dependencies ([@seanspeaks](https://github.com/seanspeaks))
+- Added a missing dependency ([@seanspeaks](https://github.com/seanspeaks))
+- Updated to handle envs properly, also further refactoring, and better templating. ([@seanspeaks](https://github.com/seanspeaks))
+- WIP with help from Tabnine AI chat. ([@seanspeaks](https://github.com/seanspeaks))
+- Bump version to: v1.1.8 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+- use the factory methods for creating the mock integration so that everything is set up (mostly events and userActions) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.5 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.8 (Thu Jul 18 2024)
+
+#### 🐛 Bug Fix
+
+- Revert open to support commonjs [#319](https://github.com/friggframework/frigg/pull/319) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.6 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.7 (Mon Jul 15 2024)
+
+#### 🐛 Bug Fix
+
+- getAuthorizationRequirements() async [#318](https://github.com/friggframework/frigg/pull/318) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- await getAuthorizeRequirements() ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.6 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.6 (Fri Apr 26 2024)
+
+#### 🐛 Bug Fix
+
+- Small fix to validation errors and cleanup [#307](https://github.com/friggframework/frigg/pull/307) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- also cleanup devtools since all versions will bump ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.5 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.5 (Tue Apr 09 2024)
+
+#### 🐛 Bug Fix
+
+- update router to include options and refresh [#301](https://github.com/friggframework/frigg/pull/301) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump version to: v1.1.4 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+- Bump version to: v1.1.3 \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v2.0.0 (Sat Mar 30 2024)
+
+#### 💥 Breaking Change
+
+- revert HEAD to a corrected v1-connectwise release [#283](https://github.com/friggframework/frigg/pull/283) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### 🚀 Enhancement
+
+- Package redo [#294](https://github.com/friggframework/frigg/pull/294) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### 🐛 Bug Fix
+
+- delete all node_modules and regenerate lock file to potentially address known bug ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- add back the direct dependency on eslint as this might be leading to a deploy issue ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- create test, eslint-config and prettier-config packages as base shared dependencies ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- slight fix to mock integration module instantiation [#290](https://github.com/friggframework/frigg/pull/290) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- slight fix to mock integration module instantiation ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Publish ([@seanspeaks](https://github.com/seanspeaks))
+- Bump node and npm version for the whole repo (Fix CI) [#274](https://github.com/friggframework/frigg/pull/274) ([@seanspeaks](https://github.com/seanspeaks))
+- Revert main to last release [#284](https://github.com/friggframework/frigg/pull/284) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Revert "set test environment STAGE to dev" ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Add stage to test env [#282](https://github.com/friggframework/frigg/pull/282) ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- set test environment STAGE to dev ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+- Bump independent versions \[skip ci\] ([@seanspeaks](https://github.com/seanspeaks))
+
+#### Authors: 2
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))
+
+---
+
+# v1.1.0 (Wed Mar 20 2024)
+
+#### 🚀 Enhancement
+
+
+#### 🐛 Bug Fix
+
+- correct some bad automated edits, though they are not in relevant files ([@MichaelRyanWebber](https://github.com/MichaelRyanWebber))
+
+#### Authors: 4
+
+- [@MichaelRyanWebber](https://github.com/MichaelRyanWebber)
+- Nicolas Leal ([@nicolasmelo1](https://github.com/nicolasmelo1))
+- nmilcoff ([@nmilcoff](https://github.com/nmilcoff))
+- Sean Matthews ([@seanspeaks](https://github.com/seanspeaks))

package/infrastructure/domains/admin-scripts/admin-script-builder.js

@@ -0,0 +1,200 @@
+/**
+ * Admin Script Builder
+ *
+ * Domain Layer - Hexagonal Architecture
+ *
+ * Responsible for:
+ * - Creating SQS queue for admin script execution
+ * - Creating Lambda function for script execution (worker)
+ * - Creating Lambda function for admin API routes (router)
+ * - Creating EventBridge Scheduler resources (Phase 2)
+ * - Creating IAM roles for scheduler to invoke Lambda
+ */
+
+const { InfrastructureBuilder, ValidationResult } = require('../shared/base-builder');
+
+class AdminScriptBuilder extends InfrastructureBuilder {
+    constructor() {
+        super();
+        this.name = 'AdminScriptBuilder';
+    }
+
+    shouldExecute(appDefinition) {
+        return Array.isArray(appDefinition.adminScripts) && appDefinition.adminScripts.length > 0;
+    }
+
+    getDependencies() {
+        return []; // Can run independently
+    }
+
+    validate(appDefinition) {
+        const result = new ValidationResult();
+
+        if (!appDefinition.adminScripts) {
+            return result; // Not an error, just no scripts
+        }
+
+        if (!Array.isArray(appDefinition.adminScripts)) {
+            result.addError('adminScripts must be an array');
+            return result;
+        }
+
+        // Validate each script
+        appDefinition.adminScripts.forEach((script, index) => {
+            if (!script?.Definition?.name) {
+                result.addError(`Admin script at index ${index} is missing Definition or name`);
+            }
+        });
+
+        return result;
+    }
+
+    async build(appDefinition, discoveredResources) {
+        console.log(`\n[${this.name}] Configuring admin scripts...`);
+        console.log(`  Processing ${appDefinition.adminScripts.length} scripts...`);
+
+        const usePrismaLayer = appDefinition.usePrismaLambdaLayer !== false;
+        const adminConfig = appDefinition.admin || {};
+
+        const result = {
+            functions: {},
+            resources: {},
+            environment: {},
+            custom: {},
+            iamStatements: [],
+        };
+
+        // Create admin script queue
+        this.createAdminScriptQueue(result);
+
+        // Create Lambda function for script execution
+        this.createScriptExecutorFunction(result, usePrismaLayer);
+
+        // Create API routes for script management
+        this.createAdminScriptRoutes(result, usePrismaLayer);
+
+        // Phase 2: Create EventBridge Scheduler resources
+        if (adminConfig.enableScheduling) {
+            this.createSchedulerResources(appDefinition, result);
+        }
+
+        // Log registered scripts
+        appDefinition.adminScripts.forEach(script => {
+            const name = script.Definition?.name || 'unknown';
+            const schedule = script.Definition?.schedule;
+            console.log(`    ✓ Registered: ${name}${schedule?.enabled ? ' (scheduled)' : ''}`);
+        });
+
+        console.log(`[${this.name}] ✅ Admin script configuration completed`);
+        return result;
+    }
+
+    createAdminScriptQueue(result) {
+        result.resources.AdminScriptQueue = {
+            Type: 'AWS::SQS::Queue',
+            Properties: {
+                QueueName: '${self:service}-${self:provider.stage}-AdminScriptQueue',
+                MessageRetentionPeriod: 86400, // 1 day
+                VisibilityTimeout: 900, // 15 minutes (Lambda max)
+                RedrivePolicy: {
+                    maxReceiveCount: 3,
+                    deadLetterTargetArn: {
+                        'Fn::GetAtt': ['InternalErrorQueue', 'Arn'],
+                    },
+                },
+            },
+        };
+
+        result.environment.ADMIN_SCRIPT_QUEUE_URL = { Ref: 'AdminScriptQueue' };
+        console.log('  ✓ Created AdminScriptQueue');
+    }
+
+    createScriptExecutorFunction(result, usePrismaLayer) {
+        result.functions.adminScriptExecutor = {
+            handler: 'node_modules/@friggframework/admin-scripts/src/infrastructure/script-executor-handler.handler',
+            skipEsbuild: true,
+            ...(usePrismaLayer && { layers: [{ Ref: 'PrismaLambdaLayer' }] }),
+            timeout: 900, // 15 minutes max
+            memorySize: 1024,
+            events: [
+                {
+                    sqs: {
+                        arn: { 'Fn::GetAtt': ['AdminScriptQueue', 'Arn'] },
+                        batchSize: 1,
+                    },
+                },
+            ],
+        };
+        console.log('  ✓ Created adminScriptExecutor function');
+    }
+
+    createAdminScriptRoutes(result, usePrismaLayer) {
+        result.functions.adminScriptRouter = {
+            handler: 'node_modules/@friggframework/admin-scripts/src/infrastructure/admin-script-router.handler',
+            skipEsbuild: true,
+            ...(usePrismaLayer && { layers: [{ Ref: 'PrismaLambdaLayer' }] }),
+            timeout: 30,
+            events: [
+                // List scripts
+                { httpApi: { path: '/admin/scripts', method: 'GET' } },
+                // Get script details
+                { httpApi: { path: '/admin/scripts/{scriptName}', method: 'GET' } },
+                // Execute script (sync or async)
+                { httpApi: { path: '/admin/scripts/{scriptName}/execute', method: 'POST' } },
+                // Get execution status
+                { httpApi: { path: '/admin/executions/{executionId}', method: 'GET' } },
+                // List executions
+                { httpApi: { path: '/admin/executions', method: 'GET' } },
+                // Schedule management (Phase 2)
+                { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'GET' } },
+                { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'PUT' } },
+                { httpApi: { path: '/admin/scripts/{scriptName}/schedule', method: 'DELETE' } },
+            ],
+        };
+        console.log('  ✓ Created adminScriptRouter function');
+    }
+
+    createSchedulerResources(appDefinition, result) {
+        // Create IAM role for EventBridge Scheduler
+        result.resources.AdminScriptSchedulerRole = {
+            Type: 'AWS::IAM::Role',
+            Properties: {
+                RoleName: '${self:service}-${self:provider.stage}-admin-script-scheduler',
+                AssumeRolePolicyDocument: {
+                    Version: '2012-10-17',
+                    Statement: [{
+                        Effect: 'Allow',
+                        Principal: { Service: 'scheduler.amazonaws.com' },
+                        Action: 'sts:AssumeRole',
+                    }],
+                },
+                Policies: [{
+                    PolicyName: 'InvokeLambda',
+                    PolicyDocument: {
+                        Version: '2012-10-17',
+                        Statement: [{
+                            Effect: 'Allow',
+                            Action: 'lambda:InvokeFunction',
+                            Resource: { 'Fn::GetAtt': ['AdminScriptExecutorLambdaFunction', 'Arn'] },
+                        }],
+                    },
+                }],
+            },
+        };
+
+        // Create schedule group
+        result.resources.AdminScriptScheduleGroup = {
+            Type: 'AWS::Scheduler::ScheduleGroup',
+            Properties: {
+                Name: '${self:service}-${self:provider.stage}-admin-scripts',
+            },
+        };
+
+        result.environment.SCHEDULER_ROLE_ARN = { 'Fn::GetAtt': ['AdminScriptSchedulerRole', 'Arn'] };
+        result.environment.SCHEDULE_GROUP_NAME = { Ref: 'AdminScriptScheduleGroup' };
+
+        console.log('  ✓ Created EventBridge Scheduler resources');
+    }
+}
+
+module.exports = { AdminScriptBuilder };