@blazeo.com/calendar-client 1.0.5 → 1.0.6

package/README.md

@@ -1,54 +1,54 @@
-# @blazeo.com/calendar-client
-
-**Private package** – for Blazeo internal teams only. JavaScript client for the Blazeo Calendar / Appointment API. Use it in React (or any JS app) to call calendar and event endpoints via 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
-
-Configure once at app startup, then use models and their methods:
-
-```js
-import { configure, setBaseUrl, setConsumer, CalendarModel, createRootStore } from '@blazeo.com/calendar-client';
-
-configure({ baseUrl: 'https://your-appointment-api.example.com' });
-// or: setBaseUrl('https://localhost:7051');
-setConsumer('my-app');  // optional: sent as Consumer header (e.g. for lead source)
-
-// Calendar static methods (no store needed)
-const timezones = await CalendarModel.getTimeZones();
-const calendar = await CalendarModel.get('calendar-guid');
-
-// Or use RootStore with models
-const store = createRootStore();
-const cal = store.addCalendar({ calendarId: 'my-cal', name: 'My Calendar' });
-await cal.create(); // POST to backend
-```
-
-## API overview
-
-- **CalendarModel (static):** `get`, `getByCompany`, `getTimeZones`, `getTimeZone`, `getParticipants`, `getMonth`, `getEvents`, etc.
-- **EventModel (instance):** `get`, `create`, `cancel`, `getCancellable`, `getAvailability`, `setReminder`
-- **FlowModel:** Same pattern as Calendar — `FlowModel.create({}, { env })` with no fields; static `get`, `getRaw`, `list`, `createFlow`, `updateFlow`, `delete`, `duplicate`, appearance/embed/public/preview helpers; instance methods mirror those using `flowId` on the snapshot
-- **LeadModel:** `LeadModel.create({}, { env })`; static `get`, `getRaw`, `getByEmail`, `getByCompany`; instance `get`, `getByEmail`, `getByCompany` (uses `leadId` / `email` / `companyKey` on the snapshot)
-- **RootStore:** `addCalendar`, `addEvent`
-
-All methods return `Promise<{ status, data?, message? }>`. Check `response.status === 'success'` and use `response.data`.
-
-## Samples
-
-- **`sample/`** – Uses the package via `file:..` for local development (run `npm run build` in parent first).
-- **`sample-npm/`** – Uses the package from npm: `npm i @blazeo.com/calendar-client`. For testing the published package.
+# @blazeo.com/calendar-client
+
+**Private package** – for Blazeo internal teams only. JavaScript client for the Blazeo Calendar / Appointment API. Use it in React (or any JS app) to call calendar and event endpoints via 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
+
+Configure once at app startup, then use models and their methods:
+
+```js
+import { configure, setBaseUrl, setConsumer, CalendarModel, createRootStore } from '@blazeo.com/calendar-client';
+
+configure({ baseUrl: 'https://your-appointment-api.example.com' });
+// or: setBaseUrl('https://localhost:7051');
+setConsumer('my-app');  // optional: sent as Consumer header (e.g. for lead source)
+
+// Calendar static methods (no store needed)
+const timezones = await CalendarModel.getTimeZones();
+const calendar = await CalendarModel.get('calendar-guid');
+
+// Or use RootStore with models
+const store = createRootStore();
+const cal = store.addCalendar({ calendarId: 'my-cal', name: 'My Calendar' });
+await cal.create(); // POST to backend
+```
+
+## API overview
+
+- **CalendarModel (static):** `get`, `getByCompany`, `getTimeZones`, `getTimeZone`, `getParticipants`, `getMonth`, `getEvents`, etc.
+- **EventModel (instance):** `get`, `create`, `cancel`, `getCancellable`, `getAvailability`, `setReminder`
+- **FlowModel:** Same pattern as Calendar — `FlowModel.create({}, { env })` with no fields; static `get`, `getRaw`, `list`, `createFlow`, `updateFlow`, `delete`, `duplicate`, appearance/embed/public/preview helpers; instance methods mirror those using `flowId` on the snapshot
+- **LeadModel:** `LeadModel.create({}, { env })`; static `get`, `getRaw`, `getByEmail`, `getByCompany`; instance `get`, `getByEmail`, `getByCompany` (uses `leadId` / `email` / `companyKey` on the snapshot)
+- **RootStore:** `addCalendar`, `addEvent`
+
+All methods return `Promise<{ status, data?, message? }>`. Check `response.status === 'success'` and use `response.data`.
+
+## Samples
+
+- **`sample/`** – Uses the package via `file:..` for local development (run `npm run build` in parent first).
+- **`sample-npm/`** – Uses the package from npm: `npm i @blazeo.com/calendar-client`. For testing the published package.

package/dist/index.d.ts

@@ -1,129 +1,140 @@
-/** @blazeo.com/calendar-client - type declarations */
-
-export function configure(env: { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number }): void;
-export function getConfig(): { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number } | null;
-export function setBaseUrl(baseUrl: string): void;
-export function setConsumer(consumer: string): void;
-export function getConfigStore(): unknown;
-
-export const ConfigModel: unknown;
-
-export const CalendarModel: {
-  get(calendarId: string): Promise<unknown>;
-  getRaw(calendarId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  getByCompany(companyKey: string): Promise<unknown[]>;
-  getTimeZones(): Promise<unknown>;
-  getTimeZone(timezoneId: string): Promise<unknown>;
-  getParticipants(calendarId: string): Promise<unknown>;
-  getCalendarParticipant(calendarId: string): Promise<unknown>;
-  getParticipantsInfo(calendarId: string): Promise<unknown>;
-  getMonth(calendarId: string, year: number, month: number): Promise<unknown>;
-  getEvents(calendarId: string): Promise<unknown>;
-  createWithParticipants(name: string, companyKey: string, participantIds: string[], description: string, calendarId?: string): Promise<unknown>;
-  editWithParticipants(calendarId: string, name: string, participantIds: string[], description: string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-
-export const EventModel: {
-  get(eventId: string): Promise<unknown>;
-  getByExternalId(externalEventId: string): Promise<unknown>;
-  getRoundRobinParticipant(calendarId: string): Promise<unknown>;
-  getEarliestAvailableDays(calendarId: string, count: number, opts?: { year?: number; month?: number; day?: number; offset?: number }): Promise<string[] | null>;
-  getDaySelectable(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<boolean>;
-  getByVisitorEmail(email: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
-  getByVisitorPhone(phone: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
-  getAvailability(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<unknown[]>;
-  cancel(eventId: string): Promise<unknown>;
-  getCancellable(eventId: string): Promise<boolean>;
-  createEvent(payload: object, offsetMinutes?: number): Promise<unknown>;
-  reschedule(payload: object, offsetMinutes?: number): Promise<unknown>;
-  updateEvent(payload: object): Promise<unknown>;
-  createTest(payload: object, offsetMinutes?: number): Promise<unknown>;
-  getCustomData(calendarId: string, eventId?: string): Promise<unknown>;
-  setReminder(eventId: string): Promise<unknown>;
-  setAttendeeStatus(eventId: string, attendeeStatus: number | string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-
-export const AvailabilityModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const AvailabilityDetailModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const CalendarParticipantModel: {
-  getByCalendar(calendarId: string): Promise<unknown[] | null>;
-  getInfoByCalendar(calendarId: string): Promise<unknown[] | null>;
-  getByParticipant(participantId: string): Promise<unknown[] | null>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const ParticipantModel: {
-  get(participantId: string): Promise<unknown>;
-  getByIds(participantIds: string[] | string): Promise<unknown[] | null>;
-  getAll(companyKey: string): Promise<unknown[] | null>;
-  add(payload: object, calendarId?: string): Promise<unknown>;
-  remove(participantId: string): Promise<unknown>;
-  update(payload: object): Promise<unknown>;
-  save(payload: object): Promise<unknown>;
-  sendEmail(participantId: string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const OpeningHourModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const TimeSlotModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const TimeFrameModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const SettingModel: {
-  get(calendarId: string): Promise<unknown>;
-  save(payload: object): Promise<unknown>;
-  uploadLogo(calendarId: string, file: File | Blob): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const CompanyModel: {
-  get(companyKey: string): Promise<unknown>;
-  getAll(): Promise<unknown[] | null>;
-  save(payload: object): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const CalendarDayModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const ParticipantInfoModel: { create(snapshot: object, options?: { env?: object }): unknown };
-export const PreferenceModel: {
-  getScopes(): Promise<string[] | null>;
-  getOptions(): Promise<string[] | null>;
-  getOptionTemplate(option: string): Promise<unknown>;
-  get(option: string, keys: string | string[]): Promise<unknown>;
-  set(scope: string, key: string, option: string, body: string | object): Promise<unknown>;
-  delete(preferenceId: string): Promise<unknown>;
-  create(snapshot: object, options?: { env?: object }): unknown;
-};
-export const PreferenceScope: Record<string, number>;
-
-export const FlowModel: {
-  getRaw(flowId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  list(companyKey: string, includeDeleted?: boolean): Promise<unknown[] | null>;
-  get(flowId: string): Promise<unknown>;
-  createFlow(payload: object): Promise<unknown>;
-  updateFlow(payload: object): Promise<unknown>;
-  delete(flowId: string): Promise<unknown>;
-  duplicate(flowId: string, newName?: string): Promise<unknown>;
-  getAppearance(flowId: string): Promise<unknown>;
-  saveAppearance(payload: object): Promise<unknown>;
-  getEmbed(flowId: string): Promise<unknown>;
-  saveEmbed(payload: object): Promise<unknown>;
-  getPublic(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
-  getPreview(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
-  /** Empty snapshot is valid: `FlowModel.create({}, { env })` after configure() */
-  create(snapshot?: object, options?: { env?: object }): unknown;
-};
-
-export const LeadModel: {
-  getRaw(leadId: string): Promise<{ status: string; data?: unknown; message?: string }>;
-  get(leadId: string): Promise<unknown>;
-  getByEmail(email: string, companyKey: string): Promise<unknown>;
-  getByCompany(companyKey: string, opts?: { skip?: number; take?: number }): Promise<unknown[] | null>;
-  /** Empty snapshot is valid: `LeadModel.create({}, { env })` after configure() */
-  create(snapshot?: object, options?: { env?: object }): unknown;
-};
-
-export const RootStore: unknown;
-export function createRootStore(initialState?: object): unknown;
-
-export const Unit: Record<string, number>;
-export const AssignmentMethod: Record<string, number>;
-export const AttendeeStatus: Record<string, number>;
-export const RecurringFrequency: Record<string, number>;
-export const DayOfWeek: Record<string, number>;
+/** @blazeo.com/calendar-client - type declarations */
+
+export function configure(env: { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number }): void;
+export function getConfig(): { baseUrl?: string; consumer?: string; fetch?: typeof fetch; getDefaultOffset?: () => number } | null;
+export function setBaseUrl(baseUrl: string): void;
+export function setConsumer(consumer: string): void;
+export function getConfigStore(): unknown;
+
+export const ConfigModel: unknown;
+
+export const CalendarModel: {
+  get(calendarId: string): Promise<unknown>;
+  getRaw(calendarId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  getByCompany(companyKey: string): Promise<unknown[]>;
+  getTimeZones(): Promise<unknown>;
+  getTimeZone(timezoneId: string): Promise<unknown>;
+  getParticipants(calendarId: string): Promise<unknown>;
+  getCalendarParticipant(calendarId: string): Promise<unknown>;
+  getParticipantsInfo(calendarId: string): Promise<unknown>;
+  getMonth(calendarId: string, year: number, month: number): Promise<unknown>;
+  getEvents(calendarId: string): Promise<unknown>;
+  createWithParticipants(name: string, companyKey: string, participantIds: string[], description: string, calendarId?: string): Promise<unknown>;
+  editWithParticipants(calendarId: string, name: string, participantIds: string[], description: string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+
+export const EventModel: {
+  get(eventId: string): Promise<unknown>;
+  getByExternalId(externalEventId: string): Promise<unknown>;
+  getRoundRobinParticipant(calendarId: string): Promise<unknown>;
+  getEarliestAvailableDays(calendarId: string, count: number, opts?: { year?: number; month?: number; day?: number; offset?: number }): Promise<string[] | null>;
+  getDaySelectable(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<boolean>;
+  getByVisitorEmail(email: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
+  getByVisitorPhone(phone: string, opts: { companyKey?: string; calendarId?: string; offset?: number }): Promise<unknown[] | null>;
+  getAvailability(calendarId: string, year: number, month: number, day: number, opts?: { participantId?: string; offset?: number }): Promise<unknown[]>;
+  cancel(eventId: string): Promise<unknown>;
+  getCancellable(eventId: string): Promise<boolean>;
+  createEvent(payload: object, offsetMinutes?: number): Promise<unknown>;
+  reschedule(payload: object, offsetMinutes?: number): Promise<unknown>;
+  updateEvent(payload: object): Promise<unknown>;
+  createTest(payload: object, offsetMinutes?: number): Promise<unknown>;
+  getCustomData(calendarId: string, eventId?: string): Promise<unknown>;
+  setReminder(eventId: string): Promise<unknown>;
+  setAttendeeStatus(eventId: string, attendeeStatus: number | string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+
+export const AvailabilityModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const AvailabilityDetailModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const CalendarParticipantModel: {
+  getByCalendar(calendarId: string): Promise<unknown[] | null>;
+  getInfoByCalendar(calendarId: string): Promise<unknown[] | null>;
+  getByParticipant(participantId: string): Promise<unknown[] | null>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const ParticipantModel: {
+  get(participantId: string): Promise<unknown>;
+  getByIds(participantIds: string[] | string): Promise<unknown[] | null>;
+  getAll(companyKey: string): Promise<unknown[] | null>;
+  add(payload: object, calendarId?: string): Promise<unknown>;
+  remove(participantId: string): Promise<unknown>;
+  update(payload: object): Promise<unknown>;
+  save(payload: object): Promise<unknown>;
+  sendEmail(participantId: string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const OpeningHourModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const TimeSlotModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const TimeFrameModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const SettingModel: {
+  get(calendarId: string): Promise<unknown>;
+  save(payload: object): Promise<unknown>;
+  uploadLogo(calendarId: string, file: File | Blob): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const CompanyModel: {
+  get(companyKey: string): Promise<unknown>;
+  getAll(): Promise<unknown[] | null>;
+  save(payload: object): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const CalendarDayModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const ParticipantInfoModel: { create(snapshot: object, options?: { env?: object }): unknown };
+export const PreferenceModel: {
+  getScopes(): Promise<string[] | null>;
+  getOptions(): Promise<string[] | null>;
+  getOptionTemplate(option: string): Promise<unknown>;
+  get(option: string, keys: string | string[]): Promise<unknown>;
+  set(scope: string, key: string, option: string, body: string | object): Promise<unknown>;
+  delete(preferenceId: string): Promise<unknown>;
+  create(snapshot: object, options?: { env?: object }): unknown;
+};
+export const PreferenceScope: Record<string, number>;
+
+export const FlowModel: {
+  getRaw(flowId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  list(companyKey: string, includeDeleted?: boolean): Promise<unknown[] | null>;
+  get(flowId: string): Promise<unknown>;
+  createFlow(payload: object): Promise<unknown>;
+  updateFlow(payload: object): Promise<unknown>;
+  delete(flowId: string): Promise<unknown>;
+  duplicate(flowId: string, newName?: string): Promise<unknown>;
+  getAppearance(flowId: string): Promise<unknown>;
+  saveAppearance(payload: object): Promise<unknown>;
+  getEmbed(flowId: string): Promise<unknown>;
+  saveEmbed(payload: object): Promise<unknown>;
+  getPublic(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
+  getPreview(flowId: string): Promise<{ flow: unknown; appearance: unknown; embed: unknown } | null>;
+  /** Empty snapshot is valid: `FlowModel.create({}, { env })` after configure() */
+  create(snapshot?: object, options?: { env?: object }): unknown;
+};
+
+export const LeadModel: {
+  getRaw(leadId: string): Promise<{ status: string; data?: unknown; message?: string }>;
+  get(leadId: string): Promise<unknown>;
+  getByEmail(email: string, companyKey: string): Promise<unknown>;
+  getByCompany(
+    companyKey: string,
+    opts?: {
+      skip?: number;
+      take?: number;
+      sort?: string;
+      sort_column?: string;
+      sort_dir?: 'asc' | 'desc';
+      page?: number;
+      page_size?: number;
+    }
+  ): Promise<unknown[] | null>;
+  /** Empty snapshot is valid: `LeadModel.create({}, { env })` after configure() */
+  create(snapshot?: object, options?: { env?: object }): unknown;
+};
+
+export const RootStore: unknown;
+export function createRootStore(initialState?: object): unknown;
+
+export const Unit: Record<string, number>;
+export const AssignmentMethod: Record<string, number>;
+export const AttendeeStatus: Record<string, number>;
+export const RecurringFrequency: Record<string, number>;
+export const DayOfWeek: Record<string, number>;

package/dist/index.js

@@ -1826,6 +1826,11 @@ LeadModel.getByCompany = async (companyKey, opts = {}) => {
   const query = { company_key: companyKey };
   if (opts.skip != null) query.skip = opts.skip;
   if (opts.take != null) query.take = opts.take;
+  const sortCol = opts.sort ?? opts.sort_column;
+  if (sortCol != null && sortCol !== "") query.sort = sortCol;
+  if (opts.sort_dir != null) query.sort_dir = opts.sort_dir;
+  if (opts.page != null) query.page = opts.page;
+  if (opts.page_size != null) query.page_size = opts.page_size;
   const res = await reqGet("/lead/company/get", query);
   if (res.status === "success" && Array.isArray(res.data)) {
     return res.data.map((l) => LeadModel.create(mapLeadFromApi(l), { env: getConfig() }));

package/dist/index.mjs

@@ -1773,6 +1773,11 @@ LeadModel.getByCompany = async (companyKey, opts = {}) => {
   const query = { company_key: companyKey };
   if (opts.skip != null) query.skip = opts.skip;
   if (opts.take != null) query.take = opts.take;
+  const sortCol = opts.sort ?? opts.sort_column;
+  if (sortCol != null && sortCol !== "") query.sort = sortCol;
+  if (opts.sort_dir != null) query.sort_dir = opts.sort_dir;
+  if (opts.page != null) query.page = opts.page;
+  if (opts.page_size != null) query.page_size = opts.page_size;
   const res = await reqGet("/lead/company/get", query);
   if (res.status === "success" && Array.isArray(res.data)) {
     return res.data.map((l) => LeadModel.create(mapLeadFromApi(l), { env: getConfig() }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blazeo.com/calendar-client",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Blazeo Calendar / Appointment API client with MobX State Tree models",
   "exports": {
     ".": {