@o-lang/bank-account-lookup 1.0.0

package/README.md

@@ -0,0 +1,83 @@
+# @o-lang/bank-account-lookup
+
+[![O-Lang Resolver](https://img.shields.io/badge/O--Lang-Resolver-blue)](https://github.com/olang/olang)
+
+Secure, read-only O-Lang resolver for bank account balance lookups using SQLite.
+
+## 🔒 Security Features
+
+- **Read-only database access** - no mutations possible
+- **Parameterized queries** - SQL injection protected
+- **Sanitized output** - only returns balance (no PII)
+- **Explicit initialization** - no hidden side effects
+
+## 📥 Installation
+
+
+npm install @0-lang/bank-account-lookup
+
+    
+
+# Initialize the database 👈 CRITICAL STEP
+
+npx init-bank-db ./bank.db
+
+This creates a SQLite database with sample customer
+
+Customer 12345: $1,500
+Customer 67890: $250
+
+3. Use in your O-Lang workflow
+
+
+Allow resolvers:
+- bank-account-lookup
+
+Step 1: Action bank-account-lookup "{customer_id}" Save as account_info
+
+---
+
+### 🔑 **Why This Placement Works**
+
+1. **Early visibility** → Users see it in the first 5 seconds
+2. **Numbered steps** → Clear progression (Install → Initialize → Use)
+3. **Highlighted as critical** → Prevents the #1 user mistake (forgetting to initialize)
+4. **Shows output** → Users know what to expect
+
+---
+
+### ⚠️ **What Happens If You Don’t Include It**
+
+Users will:
+1. Install your resolver ✅
+2. Try to run their workflow ❌
+3. Get this confusing error:
+
+Error: bank-account-lookup requires "bank_db_path" in context or BANK_DB_PATH environment variable
+
+4. **Give up** or open a GitHub issue
+
+By including the `npx init-bank-db` command prominently, you **prevent 90% of support requests**.
+
+---
+
+### 💡 **Pro Tips for README**
+
+1. **Use emojis** → 🛠️ `npx init-bank-db ./bank.db`
+2. **Show full workflow**:
+
+# Complete example
+npm install @o-lang/bank-account-lookup
+npx init-bank-db ./bank.db
+npx olang run bank-demo.ol -i customer_id=12345 -i bank_db_path=./bank.db -r @o-lang/bank-account-lookup
+
+
+## ❓ Troubleshooting
+
+**"Command not found: init-bank-db"**  
+→ Make sure you ran `npm install` first
+
+**"Database file not found"**  
+→ Run `npx init-bank-db ./bank.db` to create it
+
+

package/bin/init-bank-db.js

@@ -0,0 +1,107 @@
+#!/usr/bin/env node
+/**
+ * Initialize Bank Database
+ * 
+ * Usage: npx init-bank-db [path/to/database.db]
+ * 
+ * Creates a SQLite database with sample customer balances
+ * for O-Lang bank-account-lookup resolver.
+ */
+
+const Database = require('better-sqlite3');
+const fs = require('fs');
+const path = require('path');
+
+function showUsage() {
+  console.log(`
+Usage: npx init-bank-db [database-path]
+
+Examples:
+  npx init-bank-db ./bank.db          # Create in current directory
+  npx init-bank-db /data/bank.db      # Create in specific path
+
+Creates a SQLite database with sample customer data:
+- Customer 12342: $1,500
+- Customer 67890: $250
+- Customer 11111: $0
+- Customer 99999: $5,000
+  `);
+}
+
+function main() {
+  const args = process.argv.slice(2);
+  
+  // Show help if requested
+  if (args.includes('--help') || args.includes('-h')) {
+    showUsage();
+    process.exit(0);
+  }
+  
+  // Get database path (default to ./bank.db)
+  const dbPath = args[0] || './bank.db';
+  const resolvedPath = path.resolve(dbPath);
+  const dbDir = path.dirname(resolvedPath);
+  
+  console.log(`🔧 Initializing bank database at: ${resolvedPath}`);
+  
+  // Create directory if it doesn't exist
+  if (!fs.existsSync(dbDir)) {
+    console.log(`📁 Creating directory: ${dbDir}`);
+    fs.mkdirSync(dbDir, { recursive: true });
+  }
+  
+  // Initialize database
+  let db;
+  try {
+    db = new Database(resolvedPath);
+    
+    // Create table if not exists
+    db.exec(`
+      CREATE TABLE IF NOT EXISTS customer_balances (
+        id TEXT PRIMARY KEY,
+        balance INTEGER NOT NULL DEFAULT 0,
+        status TEXT NOT NULL DEFAULT 'active',
+        created_at DATETIME DEFAULT CURRENT_TIMESTAMP
+      )
+    `);
+    
+    // Check if table has data
+    const count = db.prepare('SELECT COUNT(*) as cnt FROM customer_balances').get();
+    
+    if (count.cnt === 0) {
+      console.log('📊 Inserting sample customer data...');
+      const insert = db.prepare('INSERT INTO customer_balances (id, balance, status) VALUES (?, ?, ?)');
+      
+      // Insert sample data
+      const sampleData = [
+        ['12345', 1500, 'active'],
+        ['67890', 250, 'active'],
+        ['11111', 0, 'active'],
+        ['99999', 5000, 'active']
+      ];
+      
+      for (const [id, balance, status] of sampleData) {
+        insert.run(id, balance, status);
+      }
+      
+      console.log('✅ Sample data inserted successfully');
+    } else {
+      console.log(`ℹ️  Database already contains ${count.cnt} records - skipping sample data`);
+    }
+    
+    db.close();
+    console.log(`✅ Bank database ready! Use with O-Lang:\n`);
+    console.log(`   npx olang run workflow.ol -i customer_id=12345 -i bank_db_path=${resolvedPath} -r @yourname/bank-account-lookup`);
+    
+  } catch (error) {
+    console.error('❌ Failed to initialize database:', error.message);
+    process.exit(1);
+  }
+}
+
+// Run if called directly
+if (require.main === module) {
+  main();
+}
+
+module.exports = main; // Export for programmatic use

package/index.js

@@ -0,0 +1,54 @@
+// O-Lang Resolver: Secure Bank Account Balance Lookup
+// This resolver ONLY reads data - no mutations allowed
+
+const Database = require('better-sqlite3');
+
+/**
+ * Bank account balance lookup resolver
+ * @param {string} action - O-Lang action string
+ * @param {Object} context - Workflow context containing customer_id and bank_db_path
+ * @returns {Object|undefined} { balance: number } or undefined if not applicable
+ */
+module.exports = async (action, context) => {
+  // Only handle our specific action
+  if (!action.startsWith('Action bank-account-lookup ')) {
+    return undefined;
+  }
+
+  // Require database path (from context or env var)
+  const dbPath = context.bank_db_path || process.env.BANK_DB_PATH;
+  if (!dbPath) {
+    throw new Error('bank-account-lookup requires "bank_db_path" in context or BANK_DB_PATH environment variable');
+  }
+
+  // Validate customer ID
+  const customerId = context.customer_id;
+  if (!customerId || typeof customerId !== 'string') {
+    return { balance: 0 };
+  }
+
+  try {
+    // ✅ Open database in READ-ONLY mode (security critical)
+    const db = new Database(dbPath, { readonly: true });
+    
+    // ✅ Parameterized query (SQL injection safe)
+    const stmt = db.prepare(`
+      SELECT balance 
+      FROM customer_balances 
+      WHERE id = ? AND status = 'active'
+    `);
+    
+    const result = stmt.get(customerId);
+    db.close(); // ✅ Close immediately after query
+    
+    return { balance: result?.balance || 0 };
+    
+  } catch (error) {
+    // ✅ Never expose database errors to LLM/workflow
+    console.error('🏦 [bank-account-lookup] Database error:', error.message);
+    return { balance: 0 };
+  }
+};
+
+// ✅ Required for O-Lang allowlist policy
+module.exports.resolverName = 'bank-account-lookup';

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@o-lang/bank-account-lookup",
+  "version": "1.0.0",
+  "description": "O-Lang resolver for secure bank balance lookups",
+  "main": "index.js",
+  "bin": {
+    "init-bank-db": "./bin/init-bank-db.js"
+  },
+  "type": "commonjs",
+  "keywords": ["olang", "resolver", "bank", "sqlite", "security", "read-only"],
+  "author": "Your Name <your.email@example.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/o-lang/bank-account-lookup.git"
+  },
+  "homepage": "https://github.com/o-lang/bank-account-lookup#readme",
+  "bugs": {
+    "url": "https://github.com/o-lang/bank-account-lookup/issues"
+  },
+  "dependencies": {
+    "better-sqlite3": "^9.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}