@foru-ms/sdk 1.3.2 → 2.0.2

package/src/resources/Webhooks.ts

@@ -1,192 +0,0 @@
-import { ForumClient } from '../Client';
-import { Webhook, WebhookListResponse } from '../types';
-
-/**
- * Resource for managing webhooks
- */
-export class WebhooksResource {
-    private client: ForumClient;
-
-    constructor(client: ForumClient) {
-        this.client = client;
-    }
-
-    /**
-     * List all webhooks
-     * @returns Promise resolving to list of webhooks
-     */
-    async list(): Promise<WebhookListResponse> {
-        return this.client.request<WebhookListResponse>('/webhooks', {
-            method: 'GET',
-        });
-    }
-
-    /**
-     * Create a new webhook
-     * @param payload - Webhook configuration
-     * @returns Promise resolving to created webhook
-     */
-    async create(payload: {
-        name: string;
-        url: string;
-        events: string[];
-    }): Promise<{ webhook: Webhook }> {
-        return this.client.request<{ webhook: Webhook }>('/webhooks', {
-            method: 'POST',
-            body: JSON.stringify(payload),
-        });
-    }
-
-    /**
-     * Get a webhook by ID
-     * @param id - Webhook ID
-     * @returns Promise resolving to webhook details
-     */
-    async retrieve(id: string): Promise<{ webhook: Webhook }> {
-        return this.client.request<{ webhook: Webhook }>(`/webhooks/${id}`, {
-            method: 'GET',
-        });
-    }
-
-    /**
-     * Update a webhook
-     * @param id - Webhook ID
-     * @param payload - Updated webhook data
-     * @returns Promise resolving to updated webhook
-     */
-    async update(id: string, payload: {
-        name?: string;
-        url?: string;
-        events?: string[];
-        active?: boolean;
-    }): Promise<{ webhook: Webhook }> {
-        return this.client.request<{ webhook: Webhook }>(`/webhooks/${id}`, {
-            method: 'PATCH',
-            body: JSON.stringify(payload),
-        });
-    }
-
-    /**
-     * Delete a webhook
-     * @param id - Webhook ID
-     * @returns Promise resolving to deletion confirmation
-     */
-    async delete(id: string): Promise<{ success: boolean }> {
-        return this.client.request<{ success: boolean }>(`/webhooks/${id}`, {
-            method: 'DELETE',
-        });
-    }
-
-    /**
-     * Get webhook delivery history
-     * @param id - Webhook ID
-     * @param params - Query parameters
-     * @returns Promise resolving to delivery history
-     */
-    async getDeliveries(id: string, params?: { cursor?: string; limit?: number }): Promise<{ deliveries: any[]; total: number; nextCursor?: string }> {
-        const searchParams = new URLSearchParams();
-        if (params?.cursor) searchParams.append('cursor', params.cursor);
-        if (params?.limit) searchParams.append('limit', params.limit.toString());
-
-        return this.client.request<{ deliveries: any[]; total: number; nextCursor?: string }>(`/webhooks/${id}/deliveries?${searchParams.toString()}`, {
-            method: 'GET',
-        });
-    }
-
-    /**
-     * Verify webhook signature for security
-     * @param payload - Request body (should be the original object, not stringified)
-     * @param signature - Signature from X-Webhook-Signature header
-     * @param timestamp - Timestamp from X-Webhook-Timestamp header (in milliseconds)
-     * @param secret - Webhook secret from creation
-     * @param maxAge - Maximum age of webhook in milliseconds (default: 5 minutes)
-     * @returns True if signature is valid and timestamp is recent
-     * @example
-     * ```typescript
-     * // In your webhook handler
-     * app.post('/webhook', (req, res) => {
-     *   const signature = req.headers['x-webhook-signature'];
-     *   const timestamp = req.headers['x-webhook-timestamp'];
-     *   const event = req.headers['x-webhook-event'];
-     *   
-     *   // Verify signature and timestamp
-     *   const isValid = client.webhooks.verifySignature(
-     *     req.body,
-     *     signature,
-     *     timestamp,
-     *     'your_webhook_secret'
-     *   );
-     *   
-     *   if (!isValid) {
-     *     return res.status(401).send('Invalid signature');
-     *   }
-     *   
-     *   // Process webhook...
-     *   console.log('Event:', event);
-     *   res.sendStatus(200);
-     * });
-     * ```
-     */
-    verifySignature(
-        payload: any,
-        signature: string,
-        timestamp: string,
-        secret: string,
-        maxAge: number = 5 * 60 * 1000 // 5 minutes default
-    ): boolean {
-        try {
-            // Verify timestamp (prevent replay attacks)
-            const webhookTimestamp = parseInt(timestamp, 10);
-            if (isNaN(webhookTimestamp)) {
-                console.error('Invalid webhook timestamp format');
-                return false;
-            }
-
-            const age = Date.now() - webhookTimestamp;
-            if (age > maxAge) {
-                console.error('Webhook timestamp too old:', age, 'ms');
-                return false;
-            }
-
-            // Use Node.js crypto if available
-            if (typeof require !== 'undefined') {
-                try {
-                    const crypto = require('crypto');
-
-                    // Create the signed data: timestamp.payload
-                    const data = `${timestamp}.${JSON.stringify(payload)}`;
-
-                    // Calculate expected signature
-                    const expectedSignature = crypto
-                        .createHmac('sha256', secret)
-                        .update(data)
-                        .digest('hex');
-
-                    // Use timing-safe comparison
-                    if (crypto.timingSafeEqual) {
-                        return crypto.timingSafeEqual(
-                            Buffer.from(signature),
-                            Buffer.from(expectedSignature)
-                        );
-                    }
-
-                    // Fallback to simple comparison (less secure)
-                    return signature === expectedSignature;
-
-                } catch (error) {
-                    console.error('Error using Node.js crypto:', error);
-                    // Fall through to browser implementation
-                }
-            }
-
-            // For browser environments or when Node crypto is not available
-            console.warn('Webhook signature verification not fully supported in this environment');
-            console.warn('Please use Node.js for secure webhook verification');
-            return false;
-
-        } catch (error) {
-            console.error('Error verifying webhook signature:', error);
-            return false;
-        }
-    }
-}

package/src/response-types.ts

@@ -1,137 +0,0 @@
-import { User } from './types';
-
-/**
- * Rate limit information from API responses
- */
-export interface RateLimitInfo {
-    /** Maximum number of requests allowed in the time window */
-    limit: number;
-    /** Number of requests remaining in the current window */
-    remaining: number;
-    /** Unix timestamp when the rate limit resets */
-    reset: number;
-}
-
-/**
- * Metadata included with API responses
- */
-export interface ResponseMetadata {
-    /** Rate limit information, if available */
-    rateLimit?: RateLimitInfo;
-    /** Request ID for debugging */
-    requestId?: string;
-}
-
-/**
- * Generic API response wrapper
- */
-export interface APIResponse<T> {
-    /** Response data */
-    data: T;
-    /** Response metadata */
-    meta?: ResponseMetadata;
-}
-
-/**
- * Response for interaction lists (likes, upvotes, etc.)
- */
-export interface InteractionListResponse {
-    /** List of users who performed the interaction */
-    users: User[];
-    /** Cursor for next page */
-    nextCursor?: string;
-    /** Total count of interactions */
-    count: number;
-}
-
-/**
- * Response for poll data
- */
-export interface PollResponse {
-    /** Poll ID */
-    id: string;
-    /** Poll title */
-    title: string;
-    /** Poll options */
-    options: PollOption[];
-    /** Total number of votes */
-    totalVotes: number;
-    /** Whether the poll allows multiple votes */
-    allowMultiple?: boolean;
-    /** Poll expiration date */
-    expiresAt?: string;
-    /** User's vote, if userId was provided */
-    userVote?: {
-        optionId: string;
-        votedAt: string;
-    };
-}
-
-/**
- * Poll option data
- */
-export interface PollOption {
-    /** Option ID */
-    id: string;
-    /** Option title */
-    title: string;
-    /** Option color */
-    color?: string;
-    /** Number of votes for this option */
-    votes: number;
-    /** Percentage of total votes */
-    percentage: number;
-    /** Extended data */
-    extendedData?: Record<string, any>;
-}
-
-/**
- * Simplified poll option for results
- */
-export interface PollOptionResult {
-    /** The ID of the poll option */
-    id: string;
-    /** The title of the poll option */
-    title: string;
-    /** The color of the poll option */
-    color?: string;
-    /** The number of votes this option received */
-    votes: number;
-}
-
-/**
- * Poll results data
- */
-export interface PollResults {
-    /** List of poll options with results */
-    options: PollOptionResult[];
-    /** The option ID that the user voted for, or null if they haven't voted */
-    userVote?: string | null;
-}
-
-/**
- * Response for batch operations
- */
-export interface BatchOperationResponse {
-    /** Number of items successfully processed */
-    success: number;
-    /** Number of items that failed */
-    failed: number;
-    /** Error details for failed items */
-    errors?: Array<{
-        id: string;
-        error: string;
-    }>;
-}
-
-/**
- * Pagination cursor response
- */
-export interface CursorPagination<T> {
-    /** Array of items */
-    items: T[];
-    /** Cursor for next page */
-    nextCursor?: string;
-    /** Whether there are more items */
-    hasMore: boolean;
-}

package/src/types.ts

@@ -1,337 +0,0 @@
-// Auth
-export interface RegisterPayload {
-    username: string;
-    email: string;
-    password: string;
-    displayName?: string;
-    emailVerified?: boolean;
-    roles?: string[];
-    extendedData?: Record<string, any>;
-}
-
-export interface User {
-    id: string;
-    username: string;
-    email?: string; // Optional as it might be private in some contexts
-    displayName: string | null;
-    roles?: any[]; // Refine if needed
-    extendedData?: Record<string, any>;
-    createdAt?: string;
-    updatedAt?: string;
-}
-
-// Thread
-export interface Thread {
-    id: string;
-    title: string;
-    slug: string;
-    body: string;
-    userId: string;
-    locked: boolean;
-    pinned: boolean;
-    createdAt: string;
-    updatedAt: string;
-    user?: User;
-    likes?: any[];
-    upvotes?: any[];
-    tags?: any[];
-    poll?: any;
-    extendedData?: Record<string, any>;
-    _count?: {
-        Post: number;
-        likes?: number;
-        upvotes?: number;
-    };
-}
-
-export interface CreateThreadPayload {
-    title: string;
-    body: string;
-    userId?: string; // Optional if using token
-    slug?: string;
-    locked?: boolean;
-    pinned?: boolean;
-    tags?: string[];
-    poll?: {
-        title: string;
-        options: {
-            title: string;
-            color?: string;
-            extendedData?: Record<string, any>;
-        }[];
-    };
-    extendedData?: Record<string, any>;
-}
-
-export interface UpdateThreadPayload {
-    title?: string;
-    slug?: string;
-    body?: string;
-    userId?: string;
-    locked?: boolean;
-    pinned?: boolean;
-    extendedData?: Record<string, any>;
-}
-
-// Post
-export interface Post {
-    id: string;
-    body: string;
-    threadId: string;
-    userId: string;
-    parentId?: string | null;
-    depth?: number;
-    createdAt: string;
-    updatedAt: string;
-    user?: User;
-    Thread?: {
-        userId: string;
-        title: string;
-    };
-    extendedData?: Record<string, any>;
-}
-
-export interface CreatePostPayload {
-    body: string;
-    threadId: string;
-    userId?: string; // Optional if using token
-    parentId?: string;
-    extendedData?: Record<string, any>;
-}
-
-export interface UpdatePostPayload {
-    body?: string;
-    userId?: string;
-    threadId?: string;
-    parentId?: string;
-    bestAnswer?: boolean;
-    extendedData?: Record<string, any>;
-}
-
-export interface PaginatedResponse<T> {
-    data: T[]; // Generic wrapper if API changes to this format
-}
-
-export interface ThreadListResponse {
-    threads: Thread[];
-    nextThreadCursor?: string;
-    count: number;
-}
-
-export interface PostListResponse {
-    posts: Post[];
-    nextPostCursor?: string;
-    count: number;
-}
-
-export interface LoginResponse {
-    token: string;
-}
-
-export interface RegisterResponse {
-    user: User;
-    token: string;
-}
-
-export interface SecurityInfo {
-    userId: string;
-    username: string;
-    registrationIp: string;
-    registrationDate: string;
-    lastIp: string;
-    lastSeenAt: string;
-    isOnline: boolean;
-    emailVerified: boolean;
-}
-
-export type ThreadFilter = 'newest' | 'oldest';
-export type InteractionType = 'created' | 'liked' | 'disliked' | 'upvoted' | 'downvoted' | 'subscribed';
-
-export interface Tag {
-    id: string;
-    name: string;
-    description: string | null;
-    color: string | null;
-    createdAt: string;
-    updatedAt: string;
-    _count?: {
-        threads: number;
-    };
-    threads?: Thread[];
-}
-
-export interface UserListResponse {
-    users: User[];
-    nextUserCursor?: string;
-    count: number;
-}
-
-export interface TagListResponse {
-    tags: Tag[];
-    nextTagCursor?: string;
-    count?: number;
-}
-
-export interface Notification {
-    id: string;
-    threadId?: string;
-    postId?: string;
-    privateMessageId?: string;
-    notifierId: string;
-    notifiedId: string;
-    type: string;
-    description?: string;
-    status?: string;
-    createdAt: string;
-    extendedData?: Record<string, any>;
-    post?: Post;
-    thread?: Thread;
-    notifier?: User;
-    message?: string; // Computed field from API
-    isSystem?: boolean;
-}
-
-export interface NotificationListResponse {
-    list: Notification[];
-    nextCursor?: string;
-    count: number;
-}
-
-export interface SearchResponse {
-    type?: 'tags' | 'posts' | 'threads' | 'users';
-    tags?: Tag[];
-    posts?: Post[];
-    threads?: Thread[];
-    nextCursor?: string;
-}
-
-export interface Webhook {
-    id: string;
-    name: string;
-    url: string;
-    events: { events: string[] } | string[]; // Accessing normalized events is better
-    active: boolean;
-    secret?: string; // Only on creation
-    createdAt: string;
-    updatedAt: string;
-    _count?: {
-        deliveries: number;
-    };
-}
-
-export interface WebhookListResponse {
-    webhooks: Webhook[];
-}
-
-export interface StatsResponse {
-    counts: {
-        threads: number;
-        posts: number;
-        users: number;
-        reports: number;
-    };
-    latest: {
-        id: string;
-        createdAt: string;
-        type: 'thread' | 'post' | 'user' | 'report';
-        [key: string]: any;
-    }[];
-    usage: Record<string, any>;
-    cursors: {
-        threadCursor: string | null;
-        postCursor: string | null;
-        userCursor: string | null;
-        reportCursor: string | null;
-    };
-}
-
-export interface Integration {
-    id: string;
-    type: 'SLACK' | 'DISCORD' | 'SALESFORCE' | 'HUBSPOT' | 'OKTA' | 'AUTH0';
-    name: string;
-    active: boolean;
-    createdAt: string;
-    config?: any;
-}
-
-export interface IntegrationListResponse {
-    integrations: Integration[];
-}
-
-export interface PrivateMessage {
-    id: string;
-    senderId: string;
-    recipientId: string;
-    title?: string;
-    body: string;
-    status?: string;
-    parentId?: string;
-    children?: PrivateMessage[];
-    sender?: User;
-    recipient?: User;
-    createdAt: string;
-    updatedAt: string;
-    extendedData?: Record<string, any>;
-}
-
-export interface PrivateMessageListResponse {
-    privateMessages: PrivateMessage[];
-    nextPrivateMessageCursor?: string;
-    count: number;
-}
-
-export interface Report {
-    id: string;
-    reporterId: string;
-    reportedId?: string;
-    threadId?: string;
-    postId?: string;
-    privateMessageId?: string;
-    type: string;
-    description?: string;
-    status?: string;
-    createdAt: string;
-    post?: Post;
-    thread?: Thread;
-    privateMessage?: PrivateMessage;
-    reported?: User;
-    extendedData?: Record<string, any>;
-}
-
-export interface ReportListResponse {
-    list: Report[];
-    nextCursor?: string;
-    count: number;
-}
-
-export interface Role {
-    id: string;
-    name: string;
-    description?: string;
-    color?: string;
-    users?: User[];
-    createdAt: string;
-    updatedAt: string;
-    extendedData?: Record<string, any>;
-}
-
-export interface RoleListResponse {
-    roles: Role[];
-    nextCursor?: string;
-    count: number;
-}
-
-export interface SSOProvider {
-    id: string;
-    provider: 'OKTA' | 'AUTH0' | 'SAML';
-    domain: string;
-    active: boolean;
-    createdAt: string;
-    config?: any;
-}
-
-export interface SSOProviderListResponse {
-    ssoProviders: SSOProvider[];
-}
-
-