@vulog/aima-config 1.2.45 → 1.2.46

package/README.md

@@ -1,352 +1,233 @@
 # @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.
+Fleet configuration — cities, services, labels, and payment parameters.
 
 ## Installation
 
-```bash
-npm install @vulog/aima-client @vulog/aima-core @vulog/aima-config
+```sh
+npm install @vulog/aima-config @vulog/aima-client @vulog/aima-core
 ```
 
 ## Usage
 
-### Initialize Client
-
-```javascript
+```ts
 import { getClient } from '@vulog/aima-client';
-import { 
-    getCities, 
-    getServices, 
-    getFleetConf, 
-    getPaymentParameters,
-    createLabel,
-    updateLabel,
-    deleteLabel,
-    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',
-});
+import { getCities, getServices, getFleetConf } from '@vulog/aima-config';
+
+const client = getClient({ /* client options */ });
+
+const cities = await getCities(client);
+const services = await getServices(client);
+const conf = await getFleetConf(client);
 ```
 
 ## API Reference
 
-### Configuration Data
+### getCities
 
-#### getCities
+```ts
+getCities(client: Client): Promise<City[]>
+```
 
-Retrieve all cities available in the fleet.
+Returns cities matching the client's `fleetId`.
 
-```javascript
-const cities = await getCities(client);
+**Params:** `client` — Authenticated AIMA client  
+**Returns:** `Promise<City[]>`
+
+---
+
+### getCitiesAllFranchises
+
+```ts
+getCitiesAllFranchises(client: Client): Promise<(City & { fleetId: string })[]>
 ```
 
-**Parameters:**
-- `client`: AIMA client instance
+Returns all cities across all franchises, each annotated with its `fleetId`.
 
-**Returns:** Array of city objects
+**Params:** `client` — Authenticated AIMA client  
+**Returns:** `Promise<(City & { fleetId: string })[]>`
 
-#### getServices
+---
 
-Get all services available in the fleet.
+### getServices
 
-```javascript
-const services = await getServices(client);
+```ts
+getServices(client: Client): Promise<Service[]>
 ```
 
-**Parameters:**
-- `client`: AIMA client instance
+Returns services matching the client's `fleetId`.
 
-**Returns:** Array of service objects
+**Params:** `client` — Authenticated AIMA client  
+**Returns:** `Promise<Service[]>`
 
-#### getFleetConf
+---
 
-Retrieve fleet configuration settings.
+### getServicesAllFranchises
 
-```javascript
-const fleetConfig = await getFleetConf(client);
+```ts
+getServicesAllFranchises(client: Client): Promise<(Service & { fleetId: string })[]>
 ```
 
-**Parameters:**
-- `client`: AIMA client instance
+Returns all services across all franchises, each annotated with its `fleetId`.
 
-**Returns:** Fleet configuration object
+**Params:** `client` — Authenticated AIMA client  
+**Returns:** `Promise<(Service & { fleetId: string })[]>`
 
-#### getPaymentParameters
+---
 
-Get payment configuration parameters.
+### getFleetConf
 
-```javascript
-const paymentParams = await getPaymentParameters(client);
+```ts
+getFleetConf(client: Client): Promise<FleetConf>
 ```
 
-**Parameters:**
-- `client`: AIMA client instance
+Returns fleet-level configuration.
 
-**Returns:** Payment parameters object
+**Params:** `client` — Authenticated AIMA client  
+**Returns:** `Promise<FleetConf>`
 
-### Label Management
+---
 
-#### createLabel
+### getLabels
 
-Create a new label.
-
-```javascript
-const label = await createLabel(client, {
-    name: 'Premium User',
-    color: '#FF5733',
-    description: 'High-value customers'
-});
+```ts
+getLabels(client: Client): Promise<Label[]>
 ```
 
-**Parameters:**
-- `client`: AIMA client instance
-- `labelData`: Label creation data
-  - `name`: Label name
-  - `color`: Label color (hex code)
-  - `description`: Label description
+Returns all labels for the fleet.
+
+**Params:** `client` — Authenticated AIMA client  
+**Returns:** `Promise<Label[]>`
 
-#### updateLabel
+---
 
-Update an existing label.
+### addLabel
 
-```javascript
-const updatedLabel = await updateLabel(client, 'label-id-here', {
-    name: 'Updated Label Name',
-    color: '#33FF57',
-    description: 'Updated description'
-});
+```ts
+addLabel(client: Client, name: string): Promise<void>
 ```
 
-#### deleteLabel
+Creates a new label. `name` must be non-empty.
 
-Delete a label.
+**Params:** `client` — Authenticated AIMA client; `name` — label name (non-empty)  
+**Returns:** `Promise<void>`
 
-```javascript
-const result = await deleteLabel(client, 'label-id-here');
+---
+
+### removeLabel
+
+```ts
+removeLabel(client: Client, labelId: number, cascade?: boolean): Promise<void>
 ```
 
-#### getLabels
+Deletes a label by ID. `labelId` must be a positive integer. `cascade` defaults to `false`; when `true`, also removes the label from all associated resources.
+
+**Params:** `client` — Authenticated AIMA client; `labelId` — positive integer; `cascade` — optional, default `false`  
+**Returns:** `Promise<void>`
+
+---
 
-Retrieve all labels.
+### getPaymentParameters
 
-```javascript
-const labels = await getLabels(client);
+```ts
+getPaymentParameters(
+    client: Client,
+    serviceId?: string,
+    modelId?: string,
+    strict?: string
+): Promise<PaymentParameters[] | null>
 ```
 
+Returns payment parameters, optionally filtered by service and model.
+
+**Params:** `client` — Authenticated AIMA client; `serviceId` — optional; `modelId` — optional; `strict` — optional  
+**Returns:** `Promise<PaymentParameters[] | null>`
+
 ## Types
 
 ### City
 
-```typescript
+```ts
 interface City {
     id: string;
     name: string;
-    country: string;
-    countryCode: string;
-    coordinates: {
-        latitude: number;
-        longitude: number;
-    };
-    timezone: string;
-    isActive: boolean;
+    locale: string;
+    imagesUrl: string;
+    tokenIconsUrl?: string;
+    lat: number;
+    lon: number;
+    zoomLevel: number;
+    radius: number;
+    termsOfUseUrl: string;
+    termsOfUseUpdateDatetime: string;
+    faqUrl: string;
+    contactPhoneNumber: string;
+    agreementsDate: string;
+    timeZone: string;
+    distanceUnit: string;
+    contactUrl: string;
+    services: string[];
+    zoneId: string;
 }
 ```
 
 ### Service
 
-```typescript
+```ts
 interface Service {
     id: string;
     name: string;
-    description: string;
-    type: 'CAR_SHARING' | 'BIKE_SHARING' | 'SCOOTER_SHARING' | 'MULTIMODAL';
-    isActive: boolean;
-    features: string[];
-    pricing: any;
+    status: 'ACTIVE' | 'DISABLED';
+    type:
+        | 'FREE_FLOATING'
+        | 'FREE_FLOATING_STRICT'
+        | 'SERVICE_TRIP'
+        | 'BOOKING'
+        | 'ROUND_TRIP_BOOKING'
+        | 'BY_PASS_FREE_FLOATING'
+        | 'BY_PASS_ROUND_TRIP_BOOKING'
+        | 'SUBSCRIPTION'
+        | 'SCHEDULED_BOOKING_STATION';
+    cityId: string;
+    zones: string[];
+    vehicles: string[];
+    stations: string[];
+    pois: string[];
 }
 ```
 
-### FleetConfiguration
+### FleetConf
 
-```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;
+```ts
+interface FleetConf {
+    triggerSubscriptionPaymentInHours: number;
+    timeZone: string;
 }
 ```
 
 ### Label
 
-```typescript
+```ts
 interface Label {
-    id: string;
+    id: number;
     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;
-    }
+    createDate: string;
 }
 ```
 
-### 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;
-    }
-}
-```
+### PaymentParameters
 
-### 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;
-    }
+```ts
+interface PaymentParameters {
+    id: string;
+    referenceId: string;
+    scope: 'RENTAL';
+    flow: 'MANDATORY';
+    amountType: 'FIXED' | 'PERCENTAGE';
+    amountValue: null | number;
+    fleetId: string;
+    providePreferredPaymentMethodPspReferences: boolean;
+    serviceId?: string;
+    modelIds?: string[];
 }
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-config",
     "type": "module",
-    "version": "1.2.45",
+    "version": "1.2.46",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.cts",
@@ -32,8 +32,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.45",
-        "@vulog/aima-core": "1.2.45"
+        "@vulog/aima-client": "1.2.46",
+        "@vulog/aima-core": "1.2.46"
     },
     "peerDependencies": {
         "zod": "^4.3.6"