medos-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,15 +1,433 @@
-# How to test this package
+# Medos SDK
 
-#### Go to your package directory (medos-sdk-js):
+A JavaScript/TypeScript SDK for integrating healthcare appointment booking into your applications. Built for clinics, hospitals, and healthcare platforms.
 
-- `cd c:\harsh\projects\medos\medos-sdk-js`
-- `npm link`
+## Installation
 
-#### Go to your test project directory (where you want to use the package):
+```bash
+npm install medos-sdk
+```
 
-- `cd path\to\your\test-project`
-- `npm link medos-sdk-js`
+## Getting Started
 
-### If you still get errors, you can also use the folder path directly:
+### Authentication
 
-`npm install --save-dev c:\harsh\projects\medos\medos-sdk-js`
+The SDK supports two authentication methods:
+
+#### Server-Side (API Key)
+
+Use this method for backend services and server-side rendering.
+
+```javascript
+import { MedosClient } from 'medos-sdk';
+
+await MedosClient.init({
+  apiKey: 'your-api-key',
+  baseURL: 'https://api-dev.medapi.in/v1'
+});
+```
+
+#### Client-Side (Session Token)
+
+Use this method for frontend applications. Obtain the session token from your backend.
+
+```javascript
+import { MedosClient } from 'medos-sdk';
+
+await MedosClient.initWithSession({
+  sessionToken: 'user-session-token',
+  baseURL: 'https://api-dev.medapi.in/v1'
+});
+```
+
+## Usage
+
+### Fetch Clinic Addresses and Doctors
+
+Retrieve all available clinic locations with their associated doctors.
+
+```javascript
+const result = await MedosClient.fetchAllAddressesAndDoctors();
+```
+
+**Response:**
+
+```javascript
+{
+  totalAddresses: 5,
+  totalDoctors: 12,
+  workspaceId: "workspace-123",
+  addresses: [
+    {
+      id: "addr-1",
+      completeAddress: "123 Medical Center, New York, NY 10001",
+      addressLine1: "123 Medical Center",
+      city: "New York",
+      state: "NY",
+      country: "USA",
+      zipcode: "10001",
+      doctors: [
+        {
+          id: "doc-1",
+          name: "Dr. John Smith",
+          email: "john.smith@example.com",
+          specialty: "Cardiology"
+        }
+      ]
+    }
+  ]
+}
+```
+
+### Fetch Available Slots
+
+Get available appointment time slots for a specific doctor.
+
+```javascript
+const slots = await MedosClient.fetchAppointments(
+  'workspace-123',  // workspaceId
+  'addr-1',        // addressId
+  'doc-1',         // doctorId
+  '2025-11-16'     // appointmentDate (YYYY-MM-DD)
+);
+```
+
+**Response:**
+
+```javascript
+[
+  {
+    start: "2025-11-16T10:00:00",
+    end: "2025-11-16T10:30:00",
+    id: "slot-1"
+  },
+  {
+    start: "2025-11-16T11:00:00",
+    end: "2025-11-16T11:30:00",
+    id: "slot-2"
+  }
+]
+```
+
+### Book an Appointment
+
+Create a new appointment booking.
+
+```javascript
+import { AppointmentService } from 'medos-sdk';
+
+const appointment = await AppointmentService.createAppointment({
+  workspaceAddressId: 'addr-1',
+  doctorId: 'doc-1',
+  mode: 'OFFLINE',
+  appointmentDate: '2025-11-16',
+  fromDateTimeTs: '10:00',
+  toDateTimeTs: '10:30',
+  consultationCharge: '100',
+  type: 'CONSULTATION',
+  source: 'SDK_POWERED_WEBSITE',
+  patientPayload: {
+    firstName: 'Jane',
+    lastName: 'Doe',
+    email: 'jane.doe@example.com',
+    countryCode: '+1',
+    phoneNumber: '5551234567',
+    age: 30,
+    gender: 'FEMALE'
+  },
+  patientAddress: {
+    addressLine1: '456 Patient Street',
+    city: 'New York',
+    state: 'NY',
+    country: 'USA',
+    zipcode: '10001',
+    landmark: 'Near Central Park'
+  }
+});
+```
+
+**Optional Fields:**
+
+| Field | Default Value | Description |
+|-------|---------------|-------------|
+| `mode` | `"OFFLINE"` | Consultation mode: `"OFFLINE"` or `"ONLINE"` |
+| `consultationCharge` | `"0"` | Consultation fee as string |
+| `type` | `"CONSULTATION"` | Appointment type |
+| `source` | `"SDK_POWERED_WEBSITE"` | Source identifier |
+
+### Phone Verification
+
+Implement OTP-based phone number verification for patients.
+
+#### Send OTP
+
+```javascript
+await MedosClient.sendPhoneVerificationOtp({
+  countryCode: '+1',
+  phoneNumber: '5551234567'
+});
+```
+
+#### Verify OTP
+
+```javascript
+const result = await MedosClient.verifyPhoneVerificationOtp({
+  countryCode: '+1',
+  phoneNumber: '5551234567',
+  otp: '123456'
+});
+```
+
+## TypeScript
+
+The SDK is written in TypeScript and provides comprehensive type definitions.
+
+```typescript
+import {
+  MedosClient,
+  AppointmentService,
+  BookAppointmentPayload,
+  AddressesResponse,
+  PatientPayload,
+  PatientAddressPayload
+} from 'medos-sdk';
+
+const payload: BookAppointmentPayload = {
+  workspaceAddressId: 'addr-1',
+  doctorId: 'doc-1',
+  appointmentDate: '2025-11-16',
+  fromDateTimeTs: '10:00',
+  toDateTimeTs: '10:30',
+  patientPayload: {
+    firstName: 'John',
+    lastName: 'Doe',
+    countryCode: '+1',
+    phoneNumber: '5551234567'
+  },
+  patientAddress: {
+    addressLine1: '123 Main Street',
+    city: 'New York',
+    state: 'NY',
+    country: 'USA',
+    zipcode: '10001'
+  }
+};
+
+const appointment = await AppointmentService.createAppointment(payload);
+```
+
+### Type Definitions
+
+#### `BookAppointmentPayload`
+
+```typescript
+{
+  workspaceAddressId: string | number;
+  doctorId: string | number;
+  appointmentDate: string;           // Format: "YYYY-MM-DD"
+  fromDateTimeTs: string;            // Format: "HH:MM"
+  toDateTimeTs: string;              // Format: "HH:MM"
+  mode?: "OFFLINE" | "ONLINE";       // Default: "OFFLINE"
+  consultationCharge?: string;       // Default: "0"
+  type?: "CONSULTATION" | string;    // Default: "CONSULTATION"
+  source?: string;                   // Default: "SDK_POWERED_WEBSITE"
+  patientPayload: PatientPayload;
+  patientAddress: PatientAddressPayload;  // Required
+}
+```
+
+#### `PatientPayload`
+
+```typescript
+{
+  firstName: string;
+  lastName: string;
+  countryCode: string;
+  phoneNumber: string;
+  email?: string;
+  age?: number;
+  gender?: "MALE" | "FEMALE" | "OTHER";
+}
+```
+
+#### `PatientAddressPayload`
+
+```typescript
+{
+  addressLine1?: string;
+  city?: string;
+  state?: string;
+  country?: string;
+  zipcode?: string;
+  landmark?: string;
+}
+```
+
+## React Integration
+
+Pre-built appointment calendar component for React applications.
+
+```jsx
+import { AppointmentCalender } from 'medos-sdk';
+
+function BookingPage() {
+  return <AppointmentCalender />;
+}
+```
+
+The component automatically uses the initialized `MedosClient` instance.
+
+## API Reference
+
+### MedosClient
+
+#### `init(config)`
+
+Initialize the SDK with an API key (server-side).
+
+**Parameters:**
+- `config.apiKey` (string, required) - Your Medos API key
+- `config.baseURL` (string, optional) - API base URL. Defaults to dev environment
+
+**Returns:** `Promise<void>`
+
+---
+
+#### `initWithSession(config)`
+
+Initialize the SDK with a session token (client-side).
+
+**Parameters:**
+- `config.sessionToken` (string, required) - Session token
+- `config.baseURL` (string, optional) - API base URL. Defaults to dev environment
+
+**Returns:** `Promise<void>`
+
+---
+
+#### `fetchAllAddressesAndDoctors()`
+
+Fetch all clinic addresses and their associated doctors.
+
+**Returns:** `Promise<AddressesResponse>`
+
+**Response Type:**
+```typescript
+{
+  totalAddresses?: number;
+  totalDoctors?: number;
+  workspaceId?: number | string;
+  addresses: Array<{
+    id: string;
+    completeAddress?: string;
+    addressLine1?: string;
+    city?: string;
+    state?: string;
+    country?: string;
+    zipcode?: string;
+    doctors?: Array<{
+      id: string;
+      name: string;
+      email?: string;
+      specialty?: string;
+    }>;
+  }>;
+}
+```
+
+---
+
+#### `fetchAppointments(workspaceId, addressId, doctorId, appointmentDate)`
+
+Fetch available appointment slots for a specific doctor.
+
+**Parameters:**
+- `workspaceId` (string | number) - Workspace identifier
+- `addressId` (string | number) - Address identifier
+- `doctorId` (string | number) - Doctor identifier
+- `appointmentDate` (string) - Date in YYYY-MM-DD format
+
+**Returns:** `Promise<Slot[]>`
+
+**Response Type:**
+```typescript
+Array<{
+  start: string;  // ISO datetime format
+  end: string;    // ISO datetime format
+  id?: string;
+}>
+```
+
+---
+
+#### `sendPhoneVerificationOtp(payload)`
+
+Send OTP to a phone number for verification.
+
+**Parameters:**
+- `payload.countryCode` (string) - Country code with + prefix (e.g., "+1")
+- `payload.phoneNumber` (string) - Phone number without country code
+
+**Returns:** `Promise<any>`
+
+---
+
+#### `verifyPhoneVerificationOtp(payload)`
+
+Verify OTP for a phone number.
+
+**Parameters:**
+- `payload.countryCode` (string) - Country code with + prefix
+- `payload.phoneNumber` (string) - Phone number without country code
+- `payload.otp` (string) - OTP code received
+
+**Returns:** `Promise<any>`
+
+---
+
+### AppointmentService
+
+#### `createAppointment(payload)`
+
+Create a new appointment booking.
+
+**Parameters:**
+- `payload` (BookAppointmentPayload) - Appointment details
+
+**Returns:** `Promise<any>`
+
+## Error Handling
+
+All SDK methods return Promises and should be wrapped in try-catch blocks.
+
+```javascript
+try {
+  await MedosClient.init({ apiKey: 'your-api-key' });
+  const addresses = await MedosClient.fetchAllAddressesAndDoctors();
+} catch (error) {
+  console.error('Failed to fetch addresses:', error.message);
+}
+```
+
+## Requirements
+
+- **Node.js:** v14 or higher
+- **Browsers:** Modern browsers with ES6+ support
+- **React:** v19 or higher (for React components)
+- **TypeScript:** v5 or higher (optional)
+
+## License
+
+UNLICENSED
+
+## Support
+
+For bug reports and feature requests, please visit our [GitHub Issues](https://github.com/MediLaunch/medos-sdk-react/issues).
+
+## Author
+
+Pooranjoy Bhattacharya
+
+---
+
+*Built for healthcare providers worldwide.*

package/dist/components/AppointmentCalender.js

@@ -300,7 +300,11 @@ export const AppointmentCalender = ({ onError, }) => {
     };
     const submitAppointment = async () => {
         setError(null);
-        if (!selectedDoctor || !selectedSlot || !workspaceId || !selectedAddress) {
+        if (!selectedDoctor ||
+            !selectedSlot ||
+            !workspaceId ||
+            !selectedAddress ||
+            !patientAddress) {
             setError("Please ensure all selections are complete.");
             return;
         }
@@ -323,11 +327,9 @@ export const AppointmentCalender = ({ onError, }) => {
             };
             const fromDateTimeTs = formatTime(startDate);
             const toDateTimeTs = formatTime(endDate);
-            const patientAddressPayload = patientAddress
-                ? {
-                    addressLine1: patientAddress,
-                }
-                : undefined;
+            const patientAddressPayload = {
+                addressLine1: patientAddress,
+            };
             await AppointmentService.createAppointment({
                 workspaceId: workspaceId,
                 workspaceAddressId: selectedAddress,

package/dist/services/AppointmentService.d.ts

@@ -39,7 +39,7 @@ type BookAppointmentPayload = {
     type?: "CONSULTATION" | string;
     source?: string;
     patientPayload: PatientPayload;
-    patientAddress?: PatientAddressPayload;
+    patientAddress: PatientAddressPayload;
     attachments?: File[];
 };
 type AppointmentPayload = {
@@ -54,7 +54,7 @@ type AppointmentPayload = {
     type?: string;
     source?: string;
     patientPayload: PatientPayload;
-    patientAddress?: PatientAddressPayload;
+    patientAddress: PatientAddressPayload;
     attachments?: File[];
 };
 type AddressItem = {

package/dist/services/AppointmentService.js

@@ -73,7 +73,6 @@ const AppointmentService = {
     },
     async createAppointment(payload) {
         const client = await MedosClient.ensureInitialized();
-        const workspaceId = payload.workspaceId;
         const appointmentData = {
             workspaceAddressId: payload.workspaceAddressId,
             doctorId: payload.doctorId,
@@ -87,22 +86,24 @@ const AppointmentService = {
             patientPayload: payload.patientPayload,
             patientAddress: payload.patientAddress,
         };
-        const formData = new FormData();
-        const payloadString = JSON.stringify(appointmentData);
-        formData.append("payload", payloadString);
         if (payload.attachments && payload.attachments.length > 0) {
+            const formData = new FormData();
+            const payloadString = JSON.stringify(appointmentData);
+            formData.append("payload", payloadString);
             payload.attachments.forEach((file) => {
                 formData.append("attachments", file);
             });
+            const res = await client.post("/appointments/book-appointment", formData);
+            return res.data;
         }
-        const config = {
-            headers: {},
-        };
-        if (workspaceId) {
-            config.headers["workspace-id"] = String(workspaceId);
+        else {
+            const res = await client.post("/appointments/book-appointment", appointmentData, {
+                headers: {
+                    "Content-Type": "application/json",
+                },
+            });
+            return res.data;
         }
-        const res = await client.post("/appointments/book-appointment", formData, config);
-        return res.data;
     },
 };
 export { AppointmentService, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "medos-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Medos SDK for managing appointments, meetings, and calendars in apps",
   "homepage": "https://github.com/MediLaunch/medos-sdk-react#readme",
   "bugs": {
@@ -25,11 +25,17 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "axios": "^1.12.2",
-    "react": "^19.2.0"
+    "axios": "^1.12.2"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
   },
   "devDependencies": {
-    "@types/react": "^19.2.3",
+    "@types/react": "^18.0.0",
+    "@types/react-dom": "^18.0.0",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
     "typescript": "^5.9.3"
   },
   "keywords": [