@slotchain/sdk 1.1.3 → 1.2.0

package/src/types/api.ts

@@ -59,23 +59,35 @@ export interface TenantBranding {
  */
 export interface ServiceItem {
   id: string;
-  serviceId: string;
+  service_id: string;
   name: string;
   description?: string;
   price?: number;
   duration?: number;
-  available?: boolean;
-  // TODO: Add actual service item properties
+  is_available?: boolean;
+  sort_order?: number;
+  created_at: string;
+  updated_at: string;
 }
 
 /**
- * Enhanced Service type with nested service items
+ * Enhanced Service type with nested service items (for tenant endpoint)
+ * Uses 'serviceItems' property name
  */
 export interface ServiceWithItems extends Service {
   /** Array of service items nested within this service (optional, may be empty array) */
   serviceItems?: ServiceItem[];
 }
 
+/**
+ * Service with items for slot endpoint
+ * Uses 'items' property name (different from tenant endpoint)
+ */
+export interface SlotServiceWithItems extends Service {
+  /** Array of service items nested within this service (always included for slot endpoint) */
+  items: ServiceItem[];
+}
+
 /**
  * Service item with parent service reference
  */
@@ -148,12 +160,16 @@ export interface ListBookingsOptions {
 
 export interface Service {
   id: string;
-  tenantId: string;
+  tenant_id: string;
+  slot_id?: string; // Present but not used in queries
   name: string;
   description?: string;
+  category?: string;
+  is_active?: boolean;
   duration?: number;
   price?: number;
-  // TODO: Add actual service properties
+  created_at: string;
+  updated_at: string;
 }
 
 export interface Slot {
@@ -167,13 +183,99 @@ export interface Slot {
   updated_at: string;
 }
 
+/**
+ * Customer record — matches the `customers` table.
+ */
 export interface Customer {
   id: string;
+  tenant_id: string;
+  customer_type: 'individual' | 'organization';
+  name: string;
+  email: string;
+  phone?: string;
+  address?: string;
+  city?: string;
+  state?: string;
+  zip_code?: string;
+  is_guest?: boolean;
+  metadata?: Record<string, unknown>;
+  created_at: string;
+  updated_at: string;
+}
+
+/**
+ * A row in `customer_users` — links an IDP user (Clerk userId, Auth0 sub, etc.) to a Customer.
+ */
+export interface CustomerIdentity {
+  id: string;
+  customer_id: string;
+  idp_id: string;
+  role: 'owner' | 'admin' | 'member';
+  is_primary: boolean;
+  created_at: string;
+  updated_at: string;
+}
+
+/**
+ * Customer with their associated IDP identities (from `customer_users` join).
+ */
+export interface CustomerWithIdentities extends Customer {
+  identities?: CustomerIdentity[];
+}
+
+/**
+ * Notification preferences stored in `customer.metadata.notification_preferences`.
+ */
+export interface NotificationPreferences {
+  email?: boolean;
+  sms?: boolean;
+  push?: boolean;
+  booking_confirmation?: boolean;
+  booking_reminder?: boolean;
+  booking_cancellation?: boolean;
+  marketing?: boolean;
+  [key: string]: boolean | undefined;
+}
+
+/**
+ * Customer with their bookings, as returned by GET /api/v1/customers/bookings.
+ */
+export interface CustomerWithBookings {
+  customer: Customer;
+  bookings: Booking[];
+  /** Bookings organised by slot ID → array of bookings */
+  groupedBySlot: Record<string, Booking[]>;
+  total: number;
+  total_slots: number;
+}
+
+/**
+ * Options for resolving a customer from an IDP identity or email.
+ * At least one of `idpId` or `email` must be provided.
+ */
+export interface ResolveCustomerOptions {
   tenantId: string;
+  /** IDP user ID (Clerk userId, Auth0 sub, etc.) — checked first */
+  idpId?: string;
+  /** Email address — used as fallback if idpId lookup returns nothing */
   email?: string;
+}
+
+/**
+ * Options for atomic customer upsert (find or create by email within a tenant).
+ */
+export interface FindOrCreateCustomerOptions {
+  tenant_id: string;
+  email: string;
   name?: string;
   phone?: string;
-  // TODO: Add actual customer properties
+  address?: string;
+  city?: string;
+  state?: string;
+  zip_code?: string;
+  customer_type?: 'individual' | 'organization';
+  is_guest?: boolean;
+  metadata?: Record<string, unknown>;
 }
 
 export interface Flow {
@@ -249,6 +351,69 @@ export interface GetOrganizationOptions {
   is_public?: boolean;
 }
 
+/**
+ * Artifact / document attached to a customer or booking
+ */
+export type ArtifactEntityType = 'customer' | 'booking' | 'slot' | 'service' | 'tenant';
+
+export type ArtifactMimeCategory = 'pdf' | 'document' | 'image' | 'spreadsheet' | 'video' | 'audio' | 'other';
+
+export interface Artifact {
+  id: string;
+  tenant_id: string;
+  /** The Slotly entity this file is attached to */
+  related_entity_type: ArtifactEntityType;
+  related_entity_id: string;
+  /** Original filename supplied by the uploader */
+  original_filename: string;
+  /** Storage path within the tenant bucket (opaque — use url/signed_url to access) */
+  storage_path: string;
+  /** MIME category, derived server-side */
+  mime_category: ArtifactMimeCategory;
+  mime_type?: string;
+  size_bytes?: number;
+  /** Optional label, e.g. "CV", "Invoice", "Contract" */
+  label?: string;
+  metadata?: Record<string, unknown>;
+  uploaded_by_user_id?: string;
+  created_at: string;
+  updated_at: string;
+}
+
+/**
+ * Artifact with a short-lived signed download URL (returned from getUrl / list with signed=true)
+ */
+export interface ArtifactWithUrl extends Artifact {
+  signed_url: string;
+  /** Unix timestamp (seconds) when the signed_url expires */
+  signed_url_expires_at: number;
+}
+
+export interface ListArtifactsOptions {
+  related_entity_type?: ArtifactEntityType;
+  related_entity_id?: string;
+  /** Include signed download URLs in each result (adds latency) */
+  signed?: boolean;
+  mime_category?: ArtifactMimeCategory;
+  label?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface UploadArtifactOptions {
+  /** The file binary */
+  file: Blob | Buffer | ArrayBuffer;
+  /** Original filename */
+  filename: string;
+  /** The entity this artifact belongs to */
+  related_entity_type: ArtifactEntityType;
+  related_entity_id: string;
+  /** Optional label for the UI, e.g. "CV", "Invoice" */
+  label?: string;
+  mime_type?: string;
+  metadata?: Record<string, unknown>;
+}
+
 /**
  * Full tenant configuration including branding, services, and service items
  * Service items are nested within each service object (not as a separate top-level array)

package/src/types/next-ambient.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Minimal ambient declarations for Next.js types used in validateSlotlyRequest.
+ * This prevents a hard devDependency on the full `next` package just to typecheck
+ * the middleware file. Replace with `import type {...} from 'next'` if next is
+ * available in the host project.
+ */
+declare module 'next' {
+  import type { IncomingMessage, ServerResponse } from 'http';
+
+  interface NextApiRequest extends IncomingMessage {
+    query: Record<string, string | string[]>;
+    cookies: Record<string, string>;
+    body: any;
+    env: Record<string, string>;
+    headers: Record<string, string | string[] | undefined>;
+    method?: string;
+    url?: string;
+  }
+
+  interface NextApiResponse<T = any> extends ServerResponse {
+    send(body: T): void;
+    json(body: T): void;
+    status(code: number): NextApiResponse<T>;
+    redirect(url: string): void;
+    redirect(status: number, url: string): void;
+    setHeader(name: string, value: string | string[]): void;
+    end(data?: string | Buffer): void;
+  }
+}