@startsimpli/api 0.1.0 → 0.2.2

package/src/utils/validate-response.ts

@@ -0,0 +1,39 @@
+/**
+ * Runtime API response validation
+ *
+ * Validates responses against Zod schemas but NEVER throws.
+ * On mismatch: logs a warning, returns original data cast to expected type.
+ * Schema drift should not crash the app.
+ */
+
+import { z } from 'zod';
+
+/**
+ * Validate an API response against a Zod schema.
+ *
+ * - On success: returns parsed (cleaned) data
+ * - On failure: logs a warning with `context` label, returns the raw data
+ *   cast as T. **The return value is NOT guaranteed to satisfy T on
+ *   validation failure** — callers must tolerate schema drift at runtime.
+ *
+ * This is intentional — schema drift should degrade gracefully,
+ * not crash the app. Pass a unique `context` string so mismatches
+ * can be traced in logs (e.g. `"contacts.list"`, `"campaigns.get"`).
+ */
+export function validateApiResponse<T>(
+  data: unknown,
+  schema: z.ZodSchema<T>,
+  context?: string
+): T {
+  const result = schema.safeParse(data);
+  if (!result.success) {
+    const label = context ? `[${context}]` : '[API validation]';
+    // BEAD: fund-your-startup-kadw - returns unvalidated data cast to T on failure; callers get wrong type silently
+    console.warn(
+      `${label} Schema mismatch — returning raw data.`,
+      result.error.flatten().fieldErrors
+    );
+    return data as T;
+  }
+  return result.data;
+}

package/src/lib/messages-api.ts.backup

@@ -1,273 +0,0 @@
-/**
- * Messages API wrapper
- *
- * Provides type-safe access to Django Messages API
- */
-
-import type { ApiClient } from './api-client';
-
-export type MessageStatus = 'draft' | 'scheduled' | 'sending' | 'sent' | 'failed';
-export type MessageContentType = 'text/plain' | 'text/markdown' | 'text/html';
-export type RecipientStatus = 'pending' | 'sent' | 'delivered' | 'bounced' | 'opened' | 'clicked';
-
-export interface Message {
-  id: string;
-  team: string;
-  channel: string;
-  channel_details?: {
-    key: string;
-    name: string;
-    description: string;
-    icon: string;
-  };
-  subject: string;
-  body: string;
-  content_type: MessageContentType;
-  from_name: string | null;
-  from_email: string | null;
-  reply_to: string | null;
-  status: MessageStatus;
-  scheduled_at: string | null;
-  sent_at: string | null;
-  metadata: Record<string, any>;
-  total_recipients: number;
-  recipients_sent: number;
-  recipients_delivered: number;
-  recipients_opened: number;
-  recipients_clicked: number;
-  recipients_bounced: number;
-  recipients_unsubscribed: number;
-  open_rate: number;
-  click_rate: number;
-  bounce_rate: number;
-  error_message: string | null;
-  created_at: string;
-  updated_at: string;
-}
-
-export interface MessageRecipient {
-  id: string;
-  recipient_type: string;
-  recipient_id: string | null;
-  recipient_email: string;
-  recipient_name: string | null;
-  channel_identifier: string | null;
-  channel_profiles: Record<string, any>;
-  status: RecipientStatus;
-  sent_at: string | null;
-  delivered_at: string | null;
-  bounced_at: string | null;
-  first_opened_at: string | null;
-  last_opened_at: string | null;
-  first_clicked_at: string | null;
-  last_clicked_at: string | null;
-  open_count: number;
-  click_count: number;
-  is_unsubscribed: boolean;
-  unsubscribed_at: string | null;
-  error_message: string | null;
-  created_at: string;
-}
-
-export interface MessagingChannel {
-  id: string;
-  key: string;
-  name: string;
-  description: string;
-  icon: string;
-  capabilities: {
-    max_content_length: number;
-    supports_html: boolean;
-    supports_markdown: boolean;
-    supports_attachments: boolean;
-    max_attachments: number;
-    max_attachment_size: number;
-  };
-  requirements: {
-    requires_connection: boolean;
-    requires_opt_in: boolean;
-    auth_requirements: Record<string, any>;
-  };
-  rate_limit: {
-    messages: number;
-    seconds: number;
-    scope: string;
-    description: string;
-  };
-  metadata: Record<string, any>;
-}
-
-export interface MessageFilters {
-  status?: MessageStatus;
-  content_type?: MessageContentType;
-  scheduled_after?: string;
-  scheduled_before?: string;
-  sent_after?: string;
-  sent_before?: string;
-  search?: string;
-  page?: number;
-  page_size?: number;
-  ordering?: string;
-}
-
-export interface CreateMessageInput {
-  channel: string;
-  subject: string;
-  body: string;
-  content_type?: MessageContentType;
-  from_name?: string;
-  from_email?: string;
-  reply_to?: string;
-  scheduled_at?: string;
-  metadata?: Record<string, any>;
-  recipients?: Array<{
-    recipient_type: string;
-    recipient_email: string;
-    recipient_name?: string;
-    channel_identifier?: string;
-  }>;
-}
-
-export interface ScheduleMessageInput {
-  scheduled_at: string;
-}
-
-export interface SendTestInput {
-  test_email?: string;
-}
-
-export class MessagesApi {
-  constructor(private client: ApiClient) {}
-
-  /**
-   * List messages with optional filters
-   */
-  async list(filters?: MessageFilters) {
-    const params = new URLSearchParams();
-
-    if (filters?.status) params.append('status', filters.status);
-    if (filters?.content_type) params.append('content_type', filters.content_type);
-    if (filters?.scheduled_after) params.append('scheduled_after', filters.scheduled_after);
-    if (filters?.scheduled_before) params.append('scheduled_before', filters.scheduled_before);
-    if (filters?.sent_after) params.append('sent_after', filters.sent_after);
-    if (filters?.sent_before) params.append('sent_before', filters.sent_before);
-    if (filters?.search) params.append('search', filters.search);
-    if (filters?.page) params.append('page', String(filters.page));
-    if (filters?.page_size) params.append('page_size', String(filters.page_size));
-    if (filters?.ordering) params.append('ordering', filters.ordering);
-
-    return this.client.get<{ results: Message[]; count: number; next: string | null; previous: string | null }>(
-      `/api/v1/messages/?${params.toString()}`
-    );
-  }
-
-  /**
-   * Get message by ID
-   */
-  async get(id: string) {
-    return this.client.get<Message>(`/api/v1/messages/${id}/`);
-  }
-
-  /**
-   * Create a new message
-   */
-  async create(data: CreateMessageInput) {
-    return this.client.post<Message>('/api/v1/messages/', data);
-  }
-
-  /**
-   * Update message (draft only)
-   */
-  async update(id: string, data: Partial<CreateMessageInput>) {
-    return this.client.patch<Message>(`/api/v1/messages/${id}/`, data);
-  }
-
-  /**
-   * Delete message (draft only)
-   */
-  async delete(id: string) {
-    return this.client.delete(`/api/v1/messages/${id}/`);
-  }
-
-  /**
-   * Schedule message for future sending
-   */
-  async schedule(id: string, input: ScheduleMessageInput) {
-    return this.client.post<{ id: string; status: MessageStatus; scheduled_at: string; message: string }>(
-      `/api/v1/messages/${id}/schedule/`,
-      input
-    );
-  }
-
-  /**
-   * Send message immediately
-   */
-  async sendNow(id: string) {
-    return this.client.post<{ id: string; status: MessageStatus; message: string }>(
-      `/api/v1/messages/${id}/send_now/`,
-      {}
-    );
-  }
-
-  /**
-   * Send test message
-   */
-  async sendTest(id: string, input?: SendTestInput) {
-    return this.client.post<{ id: string; test_email: string; message: string }>(
-      `/api/v1/messages/${id}/send_test/`,
-      input || {}
-    );
-  }
-
-  /**
-   * Preview message rendering
-   */
-  async preview(id: string) {
-    return this.client.get<{
-      subject: string;
-      body: string;
-      preview_html: string;
-      from_name: string;
-      from_email: string;
-    }>(`/api/v1/messages/${id}/preview/`);
-  }
-
-  /**
-   * List recipients for a message
-   */
-  async getRecipients(id: string, page?: number, pageSize?: number) {
-    const params = new URLSearchParams();
-    if (page) params.append('page', String(page));
-    if (pageSize) params.append('page_size', String(pageSize));
-
-    return this.client.get<{ results: MessageRecipient[]; count: number }>(
-      `/api/v1/messages/${id}/recipients/?${params.toString()}`
-    );
-  }
-
-  /**
-   * Add recipients to a message
-   */
-  async addRecipients(
-    id: string,
-    recipients: Array<{
-      recipient_type: string;
-      recipient_email: string;
-      recipient_name?: string;
-      channel_identifier?: string;
-    }>
-  ) {
-    return this.client.post<{
-      message: string;
-      total_recipients: number;
-      recipients: MessageRecipient[];
-    }>(`/api/v1/messages/${id}/add_recipients/`, { recipients });
-  }
-
-  /**
-   * Get available messaging channels
-   */
-  async getChannels() {
-    return this.client.get<{ channels: MessagingChannel[]; count: number }>('/api/v1/messages/channels/');
-  }
-}