@blazeo.com/calendar-client 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,79 @@
+# @blazeo.com/calendar-client
+
+**Private package** – for Blazeo internal teams only. TypeScript/JavaScript client for the Blazeo Calendar / Appointment API. Use it in React (or any JS app) to call calendar and event endpoints, with optional MobX State Tree models.
+
+## Install
+
+From your npm registry (internal teams; ensure you're logged in to the scope):
+
+```bash
+npm install @blazeo.com/calendar-client
+```
+
+Or link locally:
+
+```bash
+cd calendar-client && npm run build && npm link
+cd your-app && npm link @blazeo.com/calendar-client
+```
+
+## Usage
+
+```ts
+import { AppointmentClient } from '@blazeo.com/calendar-client';
+
+const client = new AppointmentClient({
+  baseUrl: 'https://your-appointment-api.example.com',
+  getDefaultOffset: () => new Date().getTimezoneOffset(), // optional
+});
+
+// Get calendar
+const cal = await client.getCalendar('calendar-guid');
+if (cal.status === 'success' && cal.data) {
+  console.log(cal.data.name);
+}
+
+// Get availability for a day (optional participant_id)
+const slots = await client.getAvailability({
+  calendarId: 'calendar-guid',
+  participantId: 'participant-guid', // optional
+  year: 2026,
+  month: 2,
+  day: 15,
+  offset: new Date().getTimezoneOffset(),
+});
+
+// Create event (flexible input – snake_case or camelCase)
+const created = await client.createEvent({
+  calendarId: 'calendar-guid',
+  visitor_email: 'visitor@example.com',
+  visitor_name: 'Jane',
+  start_date: '2026-02-15',
+  startTime: '14:30',
+}, new Date().getTimezoneOffset());
+```
+
+## MobX State Tree models
+
+The package also exports MST models (`CalendarModel`, `EventModel`, `RootStore`, etc.). Create a store with your API client in env:
+
+```ts
+import { AppointmentClient, RootStore } from '@blazeo.com/calendar-client';
+
+const api = new AppointmentClient({ baseUrl: 'https://...' });
+const store = RootStore.create({}, { env: { api } });
+
+const cal = store.addCalendar({ calendarId: 'my-cal', name: 'My Calendar' });
+await cal.create(); // POST to backend
+```
+
+## API overview
+
+- **Event:** `getEvent`, `getAvailability`, `getDaySelectable`, `getEarliestAvailableDays`, `getExistingEventsByVisitorEmail`, `getExistingEventsByVisitorPhone`, `createEvent`, `cancelEvent`, `getCancellable`, `getRoundRobinParticipant`, `setAttendeeStatus`, `setEventReminder`
+- **Calendar:** `getCalendar`, `createCalendar`, `removeCalendar`, `getCalendarsByCompany`, `getTimeZones`, `getTimeZone`
+
+All methods return `Promise<ApiResponse<T>>`. Check `response.status === 'success'` and use `response.data`. On failure, `response.message` contains the error.
+
+## Sample
+
+See the `sample` folder for a minimal React app that uses this package.