cobrili-client 1.0.0

package/README.md

@@ -0,0 +1,119 @@
+# Cobrili-Client
+
+Modern TypeScript API client for Cobrili REST API. Works in both Browser and Node.js environments.
+
+## Features
+
+- ✅ Full TypeScript support with type definitions
+- ✅ Registry-driven API with all methods auto-generated
+- ✅ Works in Browser and Node.js
+- ✅ JSON-based communication
+- ✅ Promise/async-await API
+- ✅ Configurable base URL and headers
+
+## Installation
+
+```bash
+npm install cobrili-client
+```
+
+## Usage
+
+### ES6 Import (Recommended)
+
+```typescript
+import { createCobriliClient } from 'cobrili-client';
+
+const client = createCobriliClient({
+  baseUrl: 'http://localhost:5000',
+  endpoint: '/api/cobrili',
+  headers: {
+    'Authorization': 'Basic ' + btoa('user:pass')
+  }
+});
+
+// Login
+const loginResult = await client.login({ loginUser: { username: 'user', password: 'pass' } });
+
+// Get navigation
+const nav = await client.getNavigationWithMetaData({ currentNavigationID: 0 });
+
+// Get content
+const content = await client.getContent({ topicID: 12345 });
+```
+
+### CommonJS
+
+```javascript
+const { createCobriliClient } = require('cobrili-client');
+
+const client = createCobriliClient({ baseUrl: 'http://localhost:5000' });
+```
+
+## API Methods
+
+All methods are auto-generated from the API registry. Import `API_METHODS` for the full list:
+
+```typescript
+import { API_METHODS } from 'cobrili-client';
+
+// List all available methods
+console.log(Object.keys(API_METHODS));
+```
+
+### Authentication
+- `login({ loginUser: { username, password } })` - Login with credentials
+- `logout({})` - Logout
+
+### Navigation
+- `getNavigationWithMetaData({ currentNavigationID })` - Get navigation tree
+- `navigateToTopic({ topicID, navigationID })` - Navigate to topic
+
+### Content
+- `getContent({ topicID })` - Get topic content
+- `getTopicForExternalId({ externalIdForTopic, externalIdForHelpset })` - Find topic
+
+### Helpset
+- `getAllHelpsets({ masterHelpSetApplicationIdentifier, withMetadata })` - Get all helpsets
+- `getHomeTopicId({ helpsetID })` - Get home topic
+- `loadActiveHelpset({ helpsetID })` - Load a helpset
+
+## License
+
+MIT
+- `historyBack(steps?)` / `historyForward(steps?)` - Navigate history
+- `getBookmarkList()` - Get bookmarks
+- `addBookmark(topicID, navigationID, title)` - Add bookmark
+
+### Metadata
+- `getUsedMetaValues(metaKey)` - Get meta values
+- `getMetaValueForTopic(metaKey, topicID)` - Get meta for topic
+- `getMetaKeyWhichRepresentsLanguage()` - Get language key
+
+### System
+- `getCurrentCobriliVersion()` - Get version
+- `getConfigurationData()` - Get configuration
+- `clearStaticCaches()` - Clear caches
+- `healthCheck()` - Health check
+
+## Response Format
+
+```typescript
+interface ApiResponse<T> {
+  success: boolean;
+  data: T;
+  status: number;
+  message?: string;
+}
+```
+
+## Development
+
+```bash
+npm install
+npm run build
+```
+
+## License
+
+MIT