cbs-block 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,55 @@
+# cbs-block SDK 🚀
+
+The official toolkit for building **CodeBlock Studio** extensions. Create, package, and share powerful visual blocks with ease.
+
+## 📦 Installation
+
+Install the CLI globally to use the `cbs-block` command anywhere:
+
+```bash
+npm install cbs-block -g
+```
+
+## 🚀 Quick Start
+
+### 1. Initialize a Project
+Create a new workspace for your block library:
+```bash
+cbs-block init MyAwesomeBlocks
+cd MyAwesomeBlocks
+```
+
+### 2. Create your First Block
+Generate a template for a new block. Choose a category like `Math`, `Logic`, or `Control`:
+```bash
+cbs-block create SimpleAdd Math
+```
+
+### 3. Build & Package
+When you're ready to share, bundle your blocks into a `.cbspak` file:
+```bash
+cbs-block build
+```
+
+## 🛠️ Command Reference
+
+| Command | Description |
+| --- | --- |
+| `init <Name>` | Creates a new block development workspace. |
+| `create <Name> [Category]` | Generates a new `.cbsblock` template. |
+| `list` | Lists all blocks in the current directory. |
+| `lint` | Validates your blocks against the Studio schema. |
+| `build` | Packages your project into a `.cbspak` for the marketplace. |
+| `serve` | Starts a local hot-reload server for real-time testing. |
+| `publish` | Deploys your package to the CBS Marketplace. |
+
+## 🧩 What is a .cbsblock?
+A block is a JSON file that defines its visuals and its logic.
+- **Visuals**: Ports (Input/Output/Flow) and interactive fields.
+- **Logic**: A sandboxed JavaScript function that executes within the Studio.
+
+## 🔒 The CBS Ecosystem
+Note: `.cbspak` and `.cbsblock` files are proprietary formats optimized for **CodeBlock Studio**. They cannot be opened in standard text editors or other IDEs without the CBS engine.
+
+---
+**Build the future of visual coding with CodeBlock Studio.**

package/bin/cbs-block.js

@@ -2,86 +2,126 @@
 
 const fs = require('fs');
 const path = require('path');
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+const { execSync } = require('child_process');
 
-const command = process.argv[2];
-const name = process.argv[3];
+async function main() {
+    const command = process.argv[2];
+    const target = process.argv[3];
 
-const isPack = command === 'pack' || command === 'build';
+    console.log(chalk.cyan.bold(`\n--- CodeBlock Studio SDK v1.1.0 ---\n`));
 
-if (command === 'create' && name) {
-    const category = process.argv[4] || 'Custom';
-    const colors = { 'Math': '#4A90E2', 'Logic': '#F5A623', 'Control': '#FFCC00', 'Custom': '#4CAF50' };
-    const template = {
-        name: name,
-        category: category,
-        color: colors[category] || colors['Custom'],
-        ports: [
-            { name: "input1", type: "Input", dataType: "string" },
-            { name: "output1", type: "Output", dataType: "string" }
-        ],
-        codeTemplates: {
-            python: "print({input1})",
-            web: "console.log({input1})"
-        },
-        logic: "function run(inputs) { return inputs.input1; }"
-    };
+    if (command === 'create') {
+        const answers = await inquirer.prompt([
+            { type: 'input', name: 'name', message: 'Block name:', default: target || 'MyBlock' },
+            { type: 'list', name: 'category', message: 'Category:', choices: ['Math', 'Logic', 'Control', 'Input', 'Output', 'Data', 'Custom'] },
+            { type: 'input', name: 'color', message: 'Hex Color:', default: (a) => {
+                const colors = { 'Math': '#4A90E2', 'Logic': '#F5A623', 'Control': '#FFCC00', 'Custom': '#4CAF50' };
+                return colors[a.category] || '#4CAF50';
+            }},
+            { type: 'confirm', name: 'hasFlow', message: 'Include flow ports?', default: true }
+        ]);
 
-    const fileName = `${name.toLowerCase()}.cbsblock`;
-    fs.writeFileSync(fileName, JSON.stringify(template, null, 2));
-    console.log(`Successfully created block: ${fileName}`);
-} else if (isPack) {
-    const files = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
-    const pack = {
-        package: path.basename(process.cwd()),
-        version: "1.0.0",
-        blocks: files.map(f => JSON.parse(fs.readFileSync(f, 'utf8')))
-    };
-    const packName = `${pack.package}.cbspak`;
-    fs.writeFileSync(packName, JSON.stringify(pack, null, 2));
-    console.log(`Successfully packed ${files.length} blocks into ${packName}.cbspak`);
-} else if (command === 'list') {
-    const files = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
-    console.log(`--- Local CBS Blocks (${files.length}) ---`);
-    files.forEach(f => {
-        const data = JSON.parse(fs.readFileSync(f));
-        console.log(`- ${data.name} [${data.category}] (${data.color})`);
-    });
-} else if (command === 'publish') {
-    const pakFile = fs.readdirSync('.').find(f => f.endsWith('.cbspak'));
-    if (pakFile) {
-        console.log(`Uploading ${pakFile} to CBS Marketplace...`);
-        console.log("Upload Complete! Your extension is now live.");
+        const template = {
+            name: answers.name,
+            category: answers.category,
+            color: answers.color,
+            ports: [
+                ...(answers.hasFlow ? [{ name: "flowIn", type: "FlowIn" }, { name: "flowOut", type: "FlowOut" }] : []),
+                { name: "input1", type: "Input", dataType: "string" },
+                { name: "output1", type: "Output", dataType: "string" }
+            ],
+            codeTemplates: {
+                python: "print({input1})",
+                web: "console.log({input1})",
+                javascript: "console.log({input1})"
+            },
+            logic: "function run(inputs) { return inputs.input1; }"
+        };
+
+        const fileName = `${answers.name.toLowerCase().replace(/\s+/g, '_')}.cbsblock`;
+        fs.writeFileSync(fileName, JSON.stringify(template, null, 2));
+        console.log(chalk.green(`\n✔ Successfully created block: ${chalk.bold(fileName)}`));
+
+    } else if (command === 'init') {
+        const answers = await inquirer.prompt([
+            { type: 'input', name: 'projName', message: 'Project Name:', default: target || 'my-block-pack' },
+            { type: 'input', name: 'description', message: 'Description:', default: 'A new CBS block package' }
+        ]);
+
+        fs.mkdirSync(answers.projName, { recursive: true });
+        const pkgPath = path.join(answers.projName, 'package.json');
+        fs.writeFileSync(pkgPath, JSON.stringify({
+            name: answers.projName,
+            version: "1.0.0",
+            description: answers.description,
+            dependencies: { "cbs-block": "latest" }
+        }, null, 2));
+        fs.mkdirSync(path.join(answers.projName, 'blocks'), { recursive: true });
+        console.log(chalk.green(`\n✔ Project ${chalk.bold(answers.projName)} initialized!`));
+
+    } else if (command === 'pack' || command === 'build') {
+        const files = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
+        const pack = {
+            package: path.basename(process.cwd()),
+            version: "1.0.0",
+            blocks: files.map(f => JSON.parse(fs.readFileSync(f, 'utf8')))
+        };
+        const packName = `${pack.package}.cbspak`;
+        fs.writeFileSync(packName, JSON.stringify(pack, null, 2));
+        console.log(chalk.green(`\n✔ Packed ${files.length} blocks into ${chalk.bold(packName)}`));
+
+    } else if (command === 'doc' && target) {
+        if (!fs.existsSync(target)) return console.error(chalk.red(`Error: File ${target} not found.`));
+        const block = JSON.parse(fs.readFileSync(target, 'utf8'));
+        const doc = `# Block: ${block.name}\n\n**Category**: ${block.category}\n**Color**: \`${block.color}\`\n\n## Ports\n${block.ports.map(p => `- **${p.name}** (${p.type})`).join('\n')}\n\n## Code Templates\n\`\`\`python\n${block.codeTemplates.python}\n\`\`\``;
+        const outName = target.replace('.cbsblock', '.md');
+        fs.writeFileSync(outName, doc);
+        console.log(chalk.green(`\n✔ Generated documentation: ${chalk.bold(outName)}`));
+
+    } else if (command === 'link') {
+        const mainAppPath = path.resolve('../../../codebl/blocks');
+        if (fs.existsSync(mainAppPath)) {
+            const files = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
+            files.forEach(f => {
+                fs.copyFileSync(f, path.join(mainAppPath, f));
+            });
+            console.log(chalk.green(`\n✔ Linked ${files.length} blocks to main app at ${mainAppPath}`));
+        } else {
+            console.error(chalk.red(`Error: Could not find main app blocks directory at ${mainAppPath}`));
+        }
+
+    } else if (command === 'status') {
+        console.log(chalk.yellow(`Current Project: ${path.basename(process.cwd())}`));
+        const blocks = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock')).length;
+        console.log(`Blocks found: ${blocks}`);
+        try {
+            const qtV = execSync('qmake -v').toString().split('\n')[0];
+            console.log(chalk.green(`[PASS] Environment: ${qtV}`));
+        } catch {
+            console.log(chalk.red(`[FAIL] Qt/qmake not found in PATH`));
+        }
+
+    } else if (command === 'lint') {
+        const sdk = require('../index.js');
+        const files = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
+        files.forEach(f => {
+            const data = JSON.parse(fs.readFileSync(f, 'utf8'));
+            const result = sdk.validate(data);
+            if (result.valid) console.log(chalk.green(`${f}: VALID`));
+            else console.error(chalk.red(`${f}: INVALID - ${result.error}`));
+        });
     } else {
-        console.log("No .cbspak found. Run 'cbs-block pack' first.");
+        console.log(chalk.white(`Available commands:`));
+        console.log(`  ${chalk.bold('create [name]')}  - Create a new block interactively`);
+        console.log(`  ${chalk.bold('init [name]')}    - Initialize a new project`);
+        console.log(`  ${chalk.bold('pack')}           - Build a .cbspak package`);
+        console.log(`  ${chalk.bold('doc <file>')}     - Generate markdown documentation`);
+        console.log(`  ${chalk.bold('link')}           - Link blocks to main CodeBlock Studio app`);
+        console.log(`  ${chalk.bold('lint')}           - Validate block definitions`);
+        console.log(`  ${chalk.bold('status')}         - Show SDK & environment status`);
     }
-} else if (command === 'init' && name) {
-    fs.mkdirSync(name);
-    process.chdir(name);
-    fs.writeFileSync('package.json', JSON.stringify({ name, version: "1.0.0", dependencies: { "cbs-block": "latest" } }, null, 2));
-    fs.mkdirSync('blocks');
-    console.log(`Project ${name} initialized!`);
-} else if (command === 'lint') {
-    const sdk = require('../index.js');
-    const files = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
-    files.forEach(f => {
-        const data = JSON.parse(fs.readFileSync(f, 'utf8'));
-        if (sdk.validate(data)) console.log(`${f}: VALID`);
-        else console.error(`${f}: INVALID (Missing required fields)`);
-    });
-} else if (command === 'serve') {
-    const http = require('http');
-    const server = http.createServer((req, res) => {
-        res.writeHead(200, { 'Content-Type': 'application/json' });
-        const blocks = fs.readdirSync('.').filter(f => f.endsWith('.cbsblock'));
-        res.end(JSON.stringify(blocks.map(f => JSON.parse(fs.readFileSync(f, 'utf8')))));
-    });
-    server.listen(8080, () => console.log("Dev server running at http://localhost:8080"));
-} else {
-    console.log("Usage:");
-    console.log("  cbs-block init <ProjectName>");
-    console.log("  cbs-block create <BlockName>");
-    console.log("  cbs-block lint");
-    console.log("  cbs-block pack");
-    console.log("  cbs-block publish");
-    console.log("  cbs-block serve");
 }
+
+main().catch(err => console.error(chalk.red(`Error: ${err.message}`)));

package/index.js

@@ -1,6 +1,21 @@
 module.exports = {
     validate: function(block) {
-        return block.name && block.logic && block.codeTemplates && Array.isArray(block.ports);
+        const hasRequired = block.name && block.logic && block.codeTemplates && Array.isArray(block.ports);
+        if (!hasRequired) return { valid: false, error: "Missing required fields (name, logic, codeTemplates, ports)" };
+        
+        // Color validation
+        if (block.color && !/^#[0-9A-F]{6}$/i.test(block.color)) {
+            return { valid: false, error: "Invalid hex color format" };
+        }
+
+        // Port validation
+        const portNames = new Set();
+        for (const p of block.ports) {
+            if (portNames.has(p.name)) return { valid: false, error: `Duplicate port name: ${p.name}` };
+            portNames.add(p.name);
+        }
+
+        return { valid: true };
     },
-    version: "1.0.0"
+    version: "1.1.0"
 };

package/myblock.md

@@ -0,0 +1,13 @@
+# Block: MyBlock
+
+**Category**: Custom
+**Color**: `undefined`
+
+## Ports
+- **input1** (Input)
+- **output1** (Output)
+
+## Code Templates
+```python
+print({input1})
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cbs-block",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "SDK for creating CodeBlock Studio blocks",
   "main": "index.js",
   "bin": {
@@ -9,7 +9,15 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": ["cbs", "codeblock", "visual-programming"],
+  "keywords": [
+    "cbs",
+    "codeblock",
+    "visual-programming"
+  ],
   "author": "CBS Team",
-  "license": "MIT"
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "inquirer": "^13.3.2"
+  }
 }