@pushflodev/sdk 1.0.1

package/dist/PushFloClient-ny0iyTYJ.d.ts

@@ -0,0 +1,102 @@
+import { a as ConnectionInfo, M as Message, C as ClientOptions, b as ConnectionState, e as SubscriptionOptions, S as Subscription } from './message-CVgilLwz.js';
+
+/**
+ * Type-safe event emitter with zero dependencies
+ */
+type EventMap = {
+    [key: string]: unknown[];
+};
+type EventHandler<T extends unknown[]> = (...args: T) => void;
+declare class TypedEventEmitter<Events extends EventMap> {
+    private listeners;
+    /**
+     * Register an event listener
+     */
+    on<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
+    /**
+     * Register a one-time event listener
+     */
+    once<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
+    /**
+     * Remove an event listener
+     */
+    off<K extends keyof Events>(event: K, handler: EventHandler<Events[K]>): this;
+    /**
+     * Emit an event to all registered listeners
+     */
+    protected emit<K extends keyof Events>(event: K, ...args: Events[K]): boolean;
+    /**
+     * Remove all listeners for an event, or all listeners if no event specified
+     */
+    removeAllListeners<K extends keyof Events>(event?: K): this;
+    /**
+     * Get the number of listeners for an event
+     */
+    listenerCount<K extends keyof Events>(event: K): number;
+    /**
+     * Get all event names with registered listeners
+     */
+    eventNames(): (keyof Events)[];
+}
+
+interface PushFloClientEvents {
+    [key: string]: unknown[];
+    connected: [ConnectionInfo];
+    disconnected: [reason?: string];
+    message: [Message];
+    error: [Error];
+}
+/**
+ * Browser client for PushFlo real-time messaging
+ */
+declare class PushFloClient extends TypedEventEmitter<PushFloClientEvents> {
+    private readonly wsManager;
+    private readonly subscriptions;
+    private readonly logger;
+    private connectionChangeListeners;
+    constructor(options: ClientOptions);
+    /**
+     * Get current connection state
+     */
+    get connectionState(): ConnectionState;
+    /**
+     * Get client ID (available after connected)
+     */
+    get clientId(): string | null;
+    /**
+     * Connect to PushFlo
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnect from PushFlo
+     */
+    disconnect(): void;
+    /**
+     * Clean up all resources
+     */
+    destroy(): void;
+    /**
+     * Subscribe to a channel
+     */
+    subscribe(channel: string, options?: SubscriptionOptions): Subscription;
+    /**
+     * Unsubscribe from a channel
+     */
+    unsubscribe(channel: string): void;
+    /**
+     * Register a connection state change listener
+     */
+    onConnectionChange(listener: (state: ConnectionState) => void): () => void;
+    /**
+     * Get list of subscribed channels
+     */
+    getSubscribedChannels(): string[];
+    /**
+     * Check if subscribed to a channel
+     */
+    isSubscribed(channel: string): boolean;
+    private setupEventHandlers;
+    private handleServerMessage;
+}
+
+export { PushFloClient as P };

package/dist/api-DYrG_5uC.d.cts

@@ -0,0 +1,149 @@
+/**
+ * Base error class for all PushFlo SDK errors
+ */
+declare class PushFloError extends Error {
+    /** Error code for programmatic handling */
+    readonly code: string;
+    /** Whether this error is potentially recoverable through retry */
+    readonly retryable: boolean;
+    /** Original error that caused this error, if any */
+    readonly cause?: Error;
+    constructor(message: string, code: string, options?: {
+        retryable?: boolean;
+        cause?: Error;
+    });
+    /**
+     * Convert error to JSON-serializable object
+     */
+    toJSON(): Record<string, unknown>;
+    /**
+     * Create a string representation
+     */
+    toString(): string;
+}
+
+/**
+ * Error thrown when authentication fails
+ */
+declare class AuthenticationError extends PushFloError {
+    constructor(message: string, code?: string, options?: {
+        retryable?: boolean;
+        cause?: Error;
+    });
+    /**
+     * Create an invalid API key error
+     */
+    static invalidKey(keyType?: string): AuthenticationError;
+    /**
+     * Create an unauthorized error
+     */
+    static unauthorized(reason?: string): AuthenticationError;
+    /**
+     * Create a forbidden error
+     */
+    static forbidden(action?: string): AuthenticationError;
+}
+
+/**
+ * Error thrown for network-related failures
+ */
+declare class NetworkError extends PushFloError {
+    /** HTTP status code, if applicable */
+    readonly statusCode?: number;
+    constructor(message: string, code?: string, options?: {
+        retryable?: boolean;
+        cause?: Error;
+        statusCode?: number;
+    });
+    /**
+     * Create a network error from fetch failure
+     */
+    static fromFetch(cause: Error): NetworkError;
+    /**
+     * Create a request timeout error
+     */
+    static timeout(timeoutMs: number): NetworkError;
+    /**
+     * Create an error from HTTP status code
+     */
+    static fromStatus(statusCode: number, message?: string): NetworkError;
+    private static getStatusMessage;
+    toJSON(): Record<string, unknown>;
+}
+
+/**
+ * A PushFlo channel
+ */
+interface Channel {
+    /** Unique channel ID */
+    id: string;
+    /** Human-readable channel name */
+    name: string;
+    /** URL-safe channel identifier (used for subscriptions) */
+    slug: string;
+    /** Optional channel description */
+    description: string | null;
+    /** Whether the channel requires authentication */
+    isPrivate: boolean;
+    /** Custom metadata attached to the channel */
+    metadata: Record<string, unknown> | null;
+    /** Total number of messages in the channel */
+    messageCount: number;
+    /** ISO 8601 timestamp of creation */
+    createdAt: string;
+    /** ISO 8601 timestamp of last update */
+    updatedAt: string;
+}
+/**
+ * Input for creating a new channel
+ */
+interface ChannelInput {
+    /** Human-readable channel name */
+    name: string;
+    /** URL-safe channel identifier */
+    slug: string;
+    /** Optional channel description */
+    description?: string;
+    /** Whether the channel requires authentication */
+    isPrivate?: boolean;
+    /** Custom metadata to attach to the channel */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Input for updating an existing channel
+ */
+interface ChannelUpdateInput {
+    /** Human-readable channel name */
+    name?: string;
+    /** Optional channel description */
+    description?: string | null;
+    /** Whether the channel requires authentication */
+    isPrivate?: boolean;
+    /** Custom metadata to attach to the channel */
+    metadata?: Record<string, unknown> | null;
+}
+/**
+ * Options for listing channels
+ */
+interface ListChannelsOptions {
+    /** Page number (1-indexed) */
+    page?: number;
+    /** Number of items per page */
+    pageSize?: number;
+}
+
+/**
+ * Pagination metadata for list responses
+ */
+interface Pagination {
+    /** Current page number (1-indexed) */
+    page: number;
+    /** Number of items per page */
+    pageSize: number;
+    /** Total number of items */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+
+export { AuthenticationError as A, type Channel as C, type ListChannelsOptions as L, NetworkError as N, PushFloError as P, type ChannelInput as a, type ChannelUpdateInput as b, type Pagination as c };

package/dist/api-DYrG_5uC.d.ts

@@ -0,0 +1,149 @@
+/**
+ * Base error class for all PushFlo SDK errors
+ */
+declare class PushFloError extends Error {
+    /** Error code for programmatic handling */
+    readonly code: string;
+    /** Whether this error is potentially recoverable through retry */
+    readonly retryable: boolean;
+    /** Original error that caused this error, if any */
+    readonly cause?: Error;
+    constructor(message: string, code: string, options?: {
+        retryable?: boolean;
+        cause?: Error;
+    });
+    /**
+     * Convert error to JSON-serializable object
+     */
+    toJSON(): Record<string, unknown>;
+    /**
+     * Create a string representation
+     */
+    toString(): string;
+}
+
+/**
+ * Error thrown when authentication fails
+ */
+declare class AuthenticationError extends PushFloError {
+    constructor(message: string, code?: string, options?: {
+        retryable?: boolean;
+        cause?: Error;
+    });
+    /**
+     * Create an invalid API key error
+     */
+    static invalidKey(keyType?: string): AuthenticationError;
+    /**
+     * Create an unauthorized error
+     */
+    static unauthorized(reason?: string): AuthenticationError;
+    /**
+     * Create a forbidden error
+     */
+    static forbidden(action?: string): AuthenticationError;
+}
+
+/**
+ * Error thrown for network-related failures
+ */
+declare class NetworkError extends PushFloError {
+    /** HTTP status code, if applicable */
+    readonly statusCode?: number;
+    constructor(message: string, code?: string, options?: {
+        retryable?: boolean;
+        cause?: Error;
+        statusCode?: number;
+    });
+    /**
+     * Create a network error from fetch failure
+     */
+    static fromFetch(cause: Error): NetworkError;
+    /**
+     * Create a request timeout error
+     */
+    static timeout(timeoutMs: number): NetworkError;
+    /**
+     * Create an error from HTTP status code
+     */
+    static fromStatus(statusCode: number, message?: string): NetworkError;
+    private static getStatusMessage;
+    toJSON(): Record<string, unknown>;
+}
+
+/**
+ * A PushFlo channel
+ */
+interface Channel {
+    /** Unique channel ID */
+    id: string;
+    /** Human-readable channel name */
+    name: string;
+    /** URL-safe channel identifier (used for subscriptions) */
+    slug: string;
+    /** Optional channel description */
+    description: string | null;
+    /** Whether the channel requires authentication */
+    isPrivate: boolean;
+    /** Custom metadata attached to the channel */
+    metadata: Record<string, unknown> | null;
+    /** Total number of messages in the channel */
+    messageCount: number;
+    /** ISO 8601 timestamp of creation */
+    createdAt: string;
+    /** ISO 8601 timestamp of last update */
+    updatedAt: string;
+}
+/**
+ * Input for creating a new channel
+ */
+interface ChannelInput {
+    /** Human-readable channel name */
+    name: string;
+    /** URL-safe channel identifier */
+    slug: string;
+    /** Optional channel description */
+    description?: string;
+    /** Whether the channel requires authentication */
+    isPrivate?: boolean;
+    /** Custom metadata to attach to the channel */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Input for updating an existing channel
+ */
+interface ChannelUpdateInput {
+    /** Human-readable channel name */
+    name?: string;
+    /** Optional channel description */
+    description?: string | null;
+    /** Whether the channel requires authentication */
+    isPrivate?: boolean;
+    /** Custom metadata to attach to the channel */
+    metadata?: Record<string, unknown> | null;
+}
+/**
+ * Options for listing channels
+ */
+interface ListChannelsOptions {
+    /** Page number (1-indexed) */
+    page?: number;
+    /** Number of items per page */
+    pageSize?: number;
+}
+
+/**
+ * Pagination metadata for list responses
+ */
+interface Pagination {
+    /** Current page number (1-indexed) */
+    page: number;
+    /** Number of items per page */
+    pageSize: number;
+    /** Total number of items */
+    total: number;
+    /** Total number of pages */
+    totalPages: number;
+}
+
+export { AuthenticationError as A, type Channel as C, type ListChannelsOptions as L, NetworkError as N, PushFloError as P, type ChannelInput as a, type ChannelUpdateInput as b, type Pagination as c };