@eleven-am/pondsocket-client 0.0.5 → 0.0.7

package/README.md

@@ -30,18 +30,6 @@ const endpoint = pond.createEndpoint('/api/socket', (req, res) => {
 
 // Start the server
 pond.listen(3000);
-
-// Or alternatively, working with express
-import pondSocket from "@eleven-am/pondsocket/express";
-import express from "express";
-
-const app = pondSocket(express());
-
-const endpoint = app.upgrade('/api/socket', (req, res) => {
-    // Handle socket connection and authentication
-});
-
-app.listen(3000);
 ```
 
 Within each endpoint, sockets interact through channels. Channels provide an organized way to group users and manage efficient communication among them. When users join a channel, they can participate in real-time events and exchange information with other users in the same channel.

package/{core/channel.d.ts → dist.d.ts}

@@ -1,15 +1,23 @@
 import {
-    ChannelState,
+    PondEventMap,
+    JoinParams,
     PondPresence,
-    PondMessage,
     PresencePayload,
-    PondEventMap,
+    PondMessage,
     EventWithResponse,
     PayloadForResponse,
-    ResponseForEvent,
+    ResponseForEvent, Unsubscribe,
 } from '@eleven-am/pondsocket-common';
 
-export declare class Channel<EventMap extends PondEventMap = PondEventMap> {
+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.
      */
@@ -100,7 +108,7 @@ export declare class Channel<EventMap extends PondEventMap = PondEventMap> {
      * @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;
+    onUsersChange (callback: (users: PondPresence[]) => void): Unsubscribe;
 
     /**
      * @desc Checks if the channel is connected.
@@ -121,5 +129,37 @@ export declare class Channel<EventMap extends PondEventMap = PondEventMap> {
      * @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;
+    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.5",
+  "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,34 +0,0 @@
-import { JoinParams } from '@eleven-am/pondsocket-common';
-import { Channel } from '../core/channel';
-
-export default 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 (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.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;