@microboxlabs/miot-calendar-client 0.5.0 → 0.8.0

package/README.md

@@ -122,6 +122,7 @@ Create a new calendar.
 | `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`
 
@@ -176,6 +177,7 @@ Create a time window within a calendar.
 | `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`
 
@@ -529,9 +531,21 @@ interface CalendarRequest {
   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
@@ -546,6 +560,7 @@ interface CalendarResponse {
   createdAt: string;                   // ISO 8601
   updatedAt: string;                   // ISO 8601
   groups?: CalendarGroupResponse[];    // Groups this calendar belongs to
+  filter?: CalendarFilter;             // Optional task filter (origin / destination delegate codes)
 }
 ```
 

package/dist/index.d.mts

@@ -42,6 +42,10 @@ interface CalendarGroupResponse {
     createdAt: string;
     updatedAt: string;
 }
+interface CalendarFilter {
+    origin?: string;
+    destination?: string;
+}
 interface CalendarRequest {
     code: string;
     name: string;
@@ -50,6 +54,7 @@ interface CalendarRequest {
     active?: boolean;
     parallelism?: number;
     groups?: string[];
+    filter?: CalendarFilter;
     autoSlotManager?: boolean;
 }
 interface CalendarResponse {
@@ -63,8 +68,18 @@ interface CalendarResponse {
     createdAt: string;
     updatedAt: string;
     groups?: CalendarGroupResponse[];
+    filter?: CalendarFilter;
     hasSlotManager?: boolean;
 }
+/**
+ * Discriminator for a time window.
+ *
+ * - `WINDOW` — bookable period with a capacity quota (the historical default).
+ * - `BLOCK`  — non-bookable period (holiday, maintenance, manual closure);
+ *   slot generation produces CLOSED slots so the planning UI can paint them
+ *   and the backend rejects bookings against them.
+ */
+type TimeWindowKind = "WINDOW" | "BLOCK";
 interface TimeWindowRequest {
     name: string;
     startHour: number;
@@ -74,6 +89,9 @@ interface TimeWindowRequest {
     daysOfWeek?: string;
     validTo?: string;
     active?: boolean;
+    color?: string;
+    /** Defaults to `WINDOW` server-side when omitted. */
+    kind?: TimeWindowKind;
 }
 interface TimeWindowResponse {
     id: string;
@@ -87,6 +105,8 @@ interface TimeWindowResponse {
     validFrom: string;
     validTo?: string;
     active: boolean;
+    color?: string;
+    kind: TimeWindowKind;
     createdAt: string;
     updatedAt: string;
 }
@@ -245,4 +265,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 TimeWindowKind, type TimeWindowRequest, type TimeWindowResponse, type UpdateSlotStatusRequest, createMiotCalendarClient };

package/dist/index.d.ts

@@ -42,6 +42,10 @@ interface CalendarGroupResponse {
     createdAt: string;
     updatedAt: string;
 }
+interface CalendarFilter {
+    origin?: string;
+    destination?: string;
+}
 interface CalendarRequest {
     code: string;
     name: string;
@@ -50,6 +54,7 @@ interface CalendarRequest {
     active?: boolean;
     parallelism?: number;
     groups?: string[];
+    filter?: CalendarFilter;
     autoSlotManager?: boolean;
 }
 interface CalendarResponse {
@@ -63,8 +68,18 @@ interface CalendarResponse {
     createdAt: string;
     updatedAt: string;
     groups?: CalendarGroupResponse[];
+    filter?: CalendarFilter;
     hasSlotManager?: boolean;
 }
+/**
+ * Discriminator for a time window.
+ *
+ * - `WINDOW` — bookable period with a capacity quota (the historical default).
+ * - `BLOCK`  — non-bookable period (holiday, maintenance, manual closure);
+ *   slot generation produces CLOSED slots so the planning UI can paint them
+ *   and the backend rejects bookings against them.
+ */
+type TimeWindowKind = "WINDOW" | "BLOCK";
 interface TimeWindowRequest {
     name: string;
     startHour: number;
@@ -74,6 +89,9 @@ interface TimeWindowRequest {
     daysOfWeek?: string;
     validTo?: string;
     active?: boolean;
+    color?: string;
+    /** Defaults to `WINDOW` server-side when omitted. */
+    kind?: TimeWindowKind;
 }
 interface TimeWindowResponse {
     id: string;
@@ -87,6 +105,8 @@ interface TimeWindowResponse {
     validFrom: string;
     validTo?: string;
     active: boolean;
+    color?: string;
+    kind: TimeWindowKind;
     createdAt: string;
     updatedAt: string;
 }
@@ -245,4 +265,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 TimeWindowKind, type TimeWindowRequest, type TimeWindowResponse, type UpdateSlotStatusRequest, createMiotCalendarClient };

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@microboxlabs/miot-calendar-client",
-  "version": "0.5.0",
+  "version": "0.8.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": {