@microboxlabs/miot-calendar-client 0.4.1 → 0.7.0

package/README.md

@@ -29,15 +29,14 @@ const calendar = await client.calendars.create({
   timezone: "America/New_York", // defaults to "UTC" if omitted
 });
 
-// 2. Add a time window (Mon–Fri, 8 AM – 5 PM, 30-min slots)
+// 2. Add a time window (Mon–Fri, 8 AM – 5 PM)
 const timeWindow = await client.calendars.createTimeWindow(calendar.id, {
   name: "Business Hours",
   startHour: 8,
   endHour: 17,
   validFrom: "2026-03-01",
   daysOfWeek: "1,2,3,4,5",        // Mon–Fri
-  slotDurationMinutes: 30,         // default: 30
-  capacityPerSlot: 2,              // default: 1
+  capacity: 2,                     // default: 1
 });
 
 // 3. Generate slots for the first two weeks
@@ -121,7 +120,9 @@ Create a new calendar.
 | `description` | `string` | No | — | Optional description |
 | `timezone` | `string` | No | `"UTC"` | IANA timezone |
 | `active` | `boolean` | No | `true` | Whether the calendar is active |
+| `parallelism` | `number` | No | `1` | Parallel resources per slot (e.g. loading docks) |
 | `groups` | `string[]` | No | — | Group codes to assign. `null` = no change; `[]` = remove all; `["code"]` = replace all |
+| `filter` | [`CalendarFilter`](#calendarfilter) | No | — | Task filter map (`origin?`, `destination?`). `null` = no change; `{}` = clear; populated = replace |
 
 **Returns:** `CalendarResponse`
 
@@ -173,10 +174,10 @@ Create a time window within a calendar.
 | `endHour` | `number` | Yes | — | End hour (0–23, must be > startHour) |
 | `validFrom` | `string` | Yes | — | Start date (`YYYY-MM-DD`) |
 | `validTo` | `string` | No | — | End date (`YYYY-MM-DD`) |
-| `slotDurationMinutes` | `number` | No | `30` | Slot duration in minutes |
-| `capacityPerSlot` | `number` | No | `1` | Max bookings per slot |
+| `capacity` | `number` | No | `1` | Total number of services this window can handle across all slots |
 | `daysOfWeek` | `string` | No | — | Comma-separated days (1=Mon … 7=Sun) |
 | `active` | `boolean` | No | `true` | Whether the time window is active |
+| `color` | `string` | No | — | UI color token (e.g., `"emerald"`, `"amber"`) |
 
 **Returns:** `TimeWindowResponse`
 
@@ -528,10 +529,23 @@ interface CalendarRequest {
   description?: string;   // Optional description
   timezone?: string;      // IANA timezone (default: "UTC")
   active?: boolean;       // Active status (default: true)
+  parallelism?: number;   // Parallel resources per slot (default: 1, e.g. loading docks)
   groups?: string[];      // Group codes to assign. null = no change; [] = remove all; ["code"] = replace all
+  filter?: CalendarFilter; // Optional task filter. null = no change; {} = clear; populated = replace
 }
 ```
 
+### `CalendarFilter`
+
+```ts
+interface CalendarFilter {
+  origin?: string;        // Origin delegate code (e.g., "ANF")
+  destination?: string;   // Destination delegate code
+}
+```
+
+Optional map persisted on a calendar so client UIs can constrain task lists tied to that calendar. Both keys are optional; when both are set, the backend AND-combines them.
+
 ### `CalendarResponse`
 
 ```ts
@@ -542,9 +556,11 @@ interface CalendarResponse {
   description?: string;
   timezone: string;                    // Always present (default: "UTC")
   active: boolean;                     // Always present (default: true)
+  parallelism: number;                 // Parallel resources per slot (min: 1)
   createdAt: string;                   // ISO 8601
   updatedAt: string;                   // ISO 8601
   groups?: CalendarGroupResponse[];    // Groups this calendar belongs to
+  filter?: CalendarFilter;             // Optional task filter (origin / destination delegate codes)
 }
 ```
 
@@ -557,8 +573,7 @@ interface TimeWindowRequest {
   endHour: number;              // 0–23 (must be > startHour)
   validFrom: string;            // YYYY-MM-DD
   validTo?: string;             // YYYY-MM-DD
-  slotDurationMinutes?: number; // Default: 30
-  capacityPerSlot?: number;     // Default: 1
+  capacity?: number;            // Default: 1 — total services this window can handle
   daysOfWeek?: string;          // Comma-separated: "1,2,3,4,5" (1=Mon, 7=Sun)
   active?: boolean;             // Default: true
 }
@@ -573,8 +588,8 @@ interface TimeWindowResponse {
   name: string;
   startHour: number;
   endHour: number;
-  slotDurationMinutes: number;  // Always present (default: 30)
-  capacityPerSlot: number;      // Always present (default: 1)
+  slotDurationMinutes: number;  // Read-only, derived from capacity model
+  capacity: number;             // Total services this window can handle
   daysOfWeek: string;
   validFrom: string;
   validTo?: string;

package/dist/index.d.mts

@@ -42,13 +42,19 @@ interface CalendarGroupResponse {
     createdAt: string;
     updatedAt: string;
 }
+interface CalendarFilter {
+    origin?: string;
+    destination?: string;
+}
 interface CalendarRequest {
     code: string;
     name: string;
     description?: string;
     timezone?: string;
     active?: boolean;
+    parallelism?: number;
     groups?: string[];
+    filter?: CalendarFilter;
     autoSlotManager?: boolean;
 }
 interface CalendarResponse {
@@ -58,9 +64,11 @@ interface CalendarResponse {
     description?: string;
     timezone: string;
     active: boolean;
+    parallelism: number;
     createdAt: string;
     updatedAt: string;
     groups?: CalendarGroupResponse[];
+    filter?: CalendarFilter;
     hasSlotManager?: boolean;
 }
 interface TimeWindowRequest {
@@ -68,11 +76,11 @@ interface TimeWindowRequest {
     startHour: number;
     endHour: number;
     validFrom: string;
-    slotDurationMinutes?: number;
-    capacityPerSlot?: number;
+    capacity?: number;
     daysOfWeek?: string;
     validTo?: string;
     active?: boolean;
+    color?: string;
 }
 interface TimeWindowResponse {
     id: string;
@@ -81,11 +89,12 @@ interface TimeWindowResponse {
     startHour: number;
     endHour: number;
     slotDurationMinutes: number;
-    capacityPerSlot: number;
+    capacity: number;
     daysOfWeek: string;
     validFrom: string;
     validTo?: string;
     active: boolean;
+    color?: string;
     createdAt: string;
     updatedAt: string;
 }
@@ -244,4 +253,4 @@ declare class MiotCalendarApiError extends Error {
     constructor(status: number, body: ErrorResponse | string);
 }
 
-export { type BookingListResponse, type BookingRequest, type BookingResponse, type CalendarGroupRequest, type CalendarGroupResponse, type CalendarRequest, type CalendarResponse, type ClientConfig, type ErrorResponse, type GenerateSlotsRequest, type GenerateSlotsResponse, MiotCalendarApiError, type ResourceData, type SlotData, type SlotListResponse, type SlotManagerRequest, type SlotManagerResponse, type SlotManagerRunResponse, type SlotResponse, type SlotStatus, type TimeWindowRequest, type TimeWindowResponse, type UpdateSlotStatusRequest, createMiotCalendarClient };
+export { type BookingListResponse, type BookingRequest, type BookingResponse, type CalendarFilter, type CalendarGroupRequest, type CalendarGroupResponse, type CalendarRequest, type CalendarResponse, type ClientConfig, type ErrorResponse, type GenerateSlotsRequest, type GenerateSlotsResponse, MiotCalendarApiError, type ResourceData, type SlotData, type SlotListResponse, type SlotManagerRequest, type SlotManagerResponse, type SlotManagerRunResponse, type SlotResponse, type SlotStatus, type TimeWindowRequest, type TimeWindowResponse, type UpdateSlotStatusRequest, createMiotCalendarClient };

package/dist/index.d.ts

@@ -42,13 +42,19 @@ interface CalendarGroupResponse {
     createdAt: string;
     updatedAt: string;
 }
+interface CalendarFilter {
+    origin?: string;
+    destination?: string;
+}
 interface CalendarRequest {
     code: string;
     name: string;
     description?: string;
     timezone?: string;
     active?: boolean;
+    parallelism?: number;
     groups?: string[];
+    filter?: CalendarFilter;
     autoSlotManager?: boolean;
 }
 interface CalendarResponse {
@@ -58,9 +64,11 @@ interface CalendarResponse {
     description?: string;
     timezone: string;
     active: boolean;
+    parallelism: number;
     createdAt: string;
     updatedAt: string;
     groups?: CalendarGroupResponse[];
+    filter?: CalendarFilter;
     hasSlotManager?: boolean;
 }
 interface TimeWindowRequest {
@@ -68,11 +76,11 @@ interface TimeWindowRequest {
     startHour: number;
     endHour: number;
     validFrom: string;
-    slotDurationMinutes?: number;
-    capacityPerSlot?: number;
+    capacity?: number;
     daysOfWeek?: string;
     validTo?: string;
     active?: boolean;
+    color?: string;
 }
 interface TimeWindowResponse {
     id: string;
@@ -81,11 +89,12 @@ interface TimeWindowResponse {
     startHour: number;
     endHour: number;
     slotDurationMinutes: number;
-    capacityPerSlot: number;
+    capacity: number;
     daysOfWeek: string;
     validFrom: string;
     validTo?: string;
     active: boolean;
+    color?: string;
     createdAt: string;
     updatedAt: string;
 }
@@ -244,4 +253,4 @@ declare class MiotCalendarApiError extends Error {
     constructor(status: number, body: ErrorResponse | string);
 }
 
-export { type BookingListResponse, type BookingRequest, type BookingResponse, type CalendarGroupRequest, type CalendarGroupResponse, type CalendarRequest, type CalendarResponse, type ClientConfig, type ErrorResponse, type GenerateSlotsRequest, type GenerateSlotsResponse, MiotCalendarApiError, type ResourceData, type SlotData, type SlotListResponse, type SlotManagerRequest, type SlotManagerResponse, type SlotManagerRunResponse, type SlotResponse, type SlotStatus, type TimeWindowRequest, type TimeWindowResponse, type UpdateSlotStatusRequest, createMiotCalendarClient };
+export { type BookingListResponse, type BookingRequest, type BookingResponse, type CalendarFilter, type CalendarGroupRequest, type CalendarGroupResponse, type CalendarRequest, type CalendarResponse, type ClientConfig, type ErrorResponse, type GenerateSlotsRequest, type GenerateSlotsResponse, MiotCalendarApiError, type ResourceData, type SlotData, type SlotListResponse, type SlotManagerRequest, type SlotManagerResponse, type SlotManagerRunResponse, type SlotResponse, type SlotStatus, type TimeWindowRequest, type TimeWindowResponse, type UpdateSlotStatusRequest, createMiotCalendarClient };

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@microboxlabs/miot-calendar-client",
-  "version": "0.4.1",
+  "version": "0.7.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/microboxlabs/modulariot",
     "directory": "packages/miot-calendar-client"
   },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": {