@slotchain/sdk 1.3.0 → 1.5.0

package/src/clients/notices-client.ts

@@ -0,0 +1,52 @@
+import type { AxiosInstance } from 'axios';
+import type { ApiResponse, SlotNotice, ListNoticesOptions } from '../types/api';
+
+/**
+ * NoticesClient — read active slot-scoped operational notices.
+ *
+ * Notices are a product concept (early closure, venue change, general alert)
+ * backed by `slot_moments` internally — the SDK surface reflects the product,
+ * not the storage model. Each notice's attached graphic (if any) is already
+ * resolved to a signed `imageUrl` server-side.
+ *
+ * @example List active notices for a tenant
+ * ```ts
+ * const { data } = await slotly.notices.list({ tenantId });
+ * ```
+ */
+export class NoticesClient {
+  private readonly client: AxiosInstance;
+  private readonly base = '/api/v1/notices';
+
+  constructor(client: AxiosInstance) {
+    this.client = client;
+  }
+
+  /**
+   * List active notices for a tenant.
+   * Returns only notices where visible_until > activeAt (default: now).
+   */
+  async list(options: ListNoticesOptions): Promise<ApiResponse<SlotNotice[]>> {
+    const response = await this.client.get<ApiResponse<SlotNotice[]>>(this.base, {
+      params: {
+        tenant_id: options.tenantId,
+        active_at: options.activeAt,
+        slot_id: options.slotId,
+        types: options.types?.join(','),
+      },
+    });
+    return response.data;
+  }
+
+  /**
+   * Get a single notice by its slot_moment id.
+   */
+  async getById(id: string, tenantId: string): Promise<SlotNotice> {
+    const response = await this.client.get<ApiResponse<SlotNotice>>(`${this.base}/${id}`, {
+      params: { tenant_id: tenantId },
+    });
+    const { data } = response.data;
+    if (!data) throw new Error(`Notice ${id} not found`);
+    return data;
+  }
+}

package/src/clients/slot-client.ts

@@ -1,5 +1,7 @@
 import { AxiosInstance } from 'axios';
 import { ApiResponse, Slot, SlotServiceWithItems, Tenant } from '../types/api';
+// CreateSlotInput and UpdateSlotInput are exported for consumer use but not yet
+// enforced on method signatures — see SLOT_TYPE_UPGRADE_PLAN.md Phase 2.
 
 export class SlotClient {
   constructor(private client: AxiosInstance) {}
@@ -41,11 +43,27 @@ export class SlotClient {
   }
 
   /**
-   * Create a new slot
+   * Create a new slot.
    * POST /api/v1/slots
-   * 
-   * @param data - Slot creation data (tenant_id, name required)
+   *
+   * Accepts any subset of `Slot` fields. For new integrations, prefer the
+   * exported `CreateSlotInput` type which documents the recommended shape
+   * and will become the enforced signature in v2.0 (see SLOT_TYPE_UPGRADE_PLAN.md).
+   *
+   * New fields available as of v1.4:
+   * - `starts_at` — ISO 8601 datetime when the slot opens
+   * - `ends_at`   — ISO 8601 datetime when the slot closes (omit for open-ended slots)
+   * - `metadata`  — term enrichment bag (term_name, season, half_term_start,
+   *                 half_term_end, capacity); see `SlotMetadata` type
+   *
+   * @param data - Slot creation data
    * @returns Created slot
+   *
+   * @example
+   * // Recommended — opt into stricter typing now:
+   * import { CreateSlotInput } from '@slotly/sdk';
+   * const input: CreateSlotInput = { name: 'Autumn Term', tenant_id: '...', starts_at: '...' };
+   * sdk.slots.create(input);
    */
   async create(data: Partial<Slot>): Promise<ApiResponse<Slot>> {
     const response = await this.client.post<ApiResponse<Slot>>(
@@ -56,11 +74,17 @@ export class SlotClient {
   }
 
   /**
-   * Update slot by ID
+   * Update slot by ID.
    * PUT /api/v1/slots/:id
-   * 
-   * @param id - Slot ID
-   * @param data - Slot update data
+   *
+   * Accepts any subset of `Slot` fields. For new integrations, prefer the
+   * exported `UpdateSlotInput` type — it will become the enforced signature
+   * in v2.0 (see SLOT_TYPE_UPGRADE_PLAN.md).
+   *
+   * New fields available as of v1.4: `starts_at`, `ends_at`, `metadata`.
+   *
+   * @param id   - Slot ID
+   * @param data - Fields to update
    * @returns Updated slot
    */
   async update(id: string, data: Partial<Slot>): Promise<ApiResponse<Slot>> {
@@ -92,6 +116,13 @@ export class SlotClient {
    * @param slots - Array of slots to create
    * @returns Created slots
    */
+  /**
+   * Bulk create slots.
+   * POST /api/v1/slots/bulk
+   *
+   * For new integrations, prefer passing `CreateSlotInput[]` — it will become
+   * the enforced signature in v2.0 (see SLOT_TYPE_UPGRADE_PLAN.md).
+   */
   async bulkCreate(slots: Partial<Slot>[]): Promise<ApiResponse<Slot[]>> {
     // Note: Verify if bulk endpoint exists in API
     const response = await this.client.post<ApiResponse<Slot[]>>(
@@ -102,11 +133,14 @@ export class SlotClient {
   }
 
   /**
-   * Mark slot as available/unavailable
-   * Note: Use update() method with status or other fields
+   * Mark slot as available (live) or unavailable (archived).
+   *
+   * Note: previous versions sent 'active'/'inactive' which were not valid DB
+   * enum values. Fixed in v1.4 to use 'live'/'archived' — the only valid
+   * non-draft statuses. If you need 'draft', use update() directly.
    */
   async setAvailability(id: string, available: boolean): Promise<ApiResponse<Slot>> {
-    return this.update(id, { status: available ? 'active' : 'inactive' } as Partial<Slot>);
+    return this.update(id, { status: available ? 'live' : 'archived' });
   }
 
   /**

package/src/index.ts

@@ -11,6 +11,7 @@ import { NotificationClient } from './clients/notification-client';
 import { DataQualityClient } from './clients/data-quality-client';
 import { OrganizationClient } from './clients/organization-client';
 import { DocumentClient } from './clients/document-client';
+import { NoticesClient } from './clients/notices-client';
 import { setupRequestInterceptor, setupResponseInterceptor, setupErrorInterceptor } from './interceptors';
 import { setupRetryInterceptor } from './retry';
 import { SlotlyConfigurationError } from './errors';
@@ -31,6 +32,9 @@ export type {
   ServiceItemWithService,
   Category,
   Slot,
+  SlotMetadata,
+  CreateSlotInput,
+  UpdateSlotInput,
   Customer,
   CustomerIdentity,
   CustomerWithIdentities,
@@ -52,6 +56,9 @@ export type {
   ArtifactMimeCategory,
   ListArtifactsOptions,
   UploadArtifactOptions,
+  SlotNotice,
+  NoticeMomentType,
+  ListNoticesOptions,
 } from './types/api';
 
 // Re-export errors
@@ -120,6 +127,8 @@ export interface SlotlyApi {
   organization: OrganizationClient;
   /** Upload and retrieve file artifacts (CVs, invoices, images) linked to any Slotly entity */
   document: DocumentClient;
+  /** List slot-scoped operational notices (early closure, venue change, general alerts) */
+  notices: NoticesClient;
 }
 
 const defaultBaseURL = typeof process !== 'undefined' && process.env?.SLOTLY_API_URL 
@@ -314,6 +323,7 @@ export const useSlotly = (options: SlotlyClientOptions): SlotlyApi => {
     dataQuality: new DataQualityClient(client),
     organization: new OrganizationClient(client),
     document: new DocumentClient(client),
+    notices: new NoticesClient(client),
   };
 };
 

package/src/types/api.ts

@@ -172,17 +172,85 @@ export interface Service {
   updated_at: string;
 }
 
+/**
+ * Metadata bag for a slot — open-ended key/value store, with well-known
+ * optional fields for childcare / nursery term-based scheduling.
+ */
+export interface SlotMetadata {
+  /** Human-readable term name, e.g. "Autumn Term 2024" */
+  term_name?: string;
+  /** Season identifier, e.g. "autumn" | "spring" | "summer" */
+  season?: string;
+  /** ISO date string for when the half-term break starts */
+  half_term_start?: string;
+  /** ISO date string for when the half-term break ends */
+  half_term_end?: string;
+  /** Maximum number of children / participants in this slot */
+  capacity?: number;
+  /**
+   * Headcount at -2 weeks (used for register generation / staffing).
+   * Negative prefix avoids collision with positive operational fields.
+   */
+  neg_headcount_neg2?: number;
+  /**
+   * Headcount at -3 weeks (used for register generation / staffing).
+   */
+  neg_headcount_neg3?: number;
+  /** Arbitrary additional metadata */
+  [key: string]: unknown;
+}
+
 export interface Slot {
   id: string;
   tenant_id: string;
+  /** Display name / title of the slot */
   name: string;
   description?: string;
   status?: string;
   is_active?: boolean;
+  /**
+   * ISO 8601 datetime when the slot opens (combines start_date + start_time from the DB).
+   * Present when the API serialises scheduled slots.
+   */
+  starts_at?: string;
+  /**
+   * ISO 8601 datetime when the slot closes (combines end_date + end_time from the DB).
+   * Absent for open-ended / on-demand slots.
+   */
+  ends_at?: string;
+  /** Arbitrary metadata bag — see SlotMetadata for well-known keys */
+  metadata?: SlotMetadata;
   created_at: string;
   updated_at: string;
 }
 
+/**
+ * Input shape for creating or updating a slot.
+ * Omits server-generated fields; all scheduling fields optional.
+ */
+export interface CreateSlotInput {
+  name: string;
+  description?: string;
+  tenant_id: string;
+  status?: 'draft' | 'live' | 'archived';
+  /**
+   * ISO 8601 datetime for when the slot opens.
+   * The API splits this into start_date + start_time before persisting.
+   */
+  starts_at?: string;
+  /**
+   * ISO 8601 datetime for when the slot closes.
+   * Omit for on-demand / open-ended slots.
+   */
+  ends_at?: string;
+  metadata?: SlotMetadata;
+}
+
+/**
+ * Partial update shape — all fields optional except id (supplied as path param).
+ */
+export type UpdateSlotInput = Partial<Omit<CreateSlotInput, 'tenant_id'>>;
+
 /**
  * Customer record — matches the `customers` table.
  */
@@ -356,7 +424,7 @@ export interface GetOrganizationOptions {
 /**
  * Artifact / document attached to a customer or booking
  */
-export type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant';
+export type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant' | 'slot_moment';
 
 export type ArtifactMimeCategory = 'pdf' | 'document' | 'image' | 'spreadsheet' | 'video' | 'audio' | 'other';
 
@@ -420,6 +488,53 @@ export interface UploadArtifactOptions {
   metadata?: Record<string, unknown>;
 }
 
+/**
+ * Slot-scoped operational notice (early closure, venue change, general alert).
+ * Backed by a `slot_moment` — see NOTICES_PLAN.md in slotly-admin.
+ */
+export type NoticeMomentType =
+  | 'general_notice'
+  | 'early_closure'
+  | 'closure_notice'
+  | 'venue_change';
+
+export interface SlotNotice {
+  id: string;
+  slotId: string;
+  tenantId: string;
+  momentType: NoticeMomentType;
+  createdAt: string;
+  createdBy: string | null;
+  notice: {
+    type: string;
+    title: string;
+    message: string;
+    /** YYYY-MM-DD — the day the notice applies to */
+    affectedDate: string;
+    /** HH:MM — only present for early_closure notices */
+    closesAt?: string;
+    severity: 'info' | 'warning' | 'urgent';
+    visibleFrom: string;
+    visibleUntil: string;
+    dismissible: boolean;
+    /** Signed URL for the notice's attached graphic, if one was uploaded */
+    imageUrl?: string | null;
+    /** Staff-picked display treatment — 'banner' (compact, stacks) or 'modal' (full-screen, one at a time) */
+    presentation: 'banner' | 'modal';
+  };
+  affectedBookingIds: string[];
+}
+
+export interface ListNoticesOptions {
+  tenantId: string;
+  /** Filter to notices active at this ISO timestamp. Defaults to now. */
+  activeAt?: string;
+  /** Filter to a specific slot */
+  slotId?: string;
+  /** Specific notice types to include. Defaults to all notice types. */
+  types?: NoticeMomentType[];
+}
+
 /**
  * Full tenant configuration including branding, services, and service items
  * Service items are nested within each service object (not as a separate top-level array)