@casual-simulation/websocket 2.0.30

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Casual Simulation, Inc.
+
+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/README.md

@@ -0,0 +1,121 @@
+# undom
+
+[![NPM](https://img.shields.io/npm/v/undom.svg?style=flat)](https://www.npmjs.org/package/undom)
+[![travis-ci](https://travis-ci.org/developit/undom.svg?branch=master)](https://travis-ci.org/developit/undom)
+
+### **Minimally viable DOM Document implementation**
+
+> A bare-bones HTML DOM in a box. If you want the DOM but not a parser, this might be for you.
+>
+> `1kB`, works in Node and browsers, plugins coming soon!
+
+[**JSFiddle Demo:**](https://jsfiddle.net/developit/4qv3v6r3/) Rendering [preact](https://github.com/developit/preact/) components into an undom Document.
+
+[![preview](https://i.gyazo.com/7fcca9dd3e562b076293ef2cf3979d23.gif)](https://jsfiddle.net/developit/4qv3v6r3/)
+
+---
+
+## Project Goals
+
+Undom aims to find a sweet spot between size/performance and utility. The goal is to provide the simplest possible implementation of a DOM Document, such that libraries relying on the DOM can run in places where there isn't one available.
+
+The intent to keep things as simple as possible means undom lacks some DOM features like HTML parsing & serialization, Web Components, etc. These features can be added through additional libraries.
+
+#### Looking to 1.0.0
+
+As of version 1.0.0, the DOM constructors and their prototypes will be shared for all instances of a document, as is the case with [JSDOM](https://github.com/jsdom/jsdom#shared-constructors-and-prototypes). Once merged, [PR #25](https://github.com/developit/undom/pull/25) will address this by adding an `undom.env()` function, which returns a fresh document factory with a new set of constructors & prototypes.
+
+---
+
+## Installation
+
+Via npm:
+
+`npm install --save undom`
+
+---
+
+## Require Hook
+
+In CommonJS environments, simply import `undom/register` to patch the global object with a singleton Document.
+
+```js
+require('undom/register');
+
+// now you have a DOM.
+document.createElement('div');
+```
+
+---
+
+## Usage
+
+```js
+// import the library:
+import undom from 'undom';
+
+let document = undom();
+
+let foo = document.createElement('foo');
+foo.appendChild(document.createTextNode('Hello, World!'));
+document.body.appendChild(foo);
+```
+
+---
+
+## Recipe: Serialize to HTML
+
+One task `undom` doesn't handle for you by default is HTML serialization. A proper implementation of this would be cumbersome to maintain and would rely heavily on getters and setters, which limits browser support. Below is a simple recipe for serializing an `undom` Element (Document, etc) to HTML.
+
+#### Small & in ES2015:
+
+```js
+Element.prototype.toString = function () {
+    return serialize(this);
+};
+
+function serialize(el) {
+    return el.nodeType == 3
+        ? enc(el.nodeValue)
+        : '<' +
+              this.nodeName.toLowerCase() +
+              this.attributes.map(attr).join('') +
+              '>' +
+              this.childNodes.map(serialize).join('') +
+              '</' +
+              this.nodeName.toLowerCase() +
+              '>';
+}
+let attr = (a) => ` ${a.name}="${enc(a.value)}"`;
+let enc = (s) => s.replace(/[&'"<>]/g, (a) => `&#${a.codePointAt(0)};`);
+```
+
+#### ES3 Version
+
+This also does pretty-printing.
+
+```js
+function serialize(el) {
+    if (el.nodeType === 3) return el.textContent;
+    var name = String(el.nodeName).toLowerCase(),
+        str = '<' + name,
+        c,
+        i;
+    for (i = 0; i < el.attributes.length; i++) {
+        str +=
+            ' ' + el.attributes[i].name + '="' + el.attributes[i].value + '"';
+    }
+    str += '>';
+    for (i = 0; i < el.childNodes.length; i++) {
+        c = serialize(el.childNodes[i]);
+        if (c) str += '\n\t' + c.replace(/\n/g, '\n\t');
+    }
+    return str + (c ? '\n' : '') + '</' + name + '>';
+}
+
+function enc(s) {
+    return s.replace(/[&'"<>]/g, function (a) {
+        return `&#${a};`;
+    });
+}
+```

package/ReconnectableSocket.d.ts

@@ -0,0 +1,55 @@
+import { Observable, Subject } from 'rxjs';
+export declare type CloseReason = CloseReasonClosed | CloseReasonOther;
+export interface CloseReasonBase {
+    reason: string;
+}
+/**
+ * Defines an interface that indicates the web socket was closed because
+ * the local device decided to disconnect.
+ */
+export interface CloseReasonClosed extends CloseReasonBase {
+    type: 'closed';
+}
+/**
+ * Defines an interface that indicates that the web socket was closed due to some other reason.
+ * For example, it is possible that the device lost connection to the server and so it was closed.
+ */
+export interface CloseReasonOther extends CloseReasonBase {
+    type: 'other';
+}
+/**
+ * Defines a websocket connection that will automatically try to reconnect if the connection is lost.
+ */
+export interface ReconnectableSocketInterface {
+    onOpen: Observable<void>;
+    onClose: Observable<CloseReason>;
+    onMessage: Observable<MessageEvent>;
+    onError: Observable<Event>;
+    send(data: string | ArrayBuffer | ArrayBufferView): void;
+    open(): void;
+    close(): void;
+}
+/**
+ * Defines a websocket connection that will automatically try to reconnect if the connection is lost.
+ */
+export declare class ReconnectableSocket implements ReconnectableSocketInterface {
+    private _url;
+    private _socket;
+    private _closing;
+    private _onOpen;
+    private _onClose;
+    private _onError;
+    private _onMessage;
+    get onOpen(): Subject<void>;
+    get onClose(): Subject<CloseReason>;
+    get onError(): Subject<Event>;
+    get onMessage(): Subject<MessageEvent<any>>;
+    get socket(): WebSocket;
+    send(data: string | ArrayBuffer | ArrayBufferView): void;
+    constructor(url: string);
+    open(): void;
+    close(): void;
+    protected _handleMessage(event: MessageEvent): void;
+    private _setupSocket;
+}
+//# sourceMappingURL=ReconnectableSocket.d.ts.map

package/ReconnectableSocket.js

@@ -0,0 +1,75 @@
+import { Subject } from 'rxjs';
+/**
+ * Defines a websocket connection that will automatically try to reconnect if the connection is lost.
+ */
+export class ReconnectableSocket {
+    constructor(url) {
+        this._onOpen = new Subject();
+        this._onClose = new Subject();
+        this._onError = new Subject();
+        this._onMessage = new Subject();
+        this._url = url;
+    }
+    get onOpen() {
+        return this._onOpen;
+    }
+    get onClose() {
+        return this._onClose;
+    }
+    get onError() {
+        return this._onError;
+    }
+    get onMessage() {
+        return this._onMessage;
+    }
+    get socket() {
+        return this._socket;
+    }
+    send(data) {
+        this._socket.send(data);
+    }
+    open() {
+        if (!this._socket ||
+            this._socket.readyState === WebSocket.CLOSED ||
+            this._socket.readyState === WebSocket.CLOSING) {
+            this._setupSocket();
+        }
+    }
+    close() {
+        if (this._socket && this._socket.readyState === WebSocket.OPEN) {
+            this._closing = true;
+            this._socket.close();
+        }
+    }
+    _handleMessage(event) {
+        this._onMessage.next(event);
+    }
+    _setupSocket() {
+        this._closing = false;
+        this._socket = new WebSocket(this._url);
+        this._socket.onopen = () => {
+            this._onOpen.next();
+        };
+        this._socket.onclose = (event) => {
+            if (this._closing) {
+                this._onClose.next({
+                    type: 'closed',
+                    reason: '',
+                });
+            }
+            else {
+                this._onClose.next({
+                    type: 'other',
+                    reason: event.reason,
+                });
+            }
+        };
+        this._socket.onerror = (event) => {
+            this._onError.next(event);
+        };
+        this._socket.onmessage = (event) => {
+            this._handleMessage(event);
+        };
+    }
+}
+//# sourceMappingURL=ReconnectableSocket.js.map

package/ReconnectableSocket.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReconnectableSocket.js","sourceRoot":"","sources":["ReconnectableSocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,OAAO,EAAE,MAAM,MAAM,CAAC;AAsC3C;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAkC5B,YAAY,GAAW;QA7Bf,YAAO,GAAG,IAAI,OAAO,EAAQ,CAAC;QAC9B,aAAQ,GAAG,IAAI,OAAO,EAAe,CAAC;QACtC,aAAQ,GAAG,IAAI,OAAO,EAAS,CAAC;QAChC,eAAU,GAAG,IAAI,OAAO,EAAgB,CAAC;QA2B7C,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IACpB,CAAC;IA1BD,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,IAAI,CAAC,IAA4C;QAC7C,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAMD,IAAI;QACA,IACI,CAAC,IAAI,CAAC,OAAO;YACb,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,MAAM;YAC5C,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,OAAO,EAC/C;YACE,IAAI,CAAC,YAAY,EAAE,CAAC;SACvB;IACL,CAAC;IAED,KAAK;QACD,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE;YAC5D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;SACxB;IACL,CAAC;IAES,cAAc,CAAC,KAAmB;QACxC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,CAAC;IAEO,YAAY;QAChB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,GAAG,EAAE;YACvB,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;YAC7B,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACf,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACf,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,EAAE;iBACb,CAAC,CAAC;aACN;iBAAM;gBACH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;oBACf,IAAI,EAAE,OAAO;oBACb,MAAM,EAAE,KAAK,CAAC,MAAM;iBACvB,CAAC,CAAC;aACN;QACL,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,KAAY,EAAE,EAAE;YACpC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CAAC;IACN,CAAC;CACJ"}

package/WebSocketManager.d.ts

@@ -0,0 +1,37 @@
+import { Observable } from 'rxjs';
+import { ReconnectableSocket } from './ReconnectableSocket';
+/**
+ * Defines a class that is able to manage the creation and lifecycle of a WebSocket.
+ */
+export declare class SocketManager {
+    private _socket;
+    private _forcedOffline;
+    private _url;
+    private _connectionStateChanged;
+    /**
+     * Gets an observable that resolves with the connection state of the socket.
+     */
+    get connectionStateChanged(): Observable<boolean>;
+    /**
+     * Gets whether the socket manager is forcing the user to be offline or not.
+     */
+    get forcedOffline(): boolean;
+    set forcedOffline(value: boolean);
+    /**
+     * Gets the WebSocket that this manager has constructed.
+     */
+    get socket(): ReconnectableSocket;
+    /**
+     * Creates a new SocketManager.
+     * @param user The user account to use for connecting.
+     * @param url The URL to connect to.
+     */
+    constructor(url?: string);
+    init(): void;
+    /**
+     * Toggles whether the socket manager should be forcing the user's
+     * connection to the server to be offline.
+     */
+    toggleForceOffline(): void;
+}
+//# sourceMappingURL=WebSocketManager.d.ts.map

package/WebSocketManager.js

@@ -0,0 +1,76 @@
+import { BehaviorSubject } from 'rxjs';
+import { debounceTime, filter, tap } from 'rxjs/operators';
+import { ReconnectableSocket } from './ReconnectableSocket';
+const RECONNECT_TIME = 5000;
+/**
+ * Defines a class that is able to manage the creation and lifecycle of a WebSocket.
+ */
+export class SocketManager {
+    /**
+     * Creates a new SocketManager.
+     * @param user The user account to use for connecting.
+     * @param url The URL to connect to.
+     */
+    constructor(url) {
+        // Whether this manager has forced the user to be offline or not.
+        this._forcedOffline = false;
+        this._connectionStateChanged = new BehaviorSubject(false);
+        this._url = url;
+    }
+    /**
+     * Gets an observable that resolves with the connection state of the socket.
+     */
+    get connectionStateChanged() {
+        return this._connectionStateChanged;
+    }
+    /**
+     * Gets whether the socket manager is forcing the user to be offline or not.
+     */
+    get forcedOffline() {
+        return this._forcedOffline;
+    }
+    set forcedOffline(value) {
+        this._forcedOffline = !this._forcedOffline;
+        if (this._forcedOffline) {
+            this._socket.close();
+        }
+        else {
+            this._socket.open();
+        }
+    }
+    /**
+     * Gets the WebSocket that this manager has constructed.
+     */
+    get socket() {
+        return this._socket;
+    }
+    init() {
+        console.log('[WebSocketManager] Starting...');
+        this._socket = new ReconnectableSocket(this._url);
+        this._socket.onClose
+            .pipe(filter((e) => e.type === 'other'), debounceTime(RECONNECT_TIME), tap(() => {
+            console.log('[WebSocketManager] Reconnecting...');
+            this._socket.open();
+        }))
+            .subscribe();
+        this._socket.onError.subscribe((event) => {
+            console.log('[WebSocketManager] Error:', event);
+        });
+        this._socket.onOpen.subscribe(() => {
+            console.log('[WebSocketManager] Connected.');
+            this._connectionStateChanged.next(true);
+        });
+        this._socket.onClose.subscribe(() => {
+            console.log('[WebSocketManager] Closed.');
+            this._connectionStateChanged.next(false);
+        });
+    }
+    /**
+     * Toggles whether the socket manager should be forcing the user's
+     * connection to the server to be offline.
+     */
+    toggleForceOffline() {
+        this.forcedOffline = !this.forcedOffline;
+    }
+}
+//# sourceMappingURL=WebSocketManager.js.map

package/WebSocketManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketManager.js","sourceRoot":"","sources":["WebSocketManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,eAAe,EAAiB,MAAM,MAAM,CAAC;AAClE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,MAAM,cAAc,GAAG,IAAI,CAAC;AAE5B;;GAEG;AACH,MAAM,OAAO,aAAa;IAuCtB;;;;OAIG;IACH,YAAY,GAAY;QAzCxB,iEAAiE;QACzD,mBAAc,GAAY,KAAK,CAAC;QAyCpC,IAAI,CAAC,uBAAuB,GAAG,IAAI,eAAe,CAAU,KAAK,CAAC,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;IACpB,CAAC;IAtCD;;OAEG;IACH,IAAI,sBAAsB;QACtB,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,IAAW,aAAa;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAED,IAAW,aAAa,CAAC,KAAc;QACnC,IAAI,CAAC,cAAc,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC;QAC3C,IAAI,IAAI,CAAC,cAAc,EAAE;YACrB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;SACxB;aAAM;YACH,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SACvB;IACL,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAYD,IAAI;QACA,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElD,IAAI,CAAC,OAAO,CAAC,OAAO;aACf,IAAI,CACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,EACjC,YAAY,CAAC,cAAc,CAAC,EAC5B,GAAG,CAAC,GAAG,EAAE;YACL,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;YAClD,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QACxB,CAAC,CAAC,CACL;aACA,SAAS,EAAE,CAAC;QAEjB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE;YACrC,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,KAAK,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE;YAC/B,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;YAC7C,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE;YAChC,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;YAC1C,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;OAGG;IACH,kBAAkB;QACd,IAAI,CAAC,aAAa,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC;IAC7C,CAAC;CACJ"}

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './WebSocketManager';
+export * from './ReconnectableSocket';
+//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -0,0 +1,3 @@
+export * from './WebSocketManager';
+export * from './ReconnectableSocket';
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC"}

package/package.json

@@ -0,0 +1,41 @@
+{
+    "name": "@casual-simulation/websocket",
+    "version": "2.0.30",
+    "description": "Minimal WebSocket implementation",
+    "keywords": [],
+    "author": "Casual Simulation, Inc.",
+    "homepage": "https://github.com/casual-simulation/casualos",
+    "license": "MIT",
+    "main": "index.js",
+    "types": "index.d.ts",
+    "module": "index",
+    "directories": {
+        "lib": "."
+    },
+    "files": [
+        "/README.md",
+        "/LICENSE.txt",
+        "**/*.js",
+        "**/*.js.map",
+        "**/*.d.ts"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/casual-simulation/casualos.git"
+    },
+    "scripts": {
+        "watch": "tsc --watch",
+        "watch:player": "npm run watch",
+        "build": "echo \"Nothing to do.\"",
+        "build:docs": "typedoc --mode file --excludeNotExported --out ../../api-docs/crypto .",
+        "test": "jest",
+        "test:watch": "jest --watchAll"
+    },
+    "bugs": {
+        "url": "https://github.com/casual-simulation/casualos/issues"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "gitHead": "02da28eafc22129f482dc302859ce036a6ae7578"
+}