@eleven-am/pondsocket 0.1.11 → 0.1.13

package/pondBase/simpleBase.d.ts

@@ -1,126 +0,0 @@
-export declare class PondDocument<T> {
-    constructor(id: string, removeDoc: () => void, updateDoc: (value: T) => PondDocument<T>, getDoc: () => T);
-
-    get id(): string;
-
-    get doc(): T;
-
-    /**
-     * @desc Removes the document from the collection
-     */
-    removeDoc(): T;
-
-    /**
-     * @desc Updates the document in the collection
-     * @param value - the new value of the document
-     */
-    updateDoc(value: T): this;
-}
-
-declare type UpdateCallback<T> = (data: {
-    oldValue: T | null; currentValue: T | null;
-}) => void;
-
-export declare class SimpleBase<T> {
-    constructor(callbacks?: UpdateCallback<T>);
-
-    /**
-     * @desc Get the number of documents
-     */
-    get size(): number;
-
-    /**
-     * @desc Get all the documents in the database
-     */
-    get all(): PondDocument<T>[];
-
-    /**
-     * @desc Gets all the keys of the database
-     */
-    get keys(): string[];
-
-    /**
-     * @desc Gets all the values of the database
-     */
-    get values(): T[];
-
-    /**
-     * @desc Makes the database iterable
-     */
-    [Symbol.iterator](): IterableIterator<PondDocument<T>>;
-
-    /**
-     * @desc Create a generator for the pond
-     */
-    generator(): Generator<PondDocument<T>>;
-
-    /**
-     * @desc Get a document by key
-     * @param key - The key of the document
-     */
-    get(key: string): PondDocument<T> | null;
-
-    /**
-     * @desc getOrCreate a document in the database
-     * @param key - The key of the document
-     * @param creator - The function to create the document
-     */
-    getOrCreate(key: string, creator: (doc: Readonly<PondDocument<T>>) => T): PondDocument<T>;
-
-    /**
-     * @desc Upsert a document in the database
-     * @param key - The key of the document
-     * @param value - The value of the document
-     */
-    upsert(key: string, value: T): PondDocument<T>;
-
-    /**
-     * @desc checks if a document exists
-     * @param key - The key of the document
-     */
-    has(key: string): boolean;
-
-    /**
-     * @desc Set a document to the database
-     * @param key - The key of the document
-     * @param value - The value of the document
-     */
-    set(key: string, value: T): PondDocument<T>;
-
-    /**
-     * @desc Find a document by a query function
-     * @param query - The query function
-     */
-    find(query: (doc: T, id: string) => boolean): PondDocument<T> | null;
-
-    /**
-     * @desc Map the pond to a new array
-     * @param mapper - The mapper function
-     */
-    map<U>(mapper: (doc: T, id: string) => U): U[];
-
-    /**
-     * @desc Filters the pond using a query function
-     * @param query - The query function
-     */
-    filter(query: (doc: T, id: string) => boolean): PondDocument<T>[];
-
-    /**
-     * @desc Reduce the pond to a single value
-     * @param reducer - The reducer function
-     * @param initialValue - The initial value of the reducer
-     */
-    reduce<U>(reducer: (accumulator: U, currentValue: T) => U, initialValue: U): U;
-
-    /**
-     * @desc Generate a generic pond document
-     * @param id - The id of the document
-     */
-    createGenericDocument(id?: string): PondDocument<T>;
-
-    /**
-     * @desc Gets the raw database
-     * @protected
-     */
-    protected _getDB(): Record<string, T>;
-}

package/pondBase/simpleBase.js

@@ -1,211 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SimpleBase = exports.PondDocument = void 0;
-class PondDocument {
-    constructor(id, removeDoc, updateDoc, getDoc) {
-        this._removeDoc = removeDoc;
-        this._updateDoc = updateDoc;
-        this._getDoc = getDoc;
-        this._id = id;
-    }
-    get id() {
-        return this._id;
-    }
-    get doc() {
-        return this._getDoc();
-    }
-    /**
-     * @desc Removes the document from the collection
-     */
-    removeDoc() {
-        const doc = this._getDoc();
-        this._removeDoc();
-        return doc;
-    }
-    /**
-     * @desc Updates the document in the collection
-     * @param value - the new value of the document
-     */
-    updateDoc(value) {
-        this._updateDoc(value);
-        return this;
-    }
-}
-exports.PondDocument = PondDocument;
-class SimpleBase {
-    constructor(callbacks) {
-        this._db = {};
-        this._update = callbacks || null;
-    }
-    /**
-     * @desc Get the number of documents
-     */
-    get size() {
-        return Object.keys(this._db).length;
-    }
-    /**
-     * @desc Get all the documents in the database
-     */
-    get all() {
-        return Object.keys(this._db).map(this._createPondDocument.bind(this));
-    }
-    /**
-     * @desc Makes the database iterable
-     */
-    [Symbol.iterator]() {
-        return this.all[Symbol.iterator]();
-    }
-    /**
-     * @desc Create a generator for the pond
-     */
-    *generator() {
-        for (const key in this._db) {
-            yield this._createPondDocument(key);
-        }
-    }
-    /**
-     * @desc Get a document by key
-     * @param key - The key of the document
-     */
-    get(key) {
-        const doc = this._db[key];
-        if (doc)
-            return this._createPondDocument(key);
-        return null;
-    }
-    /**
-     * @desc getOrCreate a document in the database
-     * @param key - The key of the document
-     * @param creator - The function to create the document
-     */
-    getOrCreate(key, creator) {
-        const doc = this.get(key);
-        if (doc)
-            return doc;
-        return this.set(key, creator(this._createPondDocument(key)));
-    }
-    /**
-     * @desc Upsert a document in the database
-     * @param key - The key of the document
-     * @param value - The value of the document
-     */
-    upsert(key, value) {
-        const doc = this.get(key);
-        if (doc)
-            return doc.updateDoc(value);
-        return this.set(key, value);
-    }
-    /**
-     * @desc checks if a document exists
-     * @param key - The key of the document
-     */
-    has(key) {
-        return this._db[key] !== undefined;
-    }
-    /**
-     * @desc Set a document to the database
-     * @param key - The key of the document
-     * @param value - The value of the document
-     */
-    set(key, value) {
-        var _a;
-        const oldValue = this._db[key] || null;
-        this._db[key] = value;
-        (_a = this._update) === null || _a === void 0 ? void 0 : _a.call(this, { oldValue, currentValue: value });
-        return this._createPondDocument(key);
-    }
-    /**
-     * @desc Find a document by a query function
-     * @param query - The query function
-     */
-    find(query) {
-        for (const key in this._db) {
-            const doc = this._db[key];
-            if (query(doc, key))
-                return this._createPondDocument(key);
-        }
-        return null;
-    }
-    /**
-     * @desc Map the pond to a new array
-     * @param mapper - The mapper function
-     */
-    map(mapper) {
-        return Object.keys(this._db).map(key => mapper(this._db[key], key));
-    }
-    /**
-     * @desc Filters the pond using a query function
-     * @param query - The query function
-     */
-    filter(query) {
-        return Object.keys(this._db)
-            .filter(key => query(this._db[key], key))
-            .map(this._createPondDocument.bind(this));
-    }
-    /**
-     * @desc Reduce the pond to a single value
-     * @param reducer - The reducer function
-     * @param initialValue - The initial value of the reducer
-     */
-    reduce(reducer, initialValue) {
-        return Object.values(this._db).reduce(reducer, initialValue);
-    }
-    /**
-     * @desc Gets all the keys of the database
-     */
-    get keys() {
-        return Object.keys(this._db);
-    }
-    /**
-     * @desc Gets all the values of the database
-     */
-    get values() {
-        return Object.values(this._db);
-    }
-    /**
-     * @desc Generate a generic pond document
-     * @param id - The id of the document
-     */
-    createGenericDocument(id) {
-        const idValue = id || Math.random().toString(36).substr(2, 9);
-        return this._createPondDocument(idValue);
-    }
-    /**
-     * @desc Delete a document by key
-     */
-    _delete(key) {
-        var _a;
-        const oldValue = this._db[key];
-        delete this._db[key];
-        (_a = this._update) === null || _a === void 0 ? void 0 : _a.call(this, { oldValue, currentValue: null });
-    }
-    /**
-     * @desc Retrieve a document from the database
-     * @param key - The key of the document
-     */
-    _getDocument(key) {
-        const data = this._db[key];
-        if (!data)
-            return null;
-        return data;
-    }
-    /**
-     * @desc Create a pond document
-     * @param id - The id of the document
-     * @private
-     */
-    _createPondDocument(id) {
-        const removeDoc = this._delete.bind(this, id);
-        const updateDoc = this.set.bind(this, id);
-        const getDoc = this._getDocument.bind(this, id);
-        return new PondDocument(id, removeDoc, updateDoc, getDoc);
-    }
-    /**
-     * @desc Gets the raw database
-     * @protected
-     */
-    _getDB() {
-        return this._db;
-    }
-}
-exports.SimpleBase = SimpleBase;

package/pondBase/simpleBase.test.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const simpleBase_1 = require("./simpleBase");
-describe('SimpleBase', () => {
-    it('should ba instantiated', () => {
-        const base = new simpleBase_1.SimpleBase();
-        expect(base).toBeTruthy();
-    });
-    it('should set a value', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        expect(base.size).toBe(1);
-    });
-    it('should get a value', () => {
-        var _a;
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        expect((_a = base.get('test')) === null || _a === void 0 ? void 0 : _a.doc).toStrictEqual({ name: 'test' });
-    });
-    it('should upsert a value', () => {
-        var _a, _b;
-        const base = new simpleBase_1.SimpleBase();
-        expect((_a = base.get('test')) === null || _a === void 0 ? void 0 : _a.doc).toBeUndefined();
-        expect(base.size).toBe(0);
-        base.getOrCreate('test', () => ({ name: 'test' }));
-        expect(base.size).toBe(1);
-        expect((_b = base.get('test')) === null || _b === void 0 ? void 0 : _b.doc).toStrictEqual({ name: 'test' });
-    });
-    it('should tell if a document exists', () => {
-        const base = new simpleBase_1.SimpleBase();
-        expect(base.has('test')).toBe(false);
-        base.set('test', { name: 'test' });
-        expect(base.has('test')).toBe(true);
-    });
-    it('should return an array of filtered documents', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect(base.filter(doc => doc.name === 'test').map(doc => doc.doc.name)).toEqual(['test']);
-    });
-    it('should return an array of mapped documents', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect(base.map(doc => doc.name)).toEqual(['test', 'test2', 'test3']);
-    });
-    it('should return an empty array of  documents', () => {
-        const base = new simpleBase_1.SimpleBase();
-        expect(base.map(doc => doc.name)).toEqual([]);
-        expect(base.filter(doc => doc.name === 'test').map(doc => doc.doc.name)).toEqual([]);
-    });
-    it('should return a document by a query function', () => {
-        var _a;
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect((_a = base.find(doc => doc.name === 'test2')) === null || _a === void 0 ? void 0 : _a.doc.name).toBe('test2');
-    });
-    it('should return null if no document is found by a query function', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect(base.find(doc => doc.name === 'test4')).toBeNull();
-    });
-    it('should reduce the pond to a single value', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect(base.reduce((acc, doc) => acc + doc.name, '')).toBe('testtest2test3');
-    });
-    it('should return the size of the pond', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect(base.size).toBe(3);
-    });
-    it('should provide an empty document', () => {
-        const base = new simpleBase_1.SimpleBase();
-        const test = base.createGenericDocument();
-        expect(test).toBeInstanceOf(simpleBase_1.PondDocument);
-        expect(test.doc).toBeNull();
-    });
-    it('should provide a document with a value', () => {
-        const base = new simpleBase_1.SimpleBase();
-        const test = base.createGenericDocument('test');
-        expect(base.size).toBe(0);
-        expect(test).toBeInstanceOf(simpleBase_1.PondDocument);
-        expect(test.id).toBe('test');
-    });
-    it('should be iterable', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        expect([...base].map(doc => doc.doc.name)).toEqual(['test', 'test2', 'test3']);
-    });
-    it('should be iterable with a for of loop', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        const docs = [];
-        for (const doc of base) {
-            docs.push(doc.doc.name);
-        }
-        expect(docs).toEqual(['test', 'test2', 'test3']);
-    });
-    it('should be have a generator', () => {
-        const base = new simpleBase_1.SimpleBase();
-        base.set('test', { name: 'test' });
-        base.set('test2', { name: 'test2' });
-        base.set('test3', { name: 'test3' });
-        const docs = [];
-        for (const doc of base.generator()) {
-            docs.push(doc.doc.name);
-        }
-        expect(docs).toEqual(['test', 'test2', 'test3']);
-    });
-});
-describe('PondDocument', () => {
-    it('should be able to set a value', () => {
-        var _a;
-        const base = new simpleBase_1.SimpleBase();
-        const test = base.createGenericDocument('test');
-        test.updateDoc({ name: 'test' });
-        expect((_a = base.get('test')) === null || _a === void 0 ? void 0 : _a.doc).toStrictEqual({ name: 'test' });
-    });
-    it('should be able to get a value', () => {
-        const base = new simpleBase_1.SimpleBase();
-        const test = base.createGenericDocument('test');
-        test.updateDoc({ name: 'test' });
-        expect(test.doc).toStrictEqual({ name: 'test' });
-    });
-    it('should be able to delete a value', () => {
-        const base = new simpleBase_1.SimpleBase();
-        const test = base.createGenericDocument('test');
-        test.updateDoc({ name: 'test' });
-        expect(base.size).toBe(1);
-        test.removeDoc();
-        expect(base.size).toBe(0);
-    });
-    it('should be able to get the id', () => {
-        const base = new simpleBase_1.SimpleBase();
-        const test = base.createGenericDocument('test');
-        expect(test.id).toBe('test');
-    });
-});

package/pondBase/types.d.ts

@@ -1,2 +0,0 @@
-export declare type default_t<T = any> = Record<string, T>;
-export declare type PondPath = string | RegExp;

package/pondBase/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/pondClient/channel.d.ts

@@ -1,77 +0,0 @@
-import {ClientMessage, PondAssigns, PondMessage, PondPresence, ServerMessage} from "../pondSocket";
-import {Broadcast, Subscription} from "../pondBase";
-
-export declare type ChannelParams = PondAssigns;
-
-export declare class Channel {
-
-    constructor(name: string, receiver: Broadcast<ServerMessage, void>, broadcaster: Broadcast<ClientMessage, void>, params?: ChannelParams);
-
-    /**
-     * @desc Gets the current presence state of the channel.
-     */
-    get presence(): PondPresence[];
-
-    /**
-     * @desc Connects to the channel.
-     */
-    join(): void;
-
-    /**
-     * @desc Disconnects from the channel.
-     */
-    leave(): void;
-
-    /**
-     * @desc Monitors the channel for messages.
-     * @param event - The event to monitor.
-     * @param callback - The callback to call when a message is received.
-     */
-    onMessage(event: string, callback: (message: PondMessage) => void): Subscription;
-
-    /**
-     * @desc Broadcasts a message to the channel, including yourself.
-     * @param event - The event to send.
-     * @param payload - The message to send.
-     */
-    broadcast(event: string, payload: PondMessage): void;
-
-    /**
-     * @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: string, payload: PondMessage): void;
-
-    /**
-     * @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 Updates the presence state of the current client in the channel.
-     * @param presence - The presence state to update.
-     */
-    updatePresence(presence: PondPresence): void;
-
-    /**
-     * @desc Detects when clients join the channel.
-     * @param callback - The callback to call when a client joins the channel.
-     */
-    onJoin(callback: (presence: PondPresence) => void): Subscription;
-
-    /**
-     * @desc Detects when clients leave the channel.
-     * @param callback - The callback to call when a client leaves the channel.
-     */
-    onLeave(callback: (presence: PondPresence) => void): Subscription;
-
-    /**
-     * @desc Monitors the connection state of the channel.
-     * @param callback - The callback to call when the connection state changes.
-     */
-    onConnectionChange(callback: (connected: boolean) => void): Subscription;
-}