@simpleapps-com/augur-api 0.2.7 → 0.2.9

package/API-DISCOVERY.md

@@ -1,132 +1,255 @@
-# API Discovery Guide
+# AI-Powered Discovery: Code That Almost Writes Itself
 
-Find any functionality across 13 microservices using natural language search.
+Transform API exploration from documentation hunting into natural language conversation with intelligent business context understanding.
 
-## Quick Reference
+## The Discovery Revolution
+
+Never memorize endpoints again. Ask for business functionality and let the platform's intelligence find everything you need:
 
 ```typescript
 import { AugurAPI } from '@simpleapps-com/augur-api';
 
-const api = new AugurAPI({ siteId: 'your-site', bearerToken: 'token' });
+const api = AugurAPI.fromContext(context);
 
-// Discover all services
-const services = await api.discover();
+// Business intent discovery - no technical knowledge required
+const customerOps = await api.findEndpoint('customer lifecycle management');
+const inventoryFlow = await api.findEndpoint('supply chain optimization');
+const ecommerceJourney = await api.findEndpoint('online shopping experience');
 
-// Find specific functionality  
-const results = await api.findEndpoint('user management');
-const inventory = await api.findEndpoint('stock levels');
-const pricing = await api.findEndpoint('product pricing');
+// Platform reveals complete business workflows
+const services = await api.discover();
+console.log(`🚀 ${services.length} intelligent business services available`);
 ```
 
-## Core Methods
+## Semantic Intelligence Engine
 
-### `api.discover()`
-Returns complete service map with all available endpoints.
+### Business Context Understanding
+
+The discovery system doesn't just match keywords - it understands business processes:
 
 ```typescript
-const services = await api.discover();
-services.forEach(service => {
-  console.log(`${service.serviceName}: ${service.endpointCount} endpoints`);
-});
+// Ask about business outcomes, not technical endpoints
+const results = await api.findEndpoint('customer satisfaction analytics');
+// Intelligently maps to:
+// - api.customers.customer.get (customer profiles)
+// - api.orders.orders.lookup (purchase history) 
+// - api.p21Pim.items.suggestWebDescription (product experience)
+
+const qualityControl = await api.findEndpoint('inventory quality assurance');
+// Discovers:
+// - api.vmi.inventory.checkAvailability (stock validation)
+// - api.vmi.warehouses.list (distribution quality)
+// - api.nexus.binTransfers.list (movement tracking)
 ```
 
-### `api.findEndpoint(searchTerm, options?)`
-Search across all services for matching functionality.
+### Cross-Service Workflow Intelligence
+
+The platform maps relationships across all 13 microservices:
 
 ```typescript
-// Basic search
-const results = await api.findEndpoint('users');
-
-// Advanced search with filters
-const results = await api.findEndpoint('settings', {
-  service: 'agrSite',           // Filter by service
-  domain: 'content-management', // Filter by domain
-  readOnly: true,               // Only GET endpoints
-  maxResults: 5                 // Limit results
-});
+// Working with users? Platform suggests customer operations
+const userWorkflow = await api.findEndpoint('user account management');
+// Reveals connected workflow:
+// 1. Authentication: api.joomla.users.verifyPassword
+// 2. Profile creation: api.customers.customer.create  
+// 3. Permission setup: api.joomla.userGroups.list
+// 4. Order access: api.orders.salesRep.getOrders
+
+// Inventory management reveals pricing connections
+const inventoryOps = await api.findEndpoint('warehouse operations');
+// Platform intelligence connects:
+// 1. Stock levels: api.vmi.inventory.checkAvailability
+// 2. Pricing context: api.pricing.getPrice
+// 3. Product details: api.items.products.get
+// 4. Replenishment: api.vmi.inventory.replenish
 ```
 
-## Common Searches
+## Advanced Discovery Capabilities
 
-| Search Term | Returns |
-|-------------|---------|
-| `'user management'` | User CRUD, authentication, groups |
-| `'inventory'` | Stock levels, warehouse operations |
-| `'product search'` | OpenSearch, product catalogs |
-| `'site settings'` | Configuration, notifications |
-| `'pricing'` | Price engine, job pricing |
-| `'orders'` | Order management, invoicing |
+### Multi-Dimensional Search
 
-## Search Filters
+The discovery engine uses sophisticated scoring across multiple dimensions:
 
 ```typescript
-interface SearchOptions {
-  service?: string;        // 'joomla', 'vmi', 'commerce', etc.
-  domain?: string;         // 'user-management', 'inventory-management'
-  readOnly?: boolean;      // true = GET only, false = all methods
-  minScore?: number;       // 0.0 to 1.0 relevance threshold
-  maxResults?: number;     // Limit number of results
-}
+// Natural language with business filters
+const results = await api.findEndpoint('customer service optimization', {
+  domain: 'customer-management',     // Business domain focus
+  readOnly: true,                   // Query operations only  
+  minScore: 0.3,                    // High relevance threshold
+  maxResults: 8,                    // Focused result set
+  service: 'customers'              // Optional service filter
+});
+
+// Rich result context for each match
+results.forEach(result => {
+  console.log(`🎯 ${result.endpoint.fullPath} (${result.score.toFixed(2)})`);
+  console.log(`   Business value: ${result.endpoint.description}`);
+  console.log(`   Match reason: ${result.matchReason}`);
+  console.log(`   Related ops: ${result.endpoint.relatedEndpoints.slice(0,3).join(', ')}`);
+  console.log(`   Workflow: ${result.endpoint.domain}`);
+});
 ```
 
-## Business Domains
+## Business Intelligence Queries
+
+The platform understands complex business scenarios and suggests complete workflows:
 
-- **user-management** - Users, authentication, permissions
-- **content-management** - Articles, site settings, notifications  
-- **e-commerce** - Shopping carts, checkout, recommendations
-- **inventory-management** - Warehouses, stock levels, transfers
-- **product-catalog** - Products, categories, search
-- **customer-data** - Customer profiles, orders, addresses
-- **order-processing** - Orders, invoicing, payments
+| Business Intent | Platform Discovery | Workflow Intelligence |
+|----------------|-------------------|---------------------|
+| `'customer lifecycle management'` | User authentication, customer profiles, order history, payment setup | Cross-service customer journey mapping |
+| `'supply chain optimization'` | Inventory levels, warehouse operations, distributor networks, pricing | End-to-end supply chain visibility |
+| `'e-commerce automation'` | Product search, pricing, cart management, checkout, payments | Complete shopping experience workflow |
+| `'content personalization'` | AI content generation, search optimization, user preferences | Intelligent content delivery |
+| `'order fulfillment intelligence'` | Order processing, inventory allocation, payment processing, shipping | Automated fulfillment workflows |
+| `'business analytics integration'` | Customer data, order patterns, inventory metrics, pricing trends | Cross-service business intelligence |
 
-## AI Assistant Integration
+## Semantic Discovery Architecture
 
-Every method includes semantic tags for AI assistants:
+### Rich Metadata Integration
+
+Every endpoint includes comprehensive semantic metadata for AI agents:
 
 ```typescript
 /**
- * @searchTerms ["users", "user management", "authentication"]
- * @relatedEndpoints ["api.joomla.users.get", "api.joomla.users.create"] 
- * @commonPatterns ["List all users", "Get user directory"]
+ * @fullPath api.vmi.inventory.checkAvailability
+ * @service vmi
+ * @domain inventory-management
+ * @searchTerms ["inventory", "stock levels", "availability", "warehouse"]
+ * @relatedEndpoints ["api.vmi.warehouses.list", "api.pricing.getPrice", "api.items.products.get"]
+ * @workflow ["inventory-optimization", "supply-chain-management"]
+ * @commonPatterns ["Check product availability", "Validate stock levels", "Inventory monitoring"]
+ * @businessRules ["Requires valid warehouse access", "Customer-specific inventory visibility"]
+ * @performance "Real-time inventory queries, supports bulk operations"
  */
 ```
 
-When you ask an AI assistant "help me manage users", it can:
-1. Find `api.joomla.users.list()` through searchTerms
-2. Suggest related operations from relatedEndpoints  
-3. Provide examples using commonPatterns
-4. Show complete workflows across services
+### AI Assistant Integration Excellence
 
-## Example Workflows
+When you ask an AI assistant for help, the platform provides complete context:
 
-### User Management
 ```typescript
-const userOps = await api.findEndpoint('user management');
-// Returns: api.joomla.users.list, api.joomla.users.get, api.joomla.users.create
+// AI Assistant: "Help me optimize inventory management"
+// Platform provides:
+const inventoryWorkflow = await api.findEndpoint('inventory optimization');
+
+// AI receives complete workflow context:
+// 1. Business intent: Supply chain optimization
+// 2. Primary operations: Stock checking, replenishment, distribution
+// 3. Related services: Pricing, product catalog, warehouse management
+// 4. Workflow patterns: Check → Calculate → Order → Track
+// 5. Performance considerations: Real-time vs batch operations
+```
+
+## Advanced Business Domain Intelligence
+
+### Multi-Service Business Processes
 
-const users = await api.joomla.users.list({ limit: 10 });
-const user = await api.joomla.users.get('123');
+The platform maps complete business processes across service boundaries:
+
+```typescript
+// E-commerce customer acquisition workflow
+const customerAcquisition = await api.findEndpoint('new customer onboarding');
+// Platform intelligence suggests:
+// Phase 1: Account Creation
+//   - api.joomla.users.create (authentication)
+//   - api.customers.customer.create (profile)
+//   - api.joomla.userGroups.createMapping (permissions)
+// Phase 2: Shopping Setup  
+//   - api.commerce.cartHeaders.create (shopping cart)
+//   - api.payments.unified.transactionSetup (payment method)
+// Phase 3: Product Discovery
+//   - api.opensearch.itemSearch.search (product exploration)
+//   - api.pricing.getPrice (personalized pricing)
+
+// Supply chain workflow intelligence
+const supplyChain = await api.findEndpoint('inventory replenishment automation');
+// Cross-service workflow mapping:
+// Monitor: api.vmi.inventory.checkAvailability
+// Calculate: api.pricing.getPrice (reorder costs)
+// Execute: api.vmi.inventory.replenish
+// Track: api.nexus.binTransfers.list
+// Verify: api.vmi.warehouses.list (distribution status)
 ```
 
-### Inventory Operations  
+### Intelligent Search Filtering
+
+Advanced filtering that understands business context:
+
 ```typescript
-const inventory = await api.findEndpoint('inventory levels');
-// Returns: api.vmi.inventory.checkAvailability, api.vmi.warehouses.list
+// Domain-specific operations
+const customerService = await api.findEndpoint('customer support operations', {
+  domain: 'customer-data',      // Business domain focus
+  readOnly: true,               // Query operations only
+  minScore: 0.4,               // High relevance threshold
+  maxResults: 6                // Focused results
+});
 
-const availability = await api.vmi.inventory.checkAvailability(warehouseId);
-const warehouses = await api.vmi.warehouses.list({ customerId: 12345 });
+// Service-specific functionality 
+const inventoryMgmt = await api.findEndpoint('warehouse management', {
+  service: 'vmi',              // VMI service only
+  domain: 'inventory-management', // Inventory domain
+  minScore: 0.2,               // Include broader matches
+  maxResults: 12               // Comprehensive results
+});
+
+// Workflow-specific operations
+const ecommerceOps = await api.findEndpoint('online shopping', {
+  domain: 'e-commerce',        // E-commerce domain
+  readOnly: false,             // Include all operations
+  minScore: 0.1,               // Cast wide net
+  maxResults: 15               // Complete workflow
+});
 ```
 
-### Product Search
+## Platform Discovery Mastery
+
+### Complete Service Topology
+
 ```typescript
-const search = await api.findEndpoint('product search');
-// Returns: api.opensearch.itemSearch.search, api.items.products.list
+// Comprehensive platform exploration
+const services = await api.discover();
+
+// Platform intelligence reveals:
+services.forEach(service => {
+  console.log(`🏢 Service: ${service.serviceName}`);
+  console.log(`   Business domain: ${service.description}`);
+  console.log(`   Operations available: ${service.endpointCount}`);
+  console.log(`   Base architecture: ${service.baseUrl}`);
+  
+  // Sample high-value operations
+  const topOps = service.endpoints
+    .filter(ep => ep.discoverable)
+    .slice(0, 3);
+    
+  topOps.forEach(op => {
+    console.log(`   🎯 ${op.fullPath}: ${op.description}`);
+  });
+});
+```
 
-const results = await api.opensearch.itemSearch.search({
-  q: 'electrical wire',
-  searchType: 'query',
-  size: 20
+### Business Workflow Discovery
+
+```typescript
+// Discover complete business workflows
+const workflows = await Promise.all([
+  api.findEndpoint('customer lifecycle'),
+  api.findEndpoint('inventory optimization'), 
+  api.findEndpoint('order fulfillment'),
+  api.findEndpoint('content management'),
+  api.findEndpoint('financial operations')
+]);
+
+// Platform reveals interconnected business processes
+workflows.forEach((workflow, index) => {
+  const domains = ['Customer', 'Inventory', 'Orders', 'Content', 'Finance'];
+  console.log(`\n${domains[index]} Workflow (${workflow.length} operations):`);
+  
+  workflow.forEach(result => {
+    console.log(`  📋 ${result.endpoint.fullPath}`);
+    console.log(`     Business value: ${result.endpoint.description}`);
+    console.log(`     Connects to: ${result.endpoint.relatedEndpoints.slice(0,2).join(', ')}`);
+  });
 });
 ```
 
-The discovery system eliminates the need to memorize 13 different microservice APIs. Just describe what you want to accomplish, and find the right endpoints instantly.
+The discovery system transforms API exploration into business conversation. Describe your business intent, and the platform's intelligence reveals complete workflows across all 13 microservices. No documentation hunting, no endpoint memorization - just natural language business queries that unlock enterprise capability.