@simpleapps-com/augur-api 0.2.4 → 0.2.5

package/README.md

@@ -5,6 +5,7 @@ A comprehensive TypeScript client library for accessing Augur microservices with
 ## Table of Contents
 
 - [Overview](#overview)
+- [🎯 AI-Powered Discovery System - Where Code Writes Itself](#-ai-powered-discovery-system---where-code-writes-itself)
 - [Features](#features)
 - [Installation](#installation)
 - [Getting Started](#getting-started)
@@ -31,8 +32,107 @@ The Augur API Client Library provides a unified TypeScript SDK for accessing Aug
 - **Runtime Validation**: Zod schemas validate all requests and responses
 - **Developer Experience**: Rich JSDoc documentation and IntelliSense support
 
+## IDE Support & AI Assistant Integration
+
+This client library is designed to work seamlessly with modern IDEs and AI coding assistants through comprehensive semantic documentation.
+
+### IntelliSense & Auto-completion
+
+Every method includes detailed JSDoc with:
+- **Parameter descriptions** and types
+- **Usage examples** with real code
+- **Related methods** and cross-service connections
+- **Business context** and workflow information
+
+```typescript
+client.agrSite.settings. // ← IDE shows all available methods with descriptions
+```
+
+### AI Assistant Features
+
+The semantic JSDoc tags help AI assistants understand:
+
+```typescript
+/**
+ * @searchTerms ["settings", "configuration", "site config"]
+ * @relatedEndpoints ["api.agrSite.settings.get", "api.agrSite.settings.update"]
+ * @workflow ["settings-management", "site-configuration"]
+ * @commonPatterns ["Get all settings", "List site configuration"]
+ */
+```
+
+This means when you ask an AI assistant to "help me manage site settings", it can:
+1. Find the right service (`agrSite.settings`)
+2. Suggest the correct method (`list`, `get`, `create`, etc.)
+3. Show related operations you might need
+4. Provide complete workflow examples
+
+### Dual API Pattern
+
+Each service provides two ways to call methods:
+
+```typescript
+// Standard method - returns full response with metadata
+const response = await client.agrSite.settings.list();
+console.log(response.data, response.total, response.message);
+
+// Data method - returns only the data portion
+const settings = await client.agrSite.settings.listData();
+console.log(settings); // Direct array access
+```
+
+### API Discovery Functions
+
+The client provides discovery functions for exploring available services and endpoints:
+
+#### `discover()` - Service Map
+
+Get an overview of available services and their discoverable endpoints:
+
+```typescript
+const api = new AugurAPI({ siteId: 'my-site', bearerToken: 'token' });
+const services = await api.discover();
+
+// Returns ServiceMap[] with:
+// - serviceName: string
+// - description: string  
+// - baseUrl: string
+// - endpointCount: number
+// - endpoints: DiscoveryEndpoint[]
+
+services.forEach(service => {
+  console.log(`${service.serviceName}: ${service.endpointCount} endpoints`);
+});
+```
+
+#### `findEndpoint()` - Endpoint Search
+
+Search across services for endpoints matching a search term:
+
+```typescript
+// Basic search
+const results = await api.findEndpoint('users');
+
+// With options
+const results = await api.findEndpoint('settings', {
+  minScore: 0.1,         // Minimum relevance score (default: 0.1)
+  maxResults: 10,        // Max results (default: 10)
+  service: 'agrSite',    // Filter by service
+  domain: 'site-content-management', // Filter by domain
+  readOnly: true         // Only GET endpoints
+});
+
+// Returns EndpointSearchResult[] with:
+// - endpoint: DiscoveryEndpoint (with fullPath, service, domain, etc.)
+// - score: number (0-1 relevance)
+// - matchReason: string
+```
+
 ## Features
 
+✅ **AI-Powered Discovery** - Natural language search finds any functionality instantly  
+✅ **Semantic Intelligence** - Understands business context and suggests workflows  
+✅ **Cross-Service Awareness** - Maps relationships between all microservices  
 ✅ **Simple API** - Intuitive method names following REST conventions  
 ✅ **Type Safe** - Full TypeScript support with auto-completion  
 ✅ **Runtime Validation** - Zod schemas validate all requests and responses  

package/dist/cjs/index.d.ts

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

package/dist/cjs/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 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.createCrossSiteAuthenticator = exports.authenticateUserForSite = exports.AugurAPI = exports.VERSION = void 0;
-exports.VERSION = '0.2.3';
+exports.VERSION = '0.2.5';
 // Main client
 var client_1 = require("./client");
 Object.defineProperty(exports, "AugurAPI", { enumerable: true, get: function () { return client_1.AugurAPI; } });