@vulog/aima-config 1.1.89 → 1.1.91

package/README.md

@@ -1,22 +1,352 @@
 # @vulog/aima-config
 
+Configuration management module for the AIMA platform. This module provides functionality to retrieve fleet configuration, cities, services, payment parameters, and manage labels.
+
+## Installation
+
 ```bash
-npm i @vulog/aima-client @vulog/aima-core @vulog/aima-config
+npm install @vulog/aima-client @vulog/aima-core @vulog/aima-config
 ```
 
+## Usage
+
+### Initialize Client
+
 ```javascript
 import { getClient } from '@vulog/aima-client';
-import { getCities, getServices } from '@vulog/aima-config';
+import { 
+    getCities, 
+    getServices, 
+    getFleetConf, 
+    getPaymentParameters,
+    createLabel,
+    updateLabel,
+    deleteLabel,
+    getLabels
+} from '@vulog/aima-config';
 
 const client = getClient({
-    apiKey: '...',
-    baseUrl: '...',
-    clientId: '...',
-    clientSecret: '...',
-    fleetId: '...',
+    apiKey: 'your-api-key',
+    baseUrl: 'https://your-api-base-url',
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret',
+    fleetId: 'your-fleet-id',
 });
+```
+
+## API Reference
 
+### Configuration Data
+
+#### getCities
+
+Retrieve all cities available in the fleet.
+
+```javascript
 const cities = await getCities(client);
+```
+
+**Parameters:**
+- `client`: AIMA client instance
+
+**Returns:** Array of city objects
+
+#### getServices
+
+Get all services available in the fleet.
+
+```javascript
 const services = await getServices(client);
+```
 
+**Parameters:**
+- `client`: AIMA client instance
+
+**Returns:** Array of service objects
+
+#### getFleetConf
+
+Retrieve fleet configuration settings.
+
+```javascript
+const fleetConfig = await getFleetConf(client);
+```
+
+**Parameters:**
+- `client`: AIMA client instance
+
+**Returns:** Fleet configuration object
+
+#### getPaymentParameters
+
+Get payment configuration parameters.
+
+```javascript
+const paymentParams = await getPaymentParameters(client);
+```
+
+**Parameters:**
+- `client`: AIMA client instance
+
+**Returns:** Payment parameters object
+
+### Label Management
+
+#### createLabel
+
+Create a new label.
+
+```javascript
+const label = await createLabel(client, {
+    name: 'Premium User',
+    color: '#FF5733',
+    description: 'High-value customers'
+});
+```
+
+**Parameters:**
+- `client`: AIMA client instance
+- `labelData`: Label creation data
+  - `name`: Label name
+  - `color`: Label color (hex code)
+  - `description`: Label description
+
+#### updateLabel
+
+Update an existing label.
+
+```javascript
+const updatedLabel = await updateLabel(client, 'label-id-here', {
+    name: 'Updated Label Name',
+    color: '#33FF57',
+    description: 'Updated description'
+});
+```
+
+#### deleteLabel
+
+Delete a label.
+
+```javascript
+const result = await deleteLabel(client, 'label-id-here');
+```
+
+#### getLabels
+
+Retrieve all labels.
+
+```javascript
+const labels = await getLabels(client);
+```
+
+## Types
+
+### City
+
+```typescript
+interface City {
+    id: string;
+    name: string;
+    country: string;
+    countryCode: string;
+    coordinates: {
+        latitude: number;
+        longitude: number;
+    };
+    timezone: string;
+    isActive: boolean;
+}
+```
+
+### Service
+
+```typescript
+interface Service {
+    id: string;
+    name: string;
+    description: string;
+    type: 'CAR_SHARING' | 'BIKE_SHARING' | 'SCOOTER_SHARING' | 'MULTIMODAL';
+    isActive: boolean;
+    features: string[];
+    pricing: any;
+}
+```
+
+### FleetConfiguration
+
+```typescript
+interface FleetConfiguration {
+    id: string;
+    name: string;
+    settings: {
+        timezone: string;
+        currency: string;
+        language: string;
+        features: string[];
+        limits: {
+            maxVehicles: number;
+            maxUsers: number;
+            maxStations: number;
+        };
+    };
+    createdAt: string;
+    updatedAt: string;
+}
+```
+
+### Label
+
+```typescript
+interface Label {
+    id: string;
+    name: string;
+    color: string;
+    description: string;
+    createdAt: string;
+    updatedAt: string;
+}
+```
+
+## Error Handling
+
+All functions include validation and will throw appropriate errors if:
+- Required parameters are missing
+- Invalid label IDs are provided
+- Network errors occur
+
+## Examples
+
+### Complete Configuration Management
+
+```javascript
+import { getClient } from '@vulog/aima-client';
+import { 
+    getCities, 
+    getServices, 
+    getFleetConf, 
+    getPaymentParameters,
+    createLabel,
+    getLabels
+} from '@vulog/aima-config';
+
+const client = getClient({
+    apiKey: 'your-api-key',
+    baseUrl: 'https://your-api-base-url',
+    clientId: 'your-client-id',
+    clientSecret: 'your-client-secret',
+    fleetId: 'your-fleet-id',
+});
+
+async function configurationWorkflow() {
+    try {
+        // Get fleet configuration
+        const fleetConfig = await getFleetConf(client);
+        console.log('Fleet configuration:', fleetConfig);
+        
+        // Get available cities
+        const cities = await getCities(client);
+        console.log(`Found ${cities.length} cities`);
+        
+        // Get available services
+        const services = await getServices(client);
+        console.log(`Found ${services.length} services`);
+        
+        // Get payment parameters
+        const paymentParams = await getPaymentParameters(client);
+        console.log('Payment parameters:', paymentParams);
+        
+        // Create a new label
+        const label = await createLabel(client, {
+            name: 'VIP Customer',
+            color: '#FFD700',
+            description: 'Very Important Customer'
+        });
+        console.log('Created label:', label);
+        
+        // Get all labels
+        const labels = await getLabels(client);
+        console.log(`Found ${labels.length} labels`);
+        
+        return { fleetConfig, cities, services, paymentParams, labels };
+    } catch (error) {
+        console.error('Configuration workflow error:', error);
+        throw error;
+    }
+}
+```
+
+### Service Analysis
+
+```javascript
+async function analyzeServices(client) {
+    try {
+        const services = await getServices(client);
+        
+        const analysis = {
+            totalServices: services.length,
+            activeServices: services.filter(s => s.isActive).length,
+            servicesByType: services.reduce((acc, service) => {
+                acc[service.type] = (acc[service.type] || 0) + 1;
+                return acc;
+            }, {}),
+            servicesWithFeatures: services.filter(s => s.features && s.features.length > 0).length,
+            averageFeaturesPerService: services.reduce((sum, s) => sum + (s.features?.length || 0), 0) / services.length
+        };
+        
+        console.log('Service Analysis:');
+        console.log(`Total Services: ${analysis.totalServices}`);
+        console.log(`Active Services: ${analysis.activeServices}`);
+        console.log('Services by Type:', analysis.servicesByType);
+        console.log(`Services with Features: ${analysis.servicesWithFeatures}`);
+        console.log(`Average Features per Service: ${analysis.averageFeaturesPerService.toFixed(2)}`);
+        
+        return analysis;
+    } catch (error) {
+        console.error('Service analysis error:', error);
+        throw error;
+    }
+}
+```
+
+### City Management
+
+```javascript
+async function manageCities(client) {
+    try {
+        const cities = await getCities(client);
+        
+        // Group cities by country
+        const citiesByCountry = cities.reduce((acc, city) => {
+            if (!acc[city.country]) {
+                acc[city.country] = [];
+            }
+            acc[city.country].push(city);
+            return acc;
+        }, {});
+        
+        // Find cities in specific timezone
+        const timezoneGroups = cities.reduce((acc, city) => {
+            if (!acc[city.timezone]) {
+                acc[city.timezone] = [];
+            }
+            acc[city.timezone].push(city);
+            return acc;
+        }, {});
+        
+        console.log('City Management:');
+        console.log(`Total Cities: ${cities.length}`);
+        console.log(`Active Cities: ${cities.filter(c => c.isActive).length}`);
+        console.log('Cities by Country:', Object.keys(citiesByCountry).map(country => 
+            `${country}: ${citiesByCountry[country].length}`
+        ));
+        console.log('Cities by Timezone:', Object.keys(timezoneGroups).map(tz => 
+            `${tz}: ${timezoneGroups[tz].length}`
+        ));
+        
+        return { cities, citiesByCountry, timezoneGroups };
+    } catch (error) {
+        console.error('City management error:', error);
+        throw error;
+    }
+}
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-config",
-    "version": "1.1.89",
+    "version": "1.1.91",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -19,8 +19,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.1.89",
-        "@vulog/aima-core": "1.1.89"
+        "@vulog/aima-client": "1.1.91",
+        "@vulog/aima-core": "1.1.91"
     },
     "peerDependencies": {
         "zod": "^3.25.76"