@friggframework/devtools 2.0.0-next.47 → 2.0.0-next.48

package/frigg-cli/install-command/template.js

@@ -0,0 +1,90 @@
+const path = require('path');
+
+function getIntegrationTemplate(apiModuleName, backendPath, ApiClass) {
+    // Find the sample data method
+    const apiMethods = Object.getOwnPropertyNames(ApiClass.prototype);
+    const sampleDataMethod =
+        apiMethods.find(
+            (method) =>
+                method.toLowerCase().includes('search') ||
+                method.toLowerCase().includes('list') ||
+                method.toLowerCase().includes('get')
+        ) || 'searchDeals';
+
+    return `const { get, IntegrationBase, Options } = require('@friggframework/core');
+const { Definition: ${apiModuleName}Module, Config: defaultConfig } = require('@friggframework/api-module-${apiModuleName.toLowerCase()}');
+
+class ${apiModuleName}Integration extends IntegrationBase {
+    static Config = {
+        name: defaultConfig.name || '${apiModuleName.toLowerCase()}',
+        version: '1.0.0',
+        supportedVersions: ['1.0.0'],
+        events: ['SEARCH_DEALS'],
+    };
+
+    static Options =
+        new Options({
+            module: ${apiModuleName}Module,
+            integrations: [${apiModuleName}Module],
+            display: {
+                name: defaultConfig.displayName || '${apiModuleName}',
+                description: defaultConfig.description || 'Sales & CRM, Marketing',
+                category: defaultConfig.category || 'Sales & CRM, Marketing',
+                detailsUrl: defaultConfig.detailsUrl || 'https://www.${apiModuleName.toLowerCase()}.com',
+                icon: defaultConfig.icon || 'https://friggframework.org/assets/img/${apiModuleName.toLowerCase()}.jpeg',
+            },
+            hasUserConfig: true,
+        });
+
+    static modules = {
+        ${apiModuleName.toLowerCase()}: ${apiModuleName}Module,
+    }
+
+    /**
+     * HANDLE EVENTS
+     */
+    async receiveNotification(notifier, event, object = null) {
+        if (event === 'SEARCH_DEALS') {
+            return this.target.api.searchDeals(object);
+        }
+    }
+
+    /**
+     * ALL CUSTOM/OPTIONAL METHODS FOR AN INTEGRATION MANAGER
+     */
+    async getSampleData() {
+        const res = await this.target.api.${sampleDataMethod}();
+        return { data: res };
+    }
+
+    /**
+     * ALL REQUIRED METHODS FOR AN INTEGRATION MANAGER
+     */
+    async onCreate(params) {
+        // Validate that we have all of the data we need
+        // Set integration status as makes sense. Default ENABLED
+        // TODO turn this into a validateConfig method/function
+        this.record.status = 'ENABLED';
+        await this.record.save();
+        return this.record;
+    }
+
+    async onUpdate(params) {
+        const newConfig = get(params, 'config');
+        const oldConfig = this.record.config;
+        // Just save whatever
+        this.record.markModified('config');
+        await this.record.save();
+        return this.validateConfig();
+    }
+
+    async getConfigOptions() {
+        const options = {}
+        return options;
+    }
+}
+
+module.exports = ${apiModuleName}Integration;`;
+}
+
+module.exports = { getIntegrationTemplate };

package/frigg-cli/install-command/validate-package.js

@@ -0,0 +1,75 @@
+const { execSync } = require('child_process');
+const axios = require('axios');
+const { logError } = require('./logger');
+const { checkbox } = require('@inquirer/prompts');
+
+async function searchPackages(apiModuleName) {
+    const searchCommand = `npm search @friggframework/api-module-${apiModuleName} --json`;
+    const result = execSync(searchCommand, { encoding: 'utf8' });
+    return JSON.parse(result);
+}
+
+async function checkPackageExists(packageName) {
+    try {
+        const response = await axios.get(
+            `https://registry.npmjs.org/${packageName}`
+        );
+        return response.status === 200;
+    } catch (error) {
+        return false;
+    }
+}
+
+async function validatePackageExists(packageName) {
+    const packageExists = await checkPackageExists(packageName);
+    if (!packageExists) {
+        throw new Error(`Package ${packageName} does not exist on npm.`);
+    }
+}
+
+const searchAndSelectPackage = async (apiModuleName) => {
+    const searchResults = await searchPackages(apiModuleName || '');
+
+    if (searchResults.length === 0) {
+        logError(`No packages found matching ${apiModuleName}`);
+        process.exit(1);
+    }
+
+    const filteredResults = searchResults.filter((pkg) => {
+        const version = pkg.version ? pkg.version.split('.').map(Number) : [];
+        return version[0] >= 1;
+    });
+
+    if (filteredResults.length === 0) {
+        const earlierVersions = searchResults
+            .map((pkg) => `${pkg.name} (${pkg.version})`)
+            .join(', ');
+        logError(
+            `No packages found with version 1.0.0 or above for ${apiModuleName}. Found earlier versions: ${earlierVersions}`
+        );
+        process.exit(1);
+    }
+
+    const choices = filteredResults.map((pkg) => {
+        return {
+            name: `${pkg.name} (${pkg.version})`,
+            value: pkg.name,
+            checked: filteredResults.length === 1, // Automatically select if only one result
+        };
+    });
+
+    const selectedPackages = await checkbox({
+        message: 'Select the packages to install:',
+        choices,
+    });
+    console.log('Selected packages:', selectedPackages);
+
+    return selectedPackages.map((choice) => choice.split(' ')[0]);
+};
+
+module.exports = {
+    validatePackageExists,
+    checkPackageExists,
+    searchPackages,
+    searchAndSelectPackage,
+};

package/frigg-cli/jest.config.js

@@ -0,0 +1,124 @@
+module.exports = {
+  displayName: 'Frigg CLI Tests',
+  testMatch: [
+    '<rootDir>/__tests__/**/*.test.js',
+    '<rootDir>/__tests__/**/*.spec.js',
+    '<rootDir>/**/start-command.test.js',
+    '<rootDir>/**/__tests__/**/*.test.js'
+  ],
+  // Exclude utility files and config from being treated as tests
+  testPathIgnorePatterns: [
+    '/node_modules/',
+    '/__tests__/utils/',
+    '/__tests__/jest.config.js',
+    '/test-setup.js'
+  ],
+  testEnvironment: 'node',
+  collectCoverageFrom: [
+    '**/*.js',
+    '!**/*.test.js',
+    '!**/*.spec.js',
+    '!**/node_modules/**',
+    '!**/__tests__/**',
+    '!**/coverage/**'
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: [
+    'text',
+    'text-summary',
+    'html',
+    'lcov',
+    'json'
+  ],
+  coverageThreshold: {
+    global: {
+      branches: 85,
+      functions: 85,
+      lines: 85,
+      statements: 85
+    },
+    './install-command/index.js': {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    },
+    './build-command/index.js': {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    },
+    './deploy-command/index.js': {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    },
+    './ui-command/index.js': {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    },
+    './generate-command/index.js': {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    },
+    './db-setup-command/index.js': {
+      branches: 90,
+      functions: 90,
+      lines: 90,
+      statements: 90
+    },
+    './utils/database-validator.js': {
+      branches: 85,
+      functions: 85,
+      lines: 85,
+      statements: 85
+    },
+    './utils/prisma-runner.js': {
+      branches: 85,
+      functions: 85,
+      lines: 85,
+      statements: 85
+    },
+    './utils/error-messages.js': {
+      branches: 85,
+      functions: 85,
+      lines: 85,
+      statements: 85
+    }
+  },
+  setupFilesAfterEnv: [
+    '<rootDir>/__tests__/utils/test-setup.js'
+  ],
+  testTimeout: 10000,
+  maxWorkers: '50%',
+  verbose: true,
+  collectCoverage: true,
+  coveragePathIgnorePatterns: [
+    '/node_modules/',
+    '/__tests__/',
+    '/coverage/',
+    '.test.js',
+    '.spec.js'
+  ],
+  moduleFileExtensions: [
+    'js',
+    'json',
+    'node'
+  ],
+  transform: {},
+  // testResultsProcessor: 'jest-sonar-reporter', // Optional dependency
+  reporters: [
+    'default'
+    // jest-junit reporter removed - optional dependency
+  ],
+  watchman: false,
+  forceExit: true,
+  detectOpenHandles: true,
+  errorOnDeprecated: true
+};

package/frigg-cli/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@friggframework/frigg-cli",
+  "version": "2.0.0-next.0",
+  "description": "Frigg Framework CLI tool",
+  "main": "index.js",
+  "bin": {
+    "frigg": "./index.js"
+  },
+  "scripts": {
+    "test": "jest"
+  },
+  "dependencies": {
+    "@aws-sdk/client-cloudformation": "^3.705.0",
+    "@babel/parser": "^7.25.3",
+    "@babel/traverse": "^7.25.3",
+    "@friggframework/core": "^2.0.0-next.0",
+    "@friggframework/schemas": "^2.0.0-next.0",
+    "@inquirer/prompts": "^5.3.8",
+    "axios": "^1.7.2",
+    "chalk": "^4.1.2",
+    "commander": "^12.1.0",
+    "cross-spawn": "^7.0.3",
+    "dotenv": "^16.4.5",
+    "fs-extra": "^11.2.0",
+    "js-yaml": "^4.1.0",
+    "lodash": "4.17.21",
+    "node-cache": "^5.1.2",
+    "open": "^8.4.2",
+    "osls": "^3.40.1",
+    "semver": "^7.6.0",
+    "validate-npm-package-name": "^5.0.0"
+  },
+  "peerDependencies": {
+    "@friggframework/devtools": "*"
+  },
+  "devDependencies": {
+    "@friggframework/devtools": "^2.0.0-next.0",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.5"
+  },
+  "keywords": [
+    "frigg",
+    "cli",
+    "integration",
+    "framework"
+  ],
+  "author": "Frigg Framework Team",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/friggframework/frigg.git"
+  },
+  "bugs": {
+    "url": "https://github.com/friggframework/frigg/issues"
+  },
+  "homepage": "https://github.com/friggframework/frigg#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}