@eleven-am/pondsocket-client 0.0.6 → 0.0.7

package/dist.d.ts

@@ -0,0 +1,165 @@
+import {
+    PondEventMap,
+    JoinParams,
+    PondPresence,
+    PresencePayload,
+    PondMessage,
+    EventWithResponse,
+    PayloadForResponse,
+    ResponseForEvent, Unsubscribe,
+} from '@eleven-am/pondsocket-common';
+
+export enum ChannelState {
+    IDLE = 'IDLE',
+    JOINING = 'JOINING',
+    JOINED = 'JOINED',
+    STALLED = 'STALLED',
+    CLOSED = 'CLOSED',
+}
+
+declare class Channel<EventMap extends PondEventMap = PondEventMap> {
+    /**
+     * @desc Gets the current connection state of the channel.
+     */
+    get channelState (): ChannelState;
+
+    /**
+     * @desc Connects to the channel.
+     */
+    join (): void;
+
+    /**
+     * @desc Disconnects from the channel.
+     */
+    leave (): void;
+
+    /**
+     * @desc Monitors the channel for messages.
+     * @param callback - The callback to call when a message is received.
+     */
+    onMessage<Event extends keyof EventMap> (callback: (event: Event, message: EventMap[Event]) => void): import('@eleven-am/pondsocket-common/subjects/types').Unsubscribe;
+
+    /**
+     * @desc Monitors the channel for messages.
+     * @param event - The event to monitor.
+     * @param callback - The callback to call when a message is received.
+     */
+    onMessageEvent<Event extends keyof EventMap> (event: Event, callback: (message: EventMap[Event]) => void): import('@eleven-am/pondsocket-common/subjects/types').Unsubscribe;
+
+    /**
+     * @desc Monitors the channel state of the channel.
+     * @param callback - The callback to call when the connection state changes.
+     */
+    onChannelStateChange (callback: (connected: ChannelState) => void): import('@eleven-am/pondsocket-common/subjects/types').Unsubscribe;
+
+    /**
+     * @desc Detects when clients join the channel.
+     * @param callback - The callback to call when a client joins the channel.
+     */
+    onJoin (callback: (presence: PondPresence) => void): import('@eleven-am/pondsocket-common/subjects/types').Unsubscribe;
+
+    /**
+     * @desc Detects when clients leave the channel.
+     * @param callback - The callback to call when a client leaves the channel.
+     */
+    onLeave (callback: (presence: PondPresence) => void): import('@eleven-am/pondsocket-common/subjects/types').Unsubscribe;
+
+    /**
+     * @desc Detects when clients change their presence in the channel.
+     * @param callback - The callback to call when a client changes their presence in the channel.
+     */
+    onPresenceChange (callback: (presence: PresencePayload) => void): import('@eleven-am/pondsocket-common/subjects/types').Unsubscribe;
+
+    /**
+     * @desc Sends a message to specific clients in the channel.
+     * @param event - The event to send.
+     * @param payload - The message to send.
+     * @param recipient - The clients to send the message to.
+     */
+    sendMessage (event: string, payload: PondMessage, recipient: string[]): void;
+
+    /**
+     * @desc Sends a message to the server and waits for a response.
+     * @param sentEvent - The event to send.
+     * @param payload - The message to send.
+     */
+    sendForResponse<Event extends EventWithResponse<EventMap>> (sentEvent: Event, payload: PayloadForResponse<EventMap, Event>): Promise<ResponseForEvent<EventMap, Event>>;
+
+    /**
+     * @desc Broadcasts a message to every other client in the channel except yourself.
+     * @param event - The event to send.
+     * @param payload - The message to send.
+     */
+    broadcastFrom<Event extends keyof EventMap> (event: Event, payload: EventMap[Event]): void;
+
+    /**
+     * @desc Broadcasts a message to the channel, including yourself.
+     * @param event - The event to send.
+     * @param payload - The message to send.
+     */
+    broadcast<Event extends keyof EventMap> (event: Event, payload: EventMap[Event]): void;
+
+    /**
+     * @desc Gets the current presence of the channel.
+     */
+    getPresence (): PondPresence[];
+
+    /**
+     * @desc Monitors the presence of the channel.
+     * @param callback - The callback to call when the presence changes.
+     */
+    onUsersChange (callback: (users: PondPresence[]) => void): Unsubscribe;
+
+    /**
+     * @desc Checks if the channel is connected.
+     */
+    isConnected (): boolean;
+
+    /**
+     * @desc Checks if the channel is stalled.
+     */
+    isStalled (): boolean;
+
+    /**
+     * @desc Checks if the channel is closed.
+     */
+    isClosed (): boolean;
+
+    /**
+     * @desc Monitors the connection state of the channel.
+     * @param callback - The callback to call when the connection state changes.
+     */
+    onConnectionChange (callback: (connected: boolean) => void): Unsubscribe;
+}
+
+declare class PondClient {
+    constructor (endpoint: string, params?: Record<string, any>);
+
+    /**
+     * @desc Connects to the server and returns the socket.
+     */
+    connect (backoff?: number): void;
+
+    /**
+     * @desc Returns the current state of the socket.
+     */
+    getState (): boolean;
+
+    /**
+     * @desc Disconnects the socket.
+     */
+    disconnect (): void;
+
+    /**
+     * @desc Creates a channel with the given name and params.
+     * @param name - The name of the channel.
+     * @param params - The params to send to the server.
+     */
+    createChannel<EventType extends PondEventMap = PondEventMap> (name: string, params?: JoinParams): Channel<EventType>;
+
+    /**
+     * @desc Subscribes to the connection state.
+     * @param callback - The callback to call when the state changes.
+     */
+    onConnectionChange (callback: (state: boolean) => void): Unsubscribe;
+}

package/index.d.ts

@@ -1,3 +1,3 @@
-import { default as BrowserClient } from './browser/client';
-declare const _default: typeof BrowserClient;
-export default _default;
+import { PondClient } from './dist';
+
+export default PondClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eleven-am/pondsocket-client",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "PondSocket is a fast simple socket server",
   "keywords": [
     "socket",
@@ -24,9 +24,9 @@
     "build": "rimraf dist && tsc",
     "lint": "eslint --ext .ts src",
     "lint:fix": "eslint --fix --ext .ts src",
-    "copy": "cp package.json dist && cp README.md dist && cp LICENSE dist",
+    "copy": "cp package.json dist && cp README.md dist && cp LICENSE dist && cp src/index.d.ts dist && cp src/dist.d.ts dist",
     "push": "npm version patch && npm run copy && cd dist && npm publish && cd ..",
-    "pipeline": "npm run lint && npm run test && npm run build && npm run push"
+    "pipeline": "npm run test && npm run build && npm run push"
   },
   "dependencies": {
     "@eleven-am/pondsocket-common": "^0.0.6",

package/browser/client.d.ts

@@ -1,33 +0,0 @@
-import { SimpleSubject, SimpleBehaviorSubject, ChannelEvent, JoinParams } from '@eleven-am/pondsocket-common';
-import { Channel } from '../core/channel';
-export default class PondClient {
-    #private;
-    protected readonly _address: URL;
-    protected _socket: WebSocket | any | undefined;
-    protected readonly _broadcaster: SimpleSubject<ChannelEvent>;
-    protected readonly _connectionState: SimpleBehaviorSubject<boolean>;
-    constructor(endpoint: string, params?: Record<string, any>);
-    /**
-     * @desc Connects to the server and returns the socket.
-     */
-    connect(backoff?: number): void;
-    /**
-     * @desc Returns the current state of the socket.
-     */
-    getState(): boolean;
-    /**
-     * @desc Disconnects the socket.
-     */
-    disconnect(): void;
-    /**
-     * @desc Creates a channel with the given name and params.
-     * @param name - The name of the channel.
-     * @param params - The params to send to the server.
-     */
-    createChannel(name: string, params?: JoinParams): Channel<import("@eleven-am/pondsocket-common").PondEventMap>;
-    /**
-     * @desc Subscribes to the connection state.
-     * @param callback - The callback to call when the state changes.
-     */
-    onConnectionChange(callback: (state: boolean) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-}

package/browser/client.test.d.ts

@@ -1 +0,0 @@
-export {};

package/core/channel.d.ts

@@ -1,100 +0,0 @@
-import { SimpleSubject, SimpleBehaviorSubject, ChannelState, JoinParams, ChannelEvent, PondPresence, PondMessage, PresencePayload, PondEventMap, EventWithResponse, PayloadForResponse, ResponseForEvent } from '@eleven-am/pondsocket-common';
-import { Publisher } from '../types';
-export declare class Channel<EventMap extends PondEventMap = PondEventMap> {
-    #private;
-    constructor(publisher: Publisher, clientState: SimpleBehaviorSubject<boolean>, name: string, receiver: SimpleSubject<ChannelEvent>, params: JoinParams);
-    /**
-     * @desc Gets the current connection state of the channel.
-     */
-    get channelState(): ChannelState;
-    /**
-     * @desc Connects to the channel.
-     */
-    join(): void;
-    /**
-     * @desc Disconnects from the channel.
-     */
-    leave(): void;
-    /**
-     * @desc Monitors the channel for messages.
-     * @param callback - The callback to call when a message is received.
-     */
-    onMessage<Event extends keyof EventMap>(callback: (event: Event, message: EventMap[Event]) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Monitors the channel for messages.
-     * @param event - The event to monitor.
-     * @param callback - The callback to call when a message is received.
-     */
-    onMessageEvent<Event extends keyof EventMap>(event: Event, callback: (message: EventMap[Event]) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Monitors the channel state of the channel.
-     * @param callback - The callback to call when the connection state changes.
-     */
-    onChannelStateChange(callback: (connected: ChannelState) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Detects when clients join the channel.
-     * @param callback - The callback to call when a client joins the channel.
-     */
-    onJoin(callback: (presence: PondPresence) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Detects when clients leave the channel.
-     * @param callback - The callback to call when a client leaves the channel.
-     */
-    onLeave(callback: (presence: PondPresence) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Detects when clients change their presence in the channel.
-     * @param callback - The callback to call when a client changes their presence in the channel.
-     */
-    onPresenceChange(callback: (presence: PresencePayload) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Sends a message to specific clients in the channel.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     * @param recipient - The clients to send the message to.
-     */
-    sendMessage(event: string, payload: PondMessage, recipient: string[]): void;
-    /**
-     * @desc Sends a message to the server and waits for a response.
-     * @param sentEvent - The event to send.
-     * @param payload - The message to send.
-     */
-    sendForResponse<Event extends EventWithResponse<EventMap>>(sentEvent: Event, payload: PayloadForResponse<EventMap, Event>): Promise<ResponseForEvent<EventMap, Event>>;
-    /**
-     * @desc Broadcasts a message to every other client in the channel except yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcastFrom<Event extends keyof EventMap>(event: Event, payload: EventMap[Event]): void;
-    /**
-     * @desc Broadcasts a message to the channel, including yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcast<Event extends keyof EventMap>(event: Event, payload: EventMap[Event]): void;
-    /**
-     * @desc Gets the current presence of the channel.
-     */
-    getPresence(): PondPresence[];
-    /**
-     * @desc Monitors the presence of the channel.
-     * @param callback - The callback to call when the presence changes.
-     */
-    onUsersChange(callback: (users: PondPresence[]) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-    /**
-     * @desc Checks if the channel is connected.
-     */
-    isConnected(): boolean;
-    /**
-     * @desc Checks if the channel is stalled.
-     */
-    isStalled(): boolean;
-    /**
-     * @desc Checks if the channel is closed.
-     */
-    isClosed(): boolean;
-    /**
-     * @desc Monitors the connection state of the channel.
-     * @param callback - The callback to call when the connection state changes.
-     */
-    onConnectionChange(callback: (connected: boolean) => void): import("@eleven-am/pondsocket-common/subjects/types").Unsubscribe;
-}

package/core/channel.test.d.ts

@@ -1 +0,0 @@
-export {};

package/node/node.d.ts

@@ -1,7 +0,0 @@
-import PondSocketClient from '../browser/client';
-export default class PondClient extends PondSocketClient {
-    /**
-     * @desc Connects to the server and returns the socket.
-     */
-    connect(backoff?: number): void;
-}

package/types.d.ts

@@ -1,10 +0,0 @@
-import { ChannelReceivers, ClientActions, PondMessage } from '@eleven-am/pondsocket-common';
-export interface ClientMessage {
-    addresses: ChannelReceivers | string[];
-    action: ClientActions;
-    event: string;
-    payload: PondMessage;
-    channelName: string;
-    requestId: string;
-}
-export type Publisher = (data: ClientMessage) => void;