@foru-ms/sdk 1.3.3 → 2.0.3

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Foru.ms
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/Client.d.ts

@@ -1,98 +0,0 @@
-import { AuthResource } from './resources/Auth';
-import { ThreadsResource } from './resources/Threads';
-import { PostsResource } from './resources/Posts';
-import { UsersResource } from './resources/Users';
-import { TagsResource } from './resources/Tags';
-import { NotificationsResource } from './resources/Notifications';
-import { SearchResource } from './resources/Search';
-import { WebhooksResource } from './resources/Webhooks';
-import { StatsResource } from './resources/Stats';
-import { IntegrationsResource } from './resources/Integrations';
-import { PrivateMessagesResource } from './resources/PrivateMessages';
-import { ReportsResource } from './resources/Reports';
-import { RolesResource } from './resources/Roles';
-import { SSOResource } from './resources/SSO';
-import { PaginationHelper } from './utils';
-import { RateLimitInfo } from './response-types';
-export interface ClientOptions {
-    /** API key for authentication */
-    apiKey: string;
-    /** Base URL for the API (default: https://api.foru.ms/v1) */
-    baseUrl?: string;
-    /** Maximum number of retry attempts for failed requests (default: 3) */
-    maxRetries?: number;
-    /** Enable automatic retry for rate limits and server errors (default: true) */
-    enableRetry?: boolean;
-}
-/**
- * Main client for interacting with the Foru.ms API
- * @example
- * ```typescript
- * const client = new ForumClient({
- *   apiKey: 'your_api_key',
- *   baseUrl: 'https://api.foru.ms/v1'
- * });
- *
- * // Set user token
- * client.setToken('user_jwt_token');
- *
- * // Use resources
- * const threads = await client.threads.list();
- * ```
- */
-export declare class ForumClient {
-    apiKey: string;
-    token: string | null;
-    baseUrl: string;
-    maxRetries: number;
-    enableRetry: boolean;
-    /** Last known rate limit info */
-    lastRateLimitInfo?: RateLimitInfo;
-    auth: AuthResource;
-    threads: ThreadsResource;
-    posts: PostsResource;
-    users: UsersResource;
-    tags: TagsResource;
-    notifications: NotificationsResource;
-    search: SearchResource;
-    webhooks: WebhooksResource;
-    stats: StatsResource;
-    integrations: IntegrationsResource;
-    privateMessages: PrivateMessagesResource;
-    reports: ReportsResource;
-    roles: RolesResource;
-    sso: SSOResource;
-    /** Pagination helper for auto-paginating through results */
-    pagination: PaginationHelper;
-    constructor(options: ClientOptions);
-    /**
-     * Make an HTTP request to the API
-     * @param path - API endpoint path
-     * @param options - Fetch options
-     * @returns Promise resolving to the response data
-     * @throws {ForumAPIError} When the API returns an error
-     * @throws {NetworkError} When the network request fails
-     */
-    request<T>(path: string, options?: RequestInit): Promise<T>;
-    /**
-     * Set the authentication token for user-scoped requests
-     * @param token - JWT token
-     */
-    setToken(token: string): void;
-    /**
-     * Clear the authentication token
-     */
-    clearToken(): void;
-    /**
-     * Check if client is authenticated
-     */
-    isAuthenticated(): boolean;
-    /**
-     * Extract and store rate limit information from response headers
-     */
-    private extractRateLimitInfo;
-    /**
-     * Handle error responses by throwing appropriate error types
-     */
-    private handleErrorResponse;
-}

package/dist/Client.js

@@ -1,172 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ForumClient = void 0;
-const Auth_1 = require("./resources/Auth");
-const Threads_1 = require("./resources/Threads");
-const Posts_1 = require("./resources/Posts");
-const Users_1 = require("./resources/Users");
-const Tags_1 = require("./resources/Tags");
-const Notifications_1 = require("./resources/Notifications");
-const Search_1 = require("./resources/Search");
-const Webhooks_1 = require("./resources/Webhooks");
-const Stats_1 = require("./resources/Stats");
-const Integrations_1 = require("./resources/Integrations");
-const PrivateMessages_1 = require("./resources/PrivateMessages");
-const Reports_1 = require("./resources/Reports");
-const Roles_1 = require("./resources/Roles");
-const SSO_1 = require("./resources/SSO");
-const errors_1 = require("./errors");
-const utils_1 = require("./utils");
-// Polyfill fetch if needed (e.g. older Node versions)
-const fetch = globalThis.fetch || require('cross-fetch');
-/**
- * Main client for interacting with the Foru.ms API
- * @example
- * ```typescript
- * const client = new ForumClient({
- *   apiKey: 'your_api_key',
- *   baseUrl: 'https://api.foru.ms/v1'
- * });
- *
- * // Set user token
- * client.setToken('user_jwt_token');
- *
- * // Use resources
- * const threads = await client.threads.list();
- * ```
- */
-class ForumClient {
-    constructor(options) {
-        var _a, _b;
-        this.token = null;
-        this.apiKey = options.apiKey;
-        this.baseUrl = options.baseUrl || 'https://api.foru.ms/v1';
-        this.maxRetries = (_a = options.maxRetries) !== null && _a !== void 0 ? _a : 3;
-        this.enableRetry = (_b = options.enableRetry) !== null && _b !== void 0 ? _b : true;
-        this.auth = new Auth_1.AuthResource(this);
-        this.threads = new Threads_1.ThreadsResource(this);
-        this.posts = new Posts_1.PostsResource(this);
-        this.users = new Users_1.UsersResource(this);
-        this.tags = new Tags_1.TagsResource(this);
-        this.notifications = new Notifications_1.NotificationsResource(this);
-        this.search = new Search_1.SearchResource(this);
-        this.webhooks = new Webhooks_1.WebhooksResource(this);
-        this.stats = new Stats_1.StatsResource(this);
-        this.integrations = new Integrations_1.IntegrationsResource(this);
-        this.privateMessages = new PrivateMessages_1.PrivateMessagesResource(this);
-        this.reports = new Reports_1.ReportsResource(this);
-        this.roles = new Roles_1.RolesResource(this);
-        this.sso = new SSO_1.SSOResource(this);
-        this.pagination = new utils_1.PaginationHelper();
-    }
-    /**
-     * Make an HTTP request to the API
-     * @param path - API endpoint path
-     * @param options - Fetch options
-     * @returns Promise resolving to the response data
-     * @throws {ForumAPIError} When the API returns an error
-     * @throws {NetworkError} When the network request fails
-     */
-    async request(path, options = {}) {
-        const makeRequest = async () => {
-            const headers = {
-                'Content-Type': 'application/json',
-                'x-api-key': this.apiKey,
-                ...options.headers,
-            };
-            if (this.token) {
-                headers['Authorization'] = `Bearer ${this.token}`;
-            }
-            let response;
-            try {
-                response = await fetch(`${this.baseUrl}${path}`, {
-                    ...options,
-                    headers,
-                });
-            }
-            catch (error) {
-                throw new errors_1.NetworkError('Network request failed', error);
-            }
-            // Extract rate limit info
-            this.extractRateLimitInfo(response);
-            const contentType = response.headers.get('content-type');
-            let data;
-            if (contentType && contentType.includes('application/json')) {
-                data = await response.json();
-            }
-            else {
-                data = await response.text();
-            }
-            if (!response.ok) {
-                this.handleErrorResponse(response.status, data);
-            }
-            return data;
-        };
-        // Apply retry logic if enabled
-        if (this.enableRetry) {
-            return utils_1.RetryHelper.withRetry(makeRequest, this.maxRetries);
-        }
-        return makeRequest();
-    }
-    /**
-     * Set the authentication token for user-scoped requests
-     * @param token - JWT token
-     */
-    setToken(token) {
-        this.token = token;
-    }
-    /**
-     * Clear the authentication token
-     */
-    clearToken() {
-        this.token = null;
-    }
-    /**
-     * Check if client is authenticated
-     */
-    isAuthenticated() {
-        return this.token !== null;
-    }
-    /**
-     * Extract and store rate limit information from response headers
-     */
-    extractRateLimitInfo(response) {
-        const limit = response.headers.get('x-ratelimit-limit');
-        const remaining = response.headers.get('x-ratelimit-remaining');
-        const reset = response.headers.get('x-ratelimit-reset');
-        if (limit && remaining && reset) {
-            this.lastRateLimitInfo = {
-                limit: parseInt(limit, 10),
-                remaining: parseInt(remaining, 10),
-                reset: parseInt(reset, 10),
-            };
-        }
-    }
-    /**
-     * Handle error responses by throwing appropriate error types
-     */
-    handleErrorResponse(status, data) {
-        const message = (data && data.message) || data.error || 'API Error';
-        switch (status) {
-            case 401:
-                throw new errors_1.AuthenticationError(message, data);
-            case 403:
-                throw new errors_1.AuthorizationError(message, data);
-            case 404:
-                throw new errors_1.NotFoundError(message, data);
-            case 422:
-                throw new errors_1.ValidationError(message, data);
-            case 429:
-                const retryAfter = data.retryAfter || 60;
-                throw new errors_1.RateLimitError(message, retryAfter, data);
-            case 500:
-            case 502:
-            case 503:
-            case 504:
-                throw new errors_1.ServerError(message, status, data);
-            default:
-                throw new errors_1.ForumAPIError(message, status, data);
-        }
-    }
-}
-exports.ForumClient = ForumClient;

package/dist/errors.d.ts

@@ -1,52 +0,0 @@
-/**
- * Base error class for all Foru.ms API errors
- */
-export declare class ForumAPIError extends Error {
-    statusCode: number;
-    response?: any;
-    constructor(message: string, statusCode: number, response?: any);
-}
-/**
- * Error thrown when authentication fails or token is invalid
- */
-export declare class AuthenticationError extends ForumAPIError {
-    constructor(message?: string, response?: any);
-}
-/**
- * Error thrown when user doesn't have permission for an action
- */
-export declare class AuthorizationError extends ForumAPIError {
-    constructor(message?: string, response?: any);
-}
-/**
- * Error thrown when a requested resource is not found
- */
-export declare class NotFoundError extends ForumAPIError {
-    constructor(message?: string, response?: any);
-}
-/**
- * Error thrown when request validation fails
- */
-export declare class ValidationError extends ForumAPIError {
-    constructor(message?: string, response?: any);
-}
-/**
- * Error thrown when rate limit is exceeded
- */
-export declare class RateLimitError extends ForumAPIError {
-    retryAfter?: number | undefined;
-    constructor(message?: string, retryAfter?: number | undefined, response?: any);
-}
-/**
- * Error thrown when server encounters an error
- */
-export declare class ServerError extends ForumAPIError {
-    constructor(message?: string, statusCode?: number, response?: any);
-}
-/**
- * Error thrown when network request fails
- */
-export declare class NetworkError extends Error {
-    cause?: Error | undefined;
-    constructor(message?: string, cause?: Error | undefined);
-}

package/dist/errors.js

@@ -1,95 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NetworkError = exports.ServerError = exports.RateLimitError = exports.ValidationError = exports.NotFoundError = exports.AuthorizationError = exports.AuthenticationError = exports.ForumAPIError = void 0;
-/**
- * Base error class for all Foru.ms API errors
- */
-class ForumAPIError extends Error {
-    constructor(message, statusCode, response) {
-        super(message);
-        this.statusCode = statusCode;
-        this.response = response;
-        this.name = 'ForumAPIError';
-        Object.setPrototypeOf(this, ForumAPIError.prototype);
-    }
-}
-exports.ForumAPIError = ForumAPIError;
-/**
- * Error thrown when authentication fails or token is invalid
- */
-class AuthenticationError extends ForumAPIError {
-    constructor(message = 'Authentication failed', response) {
-        super(message, 401, response);
-        this.name = 'AuthenticationError';
-        Object.setPrototypeOf(this, AuthenticationError.prototype);
-    }
-}
-exports.AuthenticationError = AuthenticationError;
-/**
- * Error thrown when user doesn't have permission for an action
- */
-class AuthorizationError extends ForumAPIError {
-    constructor(message = 'Permission denied', response) {
-        super(message, 403, response);
-        this.name = 'AuthorizationError';
-        Object.setPrototypeOf(this, AuthorizationError.prototype);
-    }
-}
-exports.AuthorizationError = AuthorizationError;
-/**
- * Error thrown when a requested resource is not found
- */
-class NotFoundError extends ForumAPIError {
-    constructor(message = 'Resource not found', response) {
-        super(message, 404, response);
-        this.name = 'NotFoundError';
-        Object.setPrototypeOf(this, NotFoundError.prototype);
-    }
-}
-exports.NotFoundError = NotFoundError;
-/**
- * Error thrown when request validation fails
- */
-class ValidationError extends ForumAPIError {
-    constructor(message = 'Validation failed', response) {
-        super(message, 422, response);
-        this.name = 'ValidationError';
-        Object.setPrototypeOf(this, ValidationError.prototype);
-    }
-}
-exports.ValidationError = ValidationError;
-/**
- * Error thrown when rate limit is exceeded
- */
-class RateLimitError extends ForumAPIError {
-    constructor(message = 'Rate limit exceeded', retryAfter, response) {
-        super(message, 429, response);
-        this.retryAfter = retryAfter;
-        this.name = 'RateLimitError';
-        Object.setPrototypeOf(this, RateLimitError.prototype);
-    }
-}
-exports.RateLimitError = RateLimitError;
-/**
- * Error thrown when server encounters an error
- */
-class ServerError extends ForumAPIError {
-    constructor(message = 'Server error', statusCode = 500, response) {
-        super(message, statusCode, response);
-        this.name = 'ServerError';
-        Object.setPrototypeOf(this, ServerError.prototype);
-    }
-}
-exports.ServerError = ServerError;
-/**
- * Error thrown when network request fails
- */
-class NetworkError extends Error {
-    constructor(message = 'Network request failed', cause) {
-        super(message);
-        this.cause = cause;
-        this.name = 'NetworkError';
-        Object.setPrototypeOf(this, NetworkError.prototype);
-    }
-}
-exports.NetworkError = NetworkError;

package/dist/index.d.ts

@@ -1,19 +0,0 @@
-export * from './Client';
-export * from './types';
-export * from './errors';
-export * from './response-types';
-export * from './utils';
-export * from './resources/Auth';
-export * from './resources/Threads';
-export * from './resources/Posts';
-export * from './resources/Users';
-export * from './resources/Tags';
-export * from './resources/Notifications';
-export * from './resources/Search';
-export * from './resources/Webhooks';
-export * from './resources/Stats';
-export * from './resources/Integrations';
-export * from './resources/PrivateMessages';
-export * from './resources/Reports';
-export * from './resources/Roles';
-export * from './resources/SSO';

package/dist/index.js

@@ -1,35 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Client"), exports);
-__exportStar(require("./types"), exports);
-__exportStar(require("./errors"), exports);
-__exportStar(require("./response-types"), exports);
-__exportStar(require("./utils"), exports);
-__exportStar(require("./resources/Auth"), exports);
-__exportStar(require("./resources/Threads"), exports);
-__exportStar(require("./resources/Posts"), exports);
-__exportStar(require("./resources/Users"), exports);
-__exportStar(require("./resources/Tags"), exports);
-__exportStar(require("./resources/Notifications"), exports);
-__exportStar(require("./resources/Search"), exports);
-__exportStar(require("./resources/Webhooks"), exports);
-__exportStar(require("./resources/Stats"), exports);
-__exportStar(require("./resources/Integrations"), exports);
-__exportStar(require("./resources/PrivateMessages"), exports);
-__exportStar(require("./resources/Reports"), exports);
-__exportStar(require("./resources/Roles"), exports);
-__exportStar(require("./resources/SSO"), exports);

package/dist/resources/Auth.d.ts

@@ -1,33 +0,0 @@
-import { ForumClient } from '../Client';
-import { LoginResponse, RegisterResponse } from '../types';
-export declare class AuthResource {
-    private client;
-    constructor(client: ForumClient);
-    login(payload: {
-        login: string;
-        password: string;
-    }): Promise<LoginResponse>;
-    register(payload: import('../types').RegisterPayload): Promise<RegisterResponse>;
-    me(): Promise<import('../types').User>;
-    forgotPassword(email: string): Promise<{
-        resetToken?: string;
-        message?: string;
-    }>;
-    resetPassword(payload: {
-        password: string;
-        oldPassword?: string;
-        email?: string;
-        token?: string;
-    }): Promise<{
-        message: string;
-    }>;
-    /**
-     * Get account security information for the authenticated user.
-     * This includes IP addresses, registration date, last seen timestamp, and verification status.
-     * Requires authentication token.
-     *
-     * @returns Promise<SecurityInfo> Security information including IPs and account activity
-     * @throws {ApiError} If not authenticated or user not found
-     */
-    getSecurity(): Promise<import('../types').SecurityInfo>;
-}

package/dist/resources/Auth.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthResource = void 0;
-class AuthResource {
-    constructor(client) {
-        this.client = client;
-    }
-    async login(payload) {
-        const response = await this.client.request('/auth/login', {
-            method: 'POST',
-            body: JSON.stringify(payload),
-        });
-        if (response.token) {
-            this.client.setToken(response.token);
-        }
-        return response;
-    }
-    async register(payload) {
-        const response = await this.client.request('/auth/register', {
-            method: 'POST',
-            body: JSON.stringify(payload),
-        });
-        if (response.token) {
-            this.client.setToken(response.token);
-        }
-        return response;
-    }
-    async me() {
-        return this.client.request('/auth/me', {
-            method: 'GET',
-        });
-    }
-    async forgotPassword(email) {
-        return this.client.request('/auth/forgot-password', {
-            method: 'POST',
-            body: JSON.stringify({ email }),
-        });
-    }
-    async resetPassword(payload) {
-        const headers = {};
-        if (payload.token) {
-            headers['Authorization'] = `Bearer ${payload.token}`;
-        }
-        // Remove token from body
-        const { token, ...body } = payload;
-        return this.client.request('/auth/reset-password', {
-            method: 'POST',
-            headers,
-            body: JSON.stringify(body),
-        });
-    }
-    /**
-     * Get account security information for the authenticated user.
-     * This includes IP addresses, registration date, last seen timestamp, and verification status.
-     * Requires authentication token.
-     *
-     * @returns Promise<SecurityInfo> Security information including IPs and account activity
-     * @throws {ApiError} If not authenticated or user not found
-     */
-    async getSecurity() {
-        return this.client.request('/auth/security', {
-            method: 'GET',
-        });
-    }
-}
-exports.AuthResource = AuthResource;

package/dist/resources/Integrations.d.ts

@@ -1,27 +0,0 @@
-import { ForumClient } from '../Client';
-import { Integration, IntegrationListResponse } from '../types';
-export declare class IntegrationsResource {
-    private client;
-    constructor(client: ForumClient);
-    list(): Promise<IntegrationListResponse>;
-    create(payload: {
-        type: 'SLACK' | 'DISCORD' | 'SALESFORCE' | 'HUBSPOT' | 'OKTA' | 'AUTH0';
-        name: string;
-        config: any;
-    }): Promise<{
-        integration: Integration;
-    }>;
-    retrieve(id: string): Promise<{
-        integration: Integration;
-    }>;
-    update(id: string, payload: {
-        name?: string;
-        config?: any;
-        active?: boolean;
-    }): Promise<{
-        integration: Integration;
-    }>;
-    delete(id: string): Promise<{
-        success: boolean;
-    }>;
-}

package/dist/resources/Integrations.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IntegrationsResource = void 0;
-class IntegrationsResource {
-    constructor(client) {
-        this.client = client;
-    }
-    async list() {
-        return this.client.request('/integrations', {
-            method: 'GET',
-        });
-    }
-    async create(payload) {
-        return this.client.request('/integrations', {
-            method: 'POST',
-            body: JSON.stringify(payload),
-        });
-    }
-    async retrieve(id) {
-        return this.client.request(`/integrations/${id}`, {
-            method: 'GET',
-        });
-    }
-    async update(id, payload) {
-        return this.client.request(`/integrations/${id}`, {
-            method: 'PATCH',
-            body: JSON.stringify(payload),
-        });
-    }
-    async delete(id) {
-        return this.client.request(`/integrations/${id}`, {
-            method: 'DELETE',
-        });
-    }
-}
-exports.IntegrationsResource = IntegrationsResource;