@burgan-tech/vnext-workflow-cli 1.0.0

package/.github/workflows/check-sonar.yml

@@ -0,0 +1,69 @@
+name: SonarQube Analysis
+
+on:
+  push:
+    branches:
+      - main
+      - develop
+      - 'release-v*'
+  pull_request:
+    branches:
+      - main
+      - develop
+      - 'release-v*'
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  sonar:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+    
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20.x'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: |
+        echo "Installing dependencies..."
+        if [ -f "package-lock.json" ]; then
+          npm ci
+        else
+          npm install
+        fi
+        echo "Dependencies installed successfully"
+    
+    - name: Run tests with coverage
+      run: |
+        echo "Running tests..."
+        if npm run test:coverage --silent > /dev/null 2>&1; then
+          npm run test:coverage
+        elif npm run test --silent > /dev/null 2>&1; then
+          npm test
+        else
+          echo "No test script found, skipping tests..."
+        fi
+    
+    - name: SonarQube Scan
+      uses: sonarsource/sonarqube-scan-action@master
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}
+    
+    - name: SonarQube Quality Gate check
+      uses: sonarsource/sonarqube-quality-gate-action@master
+      timeout-minutes: 5
+      env:
+        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      # Force to fail step after specific time
+      continue-on-error: false
+

package/README.md

@@ -0,0 +1,382 @@
+# 🚀 vNext Workflow CLI
+
+Cross-platform modern workflow management tool.
+
+[![npm version](https://img.shields.io/npm/v/@burgan-tech/vnext-workflow-cli.svg)](https://www.npmjs.com/package/@burgan-tech/vnext-workflow-cli)
+[![npm downloads](https://img.shields.io/npm/dm/@burgan-tech/vnext-workflow-cli.svg)](https://www.npmjs.com/package/@burgan-tech/vnext-workflow-cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A command-line interface (CLI) tool for managing vNext workflows, tasks, schemas, views, functions, and extensions. This tool helps you synchronize your local workflow definitions with the vNext API and database.
+
+**Package**: `@burgan-tech/vnext-workflow-cli`  
+**NPM**: https://www.npmjs.com/package/@burgan-tech/vnext-workflow-cli  
+**GitHub**: https://github.com/burgan-tech/vnext-workflow-cli
+
+## 📦 Installation
+
+### Install from NPM (Recommended)
+
+```bash
+# Install globally
+npm install -g @burgan-tech/vnext-workflow-cli
+
+# Or install as a project dependency
+npm install @burgan-tech/vnext-workflow-cli
+```
+
+After installation, you can use the CLI with:
+```bash
+wf --version
+wf check
+```
+
+### Install from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/burgan-tech/vnext-workflow-cli.git
+cd vnext-workflow-cli
+
+# Install dependencies
+npm install
+
+# Link globally (for development)
+npm link
+```
+
+### Requirements
+
+- Node.js >= 14.0.0
+- npm or yarn
+- PostgreSQL (for database operations)
+- Docker (optional, for PostgreSQL container)
+
+---
+
+## ⚡ Quick Start
+
+### Initial Configuration
+
+After installation, configure the CLI:
+
+```bash
+# Set project root path (REQUIRED)
+wf config set PROJECT_ROOT /path/to/your/vnext-project
+
+# Database settings
+wf config set DB_PASSWORD postgres
+wf config set USE_DOCKER true
+wf config set DOCKER_POSTGRES_CONTAINER vnext-postgres
+
+# Verify configuration
+wf check
+```
+
+### Basic Usage
+
+```bash
+# System status check
+wf check
+
+# Update CSX + JSON files (automatically finds changed files)
+wf update
+
+# Add missing workflows to database
+wf sync
+
+# Reset workflows (delete from DB and re-add)
+wf reset
+```
+
+---
+
+## 📖 Commands
+
+### `wf check`
+Checks system status (API, DB, folders).
+
+### `wf config <action> [key] [value]`
+Configuration management:
+```bash
+wf config get              # Show all settings
+wf config get PROJECT_ROOT # Show a specific setting
+wf config set DB_PASSWORD pass # Change a setting
+```
+
+### `wf csx [options]`
+Converts CSX files to Base64 and embeds them in JSON files.
+```bash
+wf csx              # Process changed files in Git
+wf csx --all        # Process all CSX files
+wf csx --file x.csx # Process a single file
+```
+
+### `wf update [options]`
+Updates workflows (CSX is automatically updated!).
+```bash
+wf update                # Process changed files in Git (CSX + JSON)
+wf update --all          # Update all (asks for confirmation)
+wf update --file x.json  # Process a single file
+```
+
+**Process steps:**
+1. 📝 Converts changed CSX files to base64 and writes to JSON files
+2. 🗑️ Deletes existing record from DB
+3. 📤 POSTs to API
+4. ✅ Activates the workflow
+5. 🔄 Restarts the system
+
+### `wf sync`
+Updates all CSX files and adds missing ones to the database.
+```bash
+wf sync  # Update all CSX files + add missing ones
+```
+
+### `wf reset`
+Resets workflows with an interactive menu (even if there are no changes).
+```bash
+wf reset  # Select folder from menu
+```
+
+**Menu:**
+```
+? Which folder should be reset?
+❯ 🔵 Workflows (sys-flows)
+  📋 Tasks (sys-tasks)
+  📊 Schemas (sys-schemas)
+  👁️  Views (sys-views)
+  ⚙️  Functions (sys-functions)
+  🔌 Extensions (sys-extensions)
+  ──────────────
+  🔴 ALL (All folders)
+```
+
+---
+
+## 💡 Usage Scenarios
+
+### 1. Changing and Updating CSX File
+```bash
+# Edit CSX file
+vim AddToCartMapping.csx
+
+# Update in one command (CSX + JSON automatic)
+wf update
+```
+
+### 2. Updating Only CSX (Without Writing to DB)
+```bash
+# Convert CSX files to base64 and write to JSON files
+wf csx
+```
+
+### 3. Initial Setup / Full Sync
+```bash
+# Update all CSX files + add missing ones
+wf sync
+```
+
+### 4. Resetting Workflows (Delete from DB and Re-add)
+```bash
+# With interactive menu (RECOMMENDED)
+wf reset
+
+# Reset all
+wf update --all
+
+# Single file
+wf update --file /path/to/file.json
+```
+
+---
+
+## ⚙️ Configuration
+
+Config file location: `~/.config/vnext-workflow-cli/config.json`
+
+### Important Settings
+```bash
+# Project root path (REQUIRED)
+wf config set PROJECT_ROOT /path/to/project
+
+# API settings
+wf config set API_BASE_URL http://localhost:4201
+wf config set API_VERSION v1
+
+# Database settings
+wf config set DB_HOST localhost
+wf config set DB_PORT 5432
+wf config set DB_NAME vNext_WorkflowDb
+wf config set DB_USER postgres
+wf config set DB_PASSWORD your_password
+
+# Docker settings
+wf config set USE_DOCKER true
+wf config set DOCKER_POSTGRES_CONTAINER vnext-postgres
+
+# Auto discovery
+wf config set AUTO_DISCOVER true
+```
+
+---
+
+## 🆘 Troubleshooting
+
+### "Files not found" (When using on another PC)
+```bash
+# Check current config
+wf config get PROJECT_ROOT
+
+# Set new PC's path
+wf config set PROJECT_ROOT /Users/NewUser/path/to/project
+
+# Verify
+wf check
+```
+
+### "Cannot connect to API"
+```bash
+# Check API
+curl http://localhost:4201/api/v1/health
+
+# Check config
+wf config get API_BASE_URL
+```
+
+### "Database connection failed"
+```bash
+# Check Docker container
+docker ps | grep postgres
+
+# Start container
+docker start vnext-postgres
+
+# Check config
+wf config get USE_DOCKER
+wf config get DOCKER_POSTGRES_CONTAINER
+```
+
+### "npm link not working"
+```bash
+# Use alias
+echo 'alias wf="node $(pwd)/bin/workflow.js"' >> ~/.bashrc
+source ~/.bashrc
+```
+
+---
+
+## 🚀 Creating a New Version
+
+The project uses automated versioning and publishing via GitHub Actions. Follow these steps to create and publish a new version:
+
+### Method 1: Using Release Branches (Recommended)
+
+1. **Create a release branch** following the pattern `release-vX.Y`:
+   ```bash
+   git checkout -b release-v1.0
+   git push origin release-v1.0
+   ```
+
+2. **Push to the release branch** - The workflow will automatically:
+   - Calculate the next patch version (e.g., `1.0.0`, `1.0.1`, `1.0.2`)
+   - Build and validate the package
+   - Publish to NPM and/or GitHub Packages
+   - Create a Git tag (e.g., `v1.0.0`)
+   - Create a GitHub release
+
+### Method 2: Manual Workflow Dispatch
+
+1. **Go to GitHub Actions** in your repository
+2. **Select "Build and Publish to NPM"** workflow
+3. **Click "Run workflow"**
+4. **Configure options**:
+   - **Version Override**: Optional. Leave empty for auto-calculation (e.g., `1.0.6`)
+   - **Force Publish**: Set to `true` if you want to republish an existing version
+   - **Target Registry**: Choose `npmjs`, `github`, or `both`
+5. **Click "Run workflow"**
+
+### Version Calculation
+
+The workflow automatically calculates versions:
+
+- **From branch name**: If branch is `release-v1.0`, it will find the next available patch version (e.g., `1.0.0`, `1.0.1`, `1.0.2`)
+- **From package.json**: If branch doesn't match the pattern, it increments the patch version from `package.json`
+
+### After Publishing
+
+Once published, the new version will be:
+- ✅ Available on NPM: `npm install -g @burgan-tech/vnext-workflow-cli@1.0.0`
+- ✅ Tagged in Git: `v1.0.0`
+- ✅ Released on GitHub with release notes
+
+### Workflow Requirements
+
+The workflow requires these secrets to be configured in GitHub repository settings:
+
+- **NPM_TOKEN** (optional): For publishing to NPM. If not set, only GitHub Packages will be used.
+- **SONAR_TOKEN** (optional): For code quality analysis
+- **SONAR_HOST_URL** (optional): SonarQube server URL
+
+### Workflow Steps
+
+The build and publish workflow performs these steps:
+
+1. ✅ **Checkout code** with full Git history
+2. ✅ **Calculate version** from branch or package.json
+3. ✅ **Validate syntax** - Checks all JavaScript files
+4. ✅ **Run linting** (if available)
+5. ✅ **Run tests** (if available)
+6. ✅ **Build package** (if build script exists)
+7. ✅ **Publish to registry** (NPM and/or GitHub Packages)
+8. ✅ **Create Git tag** (e.g., `v1.0.0`)
+9. ✅ **Create GitHub release** with release notes
+
+---
+
+## 📋 Development
+
+### Project Structure
+
+```
+vnext-workflow-cli/
+├── bin/
+│   └── workflow.js          # CLI entry point
+├── src/
+│   ├── commands/            # Command implementations
+│   │   ├── check.js
+│   │   ├── config.js
+│   │   ├── csx.js
+│   │   ├── reset.js
+│   │   ├── sync.js
+│   │   └── update.js
+│   └── lib/                 # Library modules
+│       ├── api.js
+│       ├── config.js
+│       ├── csx.js
+│       ├── db.js
+│       ├── discover.js
+│       └── workflow.js
+├── .github/
+│   └── workflows/           # GitHub Actions workflows
+│       ├── build-and-publish.yml
+│       └── check-sonar.yml
+├── package.json
+└── README.md
+```
+
+### Local Development
+
+```bash
+# Clone and install
+git clone https://github.com/burgan-tech/vnext-workflow-cli.git
+cd vnext-workflow-cli
+npm install
+npm link
+
+# Test the CLI
+wf --version
+wf check
+
+# Run development
+npm run dev
+```

package/bin/workflow.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const chalk = require('chalk');
+const pkg = require('../package.json');
+
+// Commands
+const checkCommand = require('../src/commands/check');
+const csxCommand = require('../src/commands/csx');
+const updateCommand = require('../src/commands/update');
+const syncCommand = require('../src/commands/sync');
+const resetCommand = require('../src/commands/reset');
+const configCommand = require('../src/commands/config');
+
+program
+  .name('workflow')
+  .description('vNext Workflow Manager CLI')
+  .version(pkg.version);
+
+// Check command
+program
+  .command('check')
+  .description('Sistem kontrolü (API, DB, klasörler)')
+  .action(checkCommand);
+
+// CSX command
+program
+  .command('csx')
+  .description('CSX dosyalarını güncelle')
+  .option('-a, --all', 'Tüm CSX dosyalarını güncelle')
+  .option('-f, --file <path>', 'Belirli bir CSX dosyasını güncelle')
+  .action(csxCommand);
+
+// Update command
+program
+  .command('update')
+  .description('Workflow\'ları güncelle')
+  .option('-a, --all', 'Tüm workflow\'ları güncelle')
+  .option('-f, --file <path>', 'Belirli bir workflow\'u güncelle')
+  .action(updateCommand);
+
+// Sync command
+program
+  .command('sync')
+  .description('DB\'de eksik olanları ekle')
+  .action(syncCommand);
+
+// Reset command
+program
+  .command('reset')
+  .description('Workflow\'ları resetle (force update)')
+  .action(resetCommand);
+
+// Config command
+program
+  .command('config')
+  .description('Konfigürasyon yönetimi')
+  .argument('<action>', 'set veya get')
+  .argument('[key]', 'Config key')
+  .argument('[value]', 'Config value')
+  .action(configCommand);
+
+// Parse arguments
+program.parse(process.argv);
+
+// No command provided
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+}
+

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@burgan-tech/vnext-workflow-cli",
+  "version": "1.0.0",
+  "description": "vNext Workflow Manager - CLI tool for managing workflows, tasks, schemas and more",
+  "main": "dist/index.js",
+  "bin": {
+    "workflow": "./bin/workflow.js",
+    "wf": "./bin/workflow.js"
+  },
+  "scripts": {
+    "dev": "node bin/workflow.js",
+    "build": "echo 'Build not needed for now'",
+    "start": "node bin/workflow.js"
+  },
+  "keywords": [
+    "workflow",
+    "vnext",
+    "cli",
+    "automation"
+  ],
+  "author": "Burgan Tech",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/burgan-tech/vnext-workflow-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/burgan-tech/vnext-workflow-cli/issues"
+  },
+  "homepage": "https://github.com/burgan-tech/vnext-workflow-cli#readme",
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "commander": "^11.1.0",
+    "chalk": "^4.1.2",
+    "axios": "^1.6.2",
+    "pg": "^8.11.3",
+    "glob": "^10.3.10",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1",
+    "conf": "^10.2.0"
+  }
+}

package/src/commands/check.js

@@ -0,0 +1,74 @@
+const chalk = require('chalk');
+const ora = require('ora');
+const config = require('../lib/config');
+const { discoverComponents, listDiscovered } = require('../lib/discover');
+const { testApiConnection } = require('../lib/api');
+const { testDbConnection } = require('../lib/db');
+
+async function checkCommand() {
+  console.log(chalk.cyan.bold('\n🔄 Workflow Yönetim Sistemi - Sistem Kontrolü\n'));
+  
+  const projectRoot = config.get('PROJECT_ROOT');
+  const autoDiscover = config.get('AUTO_DISCOVER');
+  
+  // API kontrolü
+  let apiSpinner = ora('API kontrolü...').start();
+  try {
+    const apiUrl = config.get('API_BASE_URL');
+    const isApiOk = await testApiConnection(apiUrl);
+    if (isApiOk) {
+      apiSpinner.succeed(chalk.green('API: ✓ Erişilebilir'));
+    } else {
+      apiSpinner.fail(chalk.red('API: ✗ Erişilemiyor'));
+    }
+  } catch (error) {
+    apiSpinner.fail(chalk.red(`API: ✗ Hata - ${error.message}`));
+  }
+  
+  // DB kontrolü
+  let dbSpinner = ora('Veritabanı kontrolü...').start();
+  try {
+    const isDbOk = await testDbConnection({
+      host: config.get('DB_HOST'),
+      port: config.get('DB_PORT'),
+      database: config.get('DB_NAME'),
+      user: config.get('DB_USER'),
+      password: config.get('DB_PASSWORD'),
+      useDocker: config.get('USE_DOCKER'),
+      dockerContainer: config.get('DOCKER_POSTGRES_CONTAINER')
+    });
+    if (isDbOk) {
+      dbSpinner.succeed(chalk.green('DB: ✓ Bağlı'));
+    } else {
+      dbSpinner.fail(chalk.red('DB: ✗ Bağlanamıyor'));
+    }
+  } catch (error) {
+    dbSpinner.fail(chalk.red(`DB: ✗ Hata - ${error.message}`));
+  }
+  
+  // Klasör tarama
+  if (autoDiscover) {
+    console.log(chalk.cyan('\n📁 Bulunan Klasörler:\n'));
+    let discoverSpinner = ora('Klasörler taranıyor...').start();
+    try {
+      const discovered = await discoverComponents(projectRoot);
+      discoverSpinner.stop();
+      
+      const list = listDiscovered(discovered);
+      for (const item of list) {
+        if (item.found) {
+          console.log(chalk.green(`  ✓ ${item.name}`));
+        } else {
+          console.log(chalk.yellow(`  ○ ${item.name} ${chalk.dim('(bulunamadı)')}`));
+        }
+      }
+    } catch (error) {
+      discoverSpinner.fail(chalk.red(`Klasör tarama hatası: ${error.message}`));
+    }
+  }
+  
+  console.log(chalk.green.bold('\n✓ Kontrol tamamlandı\n'));
+}
+
+module.exports = checkCommand;
+

package/src/commands/config.js

@@ -0,0 +1,31 @@
+const chalk = require('chalk');
+const config = require('../lib/config');
+
+async function configCommand(action, key, value) {
+  if (action === 'get') {
+    if (key) {
+      const val = config.get(key);
+      console.log(chalk.cyan(`${key}:`), val);
+    } else {
+      // Tüm config'i göster
+      console.log(chalk.cyan.bold('\n📝 Mevcut Konfigürasyon:\n'));
+      const all = config.getAll();
+      for (const [k, v] of Object.entries(all)) {
+        console.log(chalk.cyan(`${k}:`), chalk.white(v));
+      }
+      console.log(chalk.dim(`\nKonfig dosyası: ${config.path}\n`));
+    }
+  } else if (action === 'set') {
+    if (!key || value === undefined) {
+      console.log(chalk.red('Kullanım: workflow config set <key> <value>'));
+      return;
+    }
+    config.set(key, value);
+    console.log(chalk.green(`✓ ${key} = ${value}`));
+  } else {
+    console.log(chalk.red('Geçersiz action. Kullanın: get veya set'));
+  }
+}
+
+module.exports = configCommand;
+