@simpleapps-com/augur-api 0.3.3 → 0.4.1

package/API-SERVICES.md

@@ -1,6 +1,8 @@
 # API Services Reference
 
-Complete reference for all 26 available API services in the Augur Platform. Each service provides specialized business functionality with consistent authentication, validation, and discovery patterns.
+Complete reference for all 20+ available API services in the Augur Platform. Each service provides specialized business functionality with consistent authentication, validation, and discovery patterns.
+
+> **🚀 NEW in v0.4.0**: All services now implement OpenAPI Path Mirroring Pattern with dual API access (standard + data methods), comprehensive schema organization, and enhanced AI-powered discovery.
 
 ## Core Business Services
 
@@ -87,7 +89,7 @@ Complete reference for all 26 available API services in the Augur Platform. Each
 
 | Service | Description | OpenAPI Spec | Postman Collection |
 |---------|-------------|--------------|-------------------|
-| **gregorovich** | Gregorovich system integration for specialized third-party business process connectivity | [OpenAPI](https://gregorovich.augur-api.com/openapi.json) | [Postman](https://gregorovich.augur-api.com/postman.json) |
+| **gregorovich** | AI-powered document management and conversational AI with ChatGPT and Ollama integration | [OpenAPI](https://gregorovich.augur-api.com/openapi.json) | [Postman](https://gregorovich.augur-api.com/postman.json) |
 
 ### Logistics & Shipping
 
@@ -129,6 +131,46 @@ Complete reference for all 26 available API services in the Augur Platform. Each
 |---------|-------------|--------------|-------------------|
 | **p21Sism** | Prophet 21 System Integration and Synchronization Management for data consistency and workflow automation | [OpenAPI](https://p21-sism.augur-api.com/openapi.json) | [Postman](https://p21-sism.augur-api.com/postman.json) |
 
+## v0.4.0 OpenAPI Path Mirroring Examples
+
+### Path-to-Client Structure Mapping
+**Every OpenAPI path maps directly to client structure:**
+
+```typescript
+// AI and Document Services (Gregorovich)
+await api.gregorovich.chatGpt.ask.get({ question: "How do I optimize inventory?" });
+await api.gregorovich.documents.list();
+await api.gregorovich.ollama.generate.create({ prompt: "Generate description" });
+
+// Advanced Search (OpenSearch)
+await api.openSearch.ping.get();
+await api.openSearch.healthCheck.get();
+await api.openSearch.itemSearch.list({ query: "tools" });
+await api.openSearch.itemSearch.attributes.list({ category: "power" });
+await api.openSearch.items.refresh.update({ force: true });
+await api.openSearch.items.get(invMastUid);
+
+// Vendor Managed Inventory (VMI)
+await api.vmi.warehouses.list({ customerId: 123 });
+await api.vmi.invProfileHdr.list({ warehouseId: 456 });
+await api.vmi.distributors.list({ active: true });
+```
+
+### Dual API Pattern (All Services)
+**Standard + Data methods for every endpoint:**
+
+```typescript
+// Standard method - complete BaseResponse
+const response = await api.gregorovich.chatGpt.ask.get({ question: "What is AI?" });
+console.log(response.data.answer);     // AI response
+console.log(response.status);          // HTTP 200
+console.log(response.message);         // Success message
+
+// Data method - direct access to data
+const aiData = await api.gregorovich.chatGpt.ask.getData({ question: "What is AI?" });
+console.log(aiData.answer);           // Direct access to answer
+```
+
 ## Quick Usage Reference
 
 ### Getting Started

package/README.md

@@ -2,6 +2,8 @@
 
 Transform enterprise API chaos into developer flow with intelligent client generation, context-aware discovery, and AI-powered development acceleration.
 
+> **🚀 NEW in v0.4.0**: Revolutionary OpenAPI Path Mirroring Pattern with comprehensive schema organization, dual API patterns, and enhanced AI-powered discovery across 20+ microservices.
+
 ## Experience the Magic in 30 Seconds
 
 ```typescript
@@ -18,15 +20,21 @@ const userOps = await api.findEndpoint('user management');
 const inventory = await api.findEndpoint('stock levels'); 
 const pricing = await api.findEndpoint('product pricing');
 
-// Code that understands your business domain
+// Code that understands your business domain (v0.4.0 Path Mirroring)
 const users = await api.joomla.users.list({ limit: 10, edgeCache: 2 });
 const availability = await api.vmi.invProfileHdr.checkAvailability(warehouse);
-const price = await api.pricing.getPrice({ customerId, itemId, quantity });
+const price = await api.pricing.priceEngine.calculate({ customerId, itemId, quantity });
+
+// NEW: OpenAPI path mirroring - exact path-to-client structure mapping
+const aiAnswer = await api.gregorovich.chatGpt.ask.get({ question: "What is AI?" });
+const searchResults = await api.openSearch.itemSearch.list({ query: "widgets" });
+const attributes = await api.openSearch.itemSearch.attributes.list({ category: "tools" });
 ```
 
 ## Table of Contents
 
 - [🚀 Quick Start Guide](./QUICKSTART.md) - **Experience the magic in under 5 minutes**
+- [🆕 OpenAPI Path Mirroring (v0.4.0)](#-openapi-path-mirroring-v040) - **Revolutionary client structure mapping**
 - [The Five Ideals in Action](#the-five-ideals-in-action)
 - [🎯 AI-Powered Discovery System](#-ai-powered-discovery-system)
 - [📖 API Discovery Guide](./API-DISCOVERY.md) - Natural language API navigation
@@ -42,6 +50,79 @@ const price = await api.pricing.getPrice({ customerId, itemId, quantity });
 - [Performance & Caching](#performance--caching)
 - [Troubleshooting & Support](#troubleshooting--support)
 
+## 🆕 OpenAPI Path Mirroring (v0.4.0)
+
+**Revolutionary client architecture**: Every OpenAPI path segment maps directly to client structure, making API navigation intuitive and predictable.
+
+### Path-to-Client Structure Magic ✨
+
+```typescript
+// OpenAPI Path → Client Structure (Exact Mapping)
+// /chat-gpt/ask → client.chatGpt.ask.get()
+// /documents → client.documents.list()
+// /item-search → client.itemSearch.list()
+// /item-search/attributes → client.itemSearch.attributes.list()
+// /items/{invMastUid}/refresh → client.items.refresh.get(invMastUid)
+
+const api = AugurAPI.fromContext(context);
+
+// AI and Document Management (Gregorovich Service)
+const aiResponse = await api.gregorovich.chatGpt.ask.get({ 
+  question: "How do I optimize inventory?" 
+});
+const documents = await api.gregorovich.documents.list();
+const ollamaResult = await api.gregorovich.ollama.generate.create({
+  prompt: "Generate product description"
+});
+
+// Advanced Search (OpenSearch Service)  
+const ping = await api.openSearch.ping.get();
+const health = await api.openSearch.healthCheck.get();
+const searchResults = await api.openSearch.itemSearch.list({ query: "tools" });
+const searchAttrs = await api.openSearch.itemSearch.attributes.list({ query: "power" });
+const refreshStatus = await api.openSearch.items.refresh.update({ force: true });
+
+// Specific item operations with path parameters
+const item = await api.openSearch.items.get(invMastUid);
+const itemRefresh = await api.openSearch.items.refresh.get(invMastUid);
+```
+
+### Dual API Pattern (Standard + Data Methods) 
+
+**Every endpoint provides two access patterns** for maximum flexibility:
+
+```typescript
+// Standard method - complete BaseResponse with metadata
+const response = await api.gregorovich.chatGpt.ask.get({ question: "What is AI?" });
+console.log(response.data.answer);    // AI answer
+console.log(response.status);         // HTTP status
+console.log(response.message);        // Response message
+
+// Data method - direct access to data only  
+const aiData = await api.gregorovich.chatGpt.ask.getData({ question: "What is AI?" });
+console.log(aiData.answer);          // Direct access to answer
+```
+
+### Schema Organization Revolution
+
+**Path-based schema files** mirror the client structure:
+
+```
+services/gregorovich/schemas/
+├── index.ts              # Central exports with path-based aliases
+├── chatGptAsk.ts         # /chat-gpt/ask endpoint schemas
+├── documents.ts          # /documents endpoint schemas  
+├── healthCheck.ts        # /health-check endpoint schemas
+└── ollamaGenerate.ts     # /ollama/generate endpoint schemas
+```
+
+**Benefits:**
+- **Predictable Navigation**: OpenAPI paths = client structure
+- **AI-Friendly**: Rich semantic metadata for intelligent suggestions
+- **Type Safety**: Full TypeScript coverage with Zod validation
+- **Dual Access**: Choose between full response or data-only patterns
+- **Scalable Architecture**: Consistent patterns across 20+ microservices
+
 ## The Five Ideals in Action
 
 This platform embodies the Five Ideals from The Unicorn Project, transforming how developers interact with enterprise APIs:

package/dist/cjs/index.d.ts

@@ -1,4 +1,4 @@
-export declare const VERSION = "0.3.3";
+export declare const VERSION = "0.4.1";
 export { AugurAPI } from './client';
 export { authenticateUserForSite, createCrossSiteAuthenticator, type CrossSiteAuthParams, type CrossSiteAuthResult, } from './utils/cross-site-auth';
 export { AugurAPIConfig, RequestConfig, type AugurContext, ContextCreationError, } from './core/config';

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UPSClient = exports.SmartyStreetsClient = exports.SlackClient = exports.ShippingClient = exports.P21ApisClient = exports.LogisticsClient = exports.GregorovichClient = exports.BrandFolderClient = exports.AvalaraClient = exports.AgrWorkClient = exports.AgrInfoClient = exports.P21SismClient = exports.PaymentsClient = exports.P21PimClient = exports.OrdersClient = exports.CustomersClient = exports.AgrSiteClient = exports.LegacyClient = exports.NexusClient = exports.ItemsClient = exports.OpenSearchClient = exports.VMIClient = exports.PricingClient = exports.CommerceClient = exports.JoomlaClient = exports.PaginationParamsSchema = exports.HealthCheckDataSchema = exports.BaseResponseSchema = exports.RateLimitError = exports.NotFoundError = exports.AuthenticationError = exports.ValidationError = exports.AugurError = exports.ContextCreationError = exports.createCrossSiteAuthenticator = exports.authenticateUserForSite = exports.AugurAPI = exports.VERSION = void 0;
-exports.VERSION = '0.3.3';
+exports.VERSION = '0.4.1';
 // Main client
 var client_1 = require("./client");
 Object.defineProperty(exports, "AugurAPI", { enumerable: true, get: function () { return client_1.AugurAPI; } });