@dapex-tech/elite-online-services 0.0.15 → 0.0.16

package/createClient.d.ts

@@ -17,5 +17,6 @@ export declare function createClient(baseUrl?: string): {
     DriversService: typeof services.DriversService;
     HealthService: typeof services.HealthService;
     MainService: typeof services.MainService;
+    ManualCustomerService: typeof services.ManualCustomerService;
     VoucherService: typeof services.VoucherService;
 };

package/models/ManualCustomerCreateDto.d.ts

@@ -0,0 +1,30 @@
+export type ManualCustomerCreateDto = {
+    /**
+     * First name
+     */
+    firstName: string;
+    /**
+     * Last name
+     */
+    lastName: string;
+    /**
+     * Phone country code
+     */
+    phoneCountryCode: string;
+    /**
+     * Phone number
+     */
+    phone: string;
+    /**
+     * Email
+     */
+    email: string;
+    /**
+     * Address
+     */
+    address: string;
+    /**
+     * Admin ID
+     */
+    adminId?: number;
+};

package/models/ManualCustomerCreateDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/ManualCustomerDto.d.ts

@@ -0,0 +1,42 @@
+export type ManualCustomerDto = {
+    /**
+     * Manual customer ID
+     */
+    id: number;
+    /**
+     * First name
+     */
+    firstName: string;
+    /**
+     * Last name
+     */
+    lastName: string;
+    /**
+     * Phone country code
+     */
+    phoneCountryCode: string;
+    /**
+     * Phone number
+     */
+    phone: string;
+    /**
+     * Email
+     */
+    email: string;
+    /**
+     * Address
+     */
+    address: string;
+    /**
+     * Admin ID
+     */
+    adminId: number;
+    /**
+     * Created at timestamp
+     */
+    createdAt: string;
+    /**
+     * Updated at timestamp
+     */
+    updatedAt?: Record<string, any>;
+};

package/models/ManualCustomerDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/ManualCustomerUpdateDto.d.ts

@@ -0,0 +1,30 @@
+export type ManualCustomerUpdateDto = {
+    /**
+     * First name
+     */
+    firstName?: string;
+    /**
+     * Last name
+     */
+    lastName?: string;
+    /**
+     * Phone country code
+     */
+    phoneCountryCode?: string;
+    /**
+     * Phone number
+     */
+    phone?: string;
+    /**
+     * Email
+     */
+    email?: string;
+    /**
+     * Address
+     */
+    address?: string;
+    /**
+     * Admin ID
+     */
+    adminId?: number;
+};

package/models/ManualCustomerUpdateDto.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/models/TripDto.d.ts

@@ -1,8 +1,10 @@
 import type { AdminDto } from './AdminDto';
 import type { CustomerDto } from './CustomerDto';
 import type { DriverDto } from './DriverDto';
+import type { ManualCustomerDto } from './ManualCustomerDto';
 import type { PaymentDto } from './PaymentDto';
 import type { TripLocationPointDto } from './TripLocationPointDto';
+import type { VoucherDto } from './VoucherDto';
 export type TripDto = {
     /**
      * Trip ID
@@ -11,6 +13,8 @@ export type TripDto = {
     driverId?: Record<string, any> | null;
     customerId?: Record<string, any> | null;
     adminId?: Record<string, any> | null;
+    voucherId?: Record<string, any> | null;
+    manualCustomerId?: Record<string, any> | null;
     status?: TripDto.status;
     tripSource?: Record<string, any>;
     driverAssignmentMode?: Record<string, any>;
@@ -141,6 +145,14 @@ export type TripDto = {
      * Payments associated with the trip
      */
     payments?: Array<PaymentDto> | null;
+    /**
+     * Voucher information
+     */
+    voucher?: VoucherDto | null;
+    /**
+     * Manual customer information
+     */
+    manualCustomer?: ManualCustomerDto | null;
 };
 export declare namespace TripDto {
     enum status {

package/models/TripUpdateDto.d.ts

@@ -1,6 +1,8 @@
 export type TripUpdateDto = {
     driverId?: Record<string, any> | null;
     customerId?: Record<string, any> | null;
+    voucherId?: Record<string, any> | null;
+    manualCustomerId?: Record<string, any> | null;
     origin?: Record<string, any> | null;
     /**
      * Origin address

package/models/index.d.ts

@@ -21,6 +21,9 @@ export * from './DriverTripActions';
 export * from './DriverUpdateDto';
 export * from './GenerateResetCodeDto';
 export * from './GenerateVerificationCodeDto';
+export * from './ManualCustomerCreateDto';
+export * from './ManualCustomerDto';
+export * from './ManualCustomerUpdateDto';
 export * from './MessageResponseDto';
 export * from './OrderDto';
 export * from './PaymentDto';

package/models/index.js

@@ -37,6 +37,9 @@ __exportStar(require("./DriverTripActions"), exports);
 __exportStar(require("./DriverUpdateDto"), exports);
 __exportStar(require("./GenerateResetCodeDto"), exports);
 __exportStar(require("./GenerateVerificationCodeDto"), exports);
+__exportStar(require("./ManualCustomerCreateDto"), exports);
+__exportStar(require("./ManualCustomerDto"), exports);
+__exportStar(require("./ManualCustomerUpdateDto"), exports);
 __exportStar(require("./MessageResponseDto"), exports);
 __exportStar(require("./OrderDto"), exports);
 __exportStar(require("./PaymentDto"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dapex-tech/elite-online-services",
-	"version": "0.0.15",
+	"version": "0.0.16",
 	"main": "./index.js",
 	"types": "./index.d.ts",
 	"private": false,

package/services/ManualCustomerService.d.ts

@@ -0,0 +1,45 @@
+import type { ManualCustomerCreateDto } from '../models/ManualCustomerCreateDto';
+import type { ManualCustomerDto } from '../models/ManualCustomerDto';
+import type { ManualCustomerUpdateDto } from '../models/ManualCustomerUpdateDto';
+import type { MessageResponseDto } from '../models/MessageResponseDto';
+import type { OrderDto } from '../models/OrderDto';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class ManualCustomerService {
+    /**
+     * Create a new manual customer
+     * @param requestBody
+     * @returns ManualCustomerDto Manual customer created successfully.
+     * @throws ApiError
+     */
+    static create(requestBody: ManualCustomerCreateDto): CancelablePromise<ManualCustomerDto>;
+    /**
+     * Get all manual customers
+     * @param q Text to search for in name, phone, email, or address
+     * @param order Sorting options
+     * @returns ManualCustomerDto List of manual customers
+     * @throws ApiError
+     */
+    static findAll(q?: string, order?: OrderDto): CancelablePromise<Array<ManualCustomerDto>>;
+    /**
+     * Get a single manual customer by ID
+     * @param id
+     * @returns ManualCustomerDto Manual customer found
+     * @throws ApiError
+     */
+    static findById(id: number): CancelablePromise<ManualCustomerDto>;
+    /**
+     * Update a manual customer by ID
+     * @param id
+     * @param requestBody
+     * @returns ManualCustomerDto Manual customer updated successfully.
+     * @throws ApiError
+     */
+    static update(id: number, requestBody: ManualCustomerUpdateDto): CancelablePromise<ManualCustomerDto>;
+    /**
+     * Delete a manual customer by ID
+     * @param id
+     * @returns MessageResponseDto Manual customer deleted successfully.
+     * @throws ApiError
+     */
+    static remove(id: number): CancelablePromise<MessageResponseDto>;
+}

package/services/ManualCustomerService.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManualCustomerService = void 0;
+const OpenAPI_1 = require("../core/OpenAPI");
+const request_1 = require("../core/request");
+class ManualCustomerService {
+    /**
+     * Create a new manual customer
+     * @param requestBody
+     * @returns ManualCustomerDto Manual customer created successfully.
+     * @throws ApiError
+     */
+    static create(requestBody) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'POST',
+            url: '/admins/manual-customers',
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Get all manual customers
+     * @param q Text to search for in name, phone, email, or address
+     * @param order Sorting options
+     * @returns ManualCustomerDto List of manual customers
+     * @throws ApiError
+     */
+    static findAll(q, order) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/admins/manual-customers',
+            query: {
+                'q': q,
+                'order': order,
+            },
+        });
+    }
+    /**
+     * Get a single manual customer by ID
+     * @param id
+     * @returns ManualCustomerDto Manual customer found
+     * @throws ApiError
+     */
+    static findById(id) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'GET',
+            url: '/admins/manual-customers/{id}',
+            path: {
+                'id': id,
+            },
+        });
+    }
+    /**
+     * Update a manual customer by ID
+     * @param id
+     * @param requestBody
+     * @returns ManualCustomerDto Manual customer updated successfully.
+     * @throws ApiError
+     */
+    static update(id, requestBody) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'PATCH',
+            url: '/admins/manual-customers/{id}',
+            path: {
+                'id': id,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Delete a manual customer by ID
+     * @param id
+     * @returns MessageResponseDto Manual customer deleted successfully.
+     * @throws ApiError
+     */
+    static remove(id) {
+        return (0, request_1.request)(OpenAPI_1.OpenAPI, {
+            method: 'DELETE',
+            url: '/admins/manual-customers/{id}',
+            path: {
+                'id': id,
+            },
+        });
+    }
+}
+exports.ManualCustomerService = ManualCustomerService;

package/services/index.d.ts

@@ -12,4 +12,5 @@ export * from './DriverTripsService';
 export * from './DriversService';
 export * from './HealthService';
 export * from './MainService';
+export * from './ManualCustomerService';
 export * from './VoucherService';

package/services/index.js

@@ -28,4 +28,5 @@ __exportStar(require("./DriverTripsService"), exports);
 __exportStar(require("./DriversService"), exports);
 __exportStar(require("./HealthService"), exports);
 __exportStar(require("./MainService"), exports);
+__exportStar(require("./ManualCustomerService"), exports);
 __exportStar(require("./VoucherService"), exports);

package/socketService.d.ts

@@ -26,4 +26,7 @@ export declare class SocketService {
     offTripUpdate(cb?: (data: any) => void): void;
     emitDriverStatusUpdate(data: DriverStatus): void;
     emitTripActionUpdate(data: DriverExecuteTripAction): void;
+    emitGetInfo(): void;
+    onGetInfoResponse(cb: (data: any) => void): void;
+    offGetInfoResponse(cb?: (data: any) => void): void;
 }

package/socketService.js

@@ -125,5 +125,19 @@ class SocketService {
     emitTripActionUpdate(data) {
         this.emit('tripActionUpdate', { ...data });
     }
+    emitGetInfo() {
+        this.emit('getInfo', {});
+    }
+    onGetInfoResponse(cb) {
+        this.socket.on('getInfo:Response', cb);
+    }
+    offGetInfoResponse(cb) {
+        if (cb) {
+            this.socket.off('getInfo:Response', cb);
+        }
+        else {
+            this.socket.removeAllListeners('getInfo:Response');
+        }
+    }
 }
 exports.SocketService = SocketService;

package/sockets.md

@@ -0,0 +1,260 @@
+# Sockets + Usage in AppContext
+
+## Install
+
+Install the package with yarn:
+
+```bash
+yarn add @dapex-tech/elite-online-services
+```
+
+## Basic socket usage
+
+Import `SocketService` from the package:
+
+```ts
+import { SocketService } from '@dapex-tech/elite-online-services';
+```
+
+Call `SocketService.getInstance()` once, then pass the auth token to `setToken(token)` so the socket connects with the current user context.
+
+```ts
+const socketInstance = SocketService.getInstance();
+socketInstance.setToken(token);
+```
+
+## Global App Context
+
+`AppContext` centralizes realtime app state (like `activeTrip`) and exposes it via `AppProvider` so any screen can react to socket events without prop-drilling. The provider subscribes to socket events, updates state in one place, and cleans up listeners on token change or unmount.
+
+```tsx
+import { SocketService, TripDto } from '@dapex-tech/elite-online-services';
+import { createContext, useContext, useEffect, useState } from 'react';
+
+// Centralized context for global app state
+// and functionality that requires realtime updates
+type AppContextType = {
+	activeTrip: TripDto | null;
+	setActiveTrip: (trip: TripDto | null) => void;
+	// ... other relevant app state
+};
+
+export const AppContext = createContext<AppContextType>({
+	activeTrip: null,
+	setActiveTrip: () => {},
+});
+
+type AppProviderProps = {
+	token: string;
+	children: React.ReactNode;
+};
+
+export const AppProvider = ({ token, children }: AppProviderProps) => {
+	const [activeTrip, setActiveTrip] = useState<TripDto | null>(null);
+
+	// socket event handlers
+	const handleTripUpdate = (data: TripDto | null) => {
+		console.log('[app.context] trip status update', data);
+		if (data != null) {
+			const payload = data;
+			setActiveTrip(payload);
+		}
+	};
+
+	const handleDriverStatusUpdate = (data: unknown) => {
+		console.log('[app.context] driver status update', data);
+		// action on app state
+	};
+
+	// useEffect to initialize sockets and event handlers
+	// and clean up on unmount or token change
+	useEffect(() => {
+		const socketInstance = SocketService.getInstance();
+		socketInstance.setToken(token);
+
+		socketInstance.onTripUpdate(handleTripUpdate);
+		socketInstance.onDriverStatusUpdate(handleDriverStatusUpdate);
+		return () => {
+			socketInstance.offTripUpdate(handleTripUpdate);
+			socketInstance.offDriverStatusUpdate(handleDriverStatusUpdate);
+		};
+	}, [token]);
+
+	return (
+		<AppContext.Provider value={{ activeTrip, setActiveTrip }}>
+			{children}
+		</AppContext.Provider>
+	);
+};
+
+export const useApp = () => {
+	const context = useContext(AppContext);
+	if (!context) {
+		throw new Error('useApp must be used within an AppProvider');
+	}
+	return context;
+};
+```
+
+```tsx
+// Example usage: \_layout.tsx
+<ThemeProvider>
+	<AppProvider token={token}>
+		<RootLayout />
+	</AppProvider>
+</ThemeProvider>
+```
+
+```tsx
+// Example usage: trips.tsx
+const { activeTrip, setActiveTrip } = useApp();
+```
+
+## Emit
+
+Emit from anywhere once the socket is connected:
+
+```ts
+const instance = socketInstance;
+if (!instance) return;
+
+if (socketInstance.isConnected()) {
+	socketInstance.emit('my-event', { foo: 'bar' });
+}
+```
+
+---
+
+## Available methods in `SocketService`
+
+Below is a list of the main public methods of the `SocketService` class, with a brief explanation and usage example:
+
+### `getInstance()`
+
+Gets the singleton instance of the socket service.
+
+```ts
+const socket = SocketService.getInstance();
+```
+
+### `setToken(token: string)`
+
+Sets the authentication token and connects the socket with that user context.
+
+```ts
+socket.setToken('my-jwt-token');
+```
+
+### `clearToken()`
+
+Clears the token and disconnects the socket.
+
+```ts
+socket.clearToken();
+```
+
+### `connect()`
+
+Manually connects the socket (usually not needed if you use `setToken`).
+
+```ts
+socket.connect();
+```
+
+### `disconnect()`
+
+Manually disconnects the socket.
+
+```ts
+socket.disconnect();
+```
+
+### `isConnected(): boolean`
+
+Returns `true` if the socket is connected.
+
+```ts
+if (socket.isConnected()) {
+	// ...
+}
+```
+
+### `on(event: string, cb: (data) => void)`
+
+Subscribe a callback to a custom event.
+
+```ts
+socket.on('my-event', (data) => {
+	console.log(data);
+});
+```
+
+### `off(event: string, cb?: Function)`
+
+Removes a callback from an event, or all listeners if no callback is provided.
+
+```ts
+socket.off('my-event', myCallback);
+// or for all:
+socket.off('my-event');
+```
+
+### `emit(event: string, data: any)`
+
+Emits a custom event to the server.
+
+```ts
+socket.emit('my-event', { foo: 'bar' });
+```
+
+### `onConnected(cb)` / `offConnected(cb?)`
+
+Subscribe/unsubscribe to socket connection events.
+
+```ts
+socket.onConnected(() => console.log('Connected!'));
+socket.offConnected();
+```
+
+### `onDisconnected(cb)` / `offDisconnected(cb?)`
+
+Subscribe/unsubscribe to socket disconnection events.
+
+```ts
+socket.onDisconnected(() => console.log('Disconnected!'));
+socket.offDisconnected();
+```
+
+### `onDriverStatusUpdate(cb)` / `offDriverStatusUpdate(cb?)`
+
+Subscribe/unsubscribe to driver status updates.
+
+```ts
+socket.onDriverStatusUpdate((status) => console.log('Status:', status));
+socket.offDriverStatusUpdate();
+```
+
+### `onTripUpdate(cb)` / `offTripUpdate(cb?)`
+
+Subscribe/unsubscribe to trip updates.
+
+```ts
+socket.onTripUpdate((trip) => console.log('Trip:', trip));
+socket.offTripUpdate();
+```
+
+### `emitDriverStatusUpdate(data)`
+
+Emits a driver status update.
+
+```ts
+socket.emitDriverStatusUpdate({ status: 'online' });
+```
+
+### `emitTripActionUpdate(data)`
+
+Emits a driver trip action.
+
+```ts
+socket.emitTripActionUpdate({ action: 'start', tripId: 123 });
+```