@mescius/js-collaboration-client 18.0.0

package/README.md

@@ -0,0 +1,18 @@
+# SpreadJS Collaboration Plugin
+
+The js collaboration client is one of the plugins for [SpreadJS](https://developer.mescius.com/spreadjs).
+
+Extends SpreadJS with support for collaboration
+
+For a detailed listing of SpreadJS sub-libraries and plug-ins, please see [Using SpreadJS Libraries](https://developer.mescius.com/spreadjs/docs/getstarted/modules).
+
+## Installation
+```sh
+npm install @mescius/js-collaboration-client
+```
+
+## Getting more help
+Visit the SpreadJS home page to get more info about the library:
+[https://developer.mescius.com/spreadjs](https://developer.mescius.com/spreadjs)
+
+You can ask any question about SpreadJS using the [SpreadJS Forum](https://developer.mescius.com/forums/spreadjs).

package/dist/index.d.ts

@@ -0,0 +1,126 @@
+/**
+ * The collaboration client, provides bidirectional communication.
+ */
+export declare class Client {
+    url: string;
+
+    /**
+     * Create a new collaboration client.
+     * @param url - The server url.
+     */
+    constructor(url?: string);
+
+    /**
+     * Connect to a room.
+     * @param roomId - The room id.
+     * @param options - The connect options.
+     */
+    connect(roomId: string, options?: IConnectOptions): Connection;
+}
+
+export interface IConnectOptions {
+    /**
+     * The query arguments.
+     */
+    query?: IQuery;
+    /**
+     * The authentication data.
+     */
+    auth?: IAuth;
+}
+
+export interface IQuery {
+    [key: string]: unknown;
+}
+export interface IAuth {
+    [key: string]: unknown;
+}
+
+/**
+ * The collaboration connection of client.
+ */
+export declare class Connection {
+    /**
+     * Get the connection id.
+     * @returns {string} Returns the connection id.
+     */
+    get id(): string;
+    /**
+     * Gets whether the connection can send messages.
+     * @returns {boolean} Returns whether the connection can send messages.
+     */
+    get canSend(): boolean;
+    /**
+     * Send a message to the server.
+     * @param data - The data to send.
+     * @param [type] - The message type.
+     */
+    send(data: MessageData, type?: MessageType): void;
+    /**
+     * Close the connection.
+     */
+    close(): void;
+    /**
+     * Register a listener for an event.
+     * @param name - The event name.
+     * @param f - The event handler.
+     */
+    on<NAME extends keyof IEvents & string>(name: NAME, f: IEvents[NAME]): IEvents[NAME];
+    /**
+     * Register a listener for an event that will only be called once.
+     * @param name - The event name.
+     * @param f - The event handler.
+     */
+    once<NAME_1 extends keyof IEvents & string>(name: NAME_1, f: IEvents[NAME_1]): void;
+    /**
+     * Remove a listener for an event.
+     * @param name - The event name.
+     * @param f - The event handler.
+     */
+    off<NAME_2 extends keyof IEvents & string>(name: NAME_2, f: IEvents[NAME_2]): void;
+    /**
+     * Destroy the observable.
+     */
+    destroy(): void;
+}
+
+export interface IEvents {
+    open: () => void;
+    message: (data: MessageData, type: MessageType) => void;
+    close: (reason: CloseReason) => void;
+    error: (e: unknown) => void;
+    reconnect: (attempts: number) => void;
+    reconnectFailed: (err?: Error) => void;
+    reconnectAttempts: (attempts: number) => void;
+    connectionStateChanged: () => void;
+}
+
+export type MessageData = unknown;
+export type MessageType = string | null;
+
+/**
+ * The reason of the connection closed.
+ */
+export enum CloseReason {
+    /**
+     * The client  has manually disconnected.
+     */
+    CLIENT_DISCONNECT,
+    /**
+     * The server has manually disconnected.
+     */
+    SERVER_DISCONNECT,
+    /**
+     * The client did not send a PONG packet in the pingTimeout delay.
+     */
+    PING_TIMEOUT,
+    /**
+     * The transport connection was closed.
+     */
+    TRANSPORT_CLOSE,
+    /**
+     * The transport connection has encountered an error.
+     */
+    TRANSPORT_ERROR
+}
+

package/dist/index.js

@@ -0,0 +1 @@
+!function(e,t){if("object"==typeof exports&&"object"==typeof module)module.exports=t();else if("function"==typeof define&&define.amd)define([],t);else{var o=t();for(var n in o)("object"==typeof exports?exports:e)[n]=o[n]}}(this,(()=>(()=>{"use strict";var e={234:(e,t,o)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Client=void 0;const n=o(42);t.Client=class{constructor(e){this.url=e||"/"}connect(e,t){return new n.Connection(this.url,{query:Object.assign({roomId:e},null==t?void 0:t.query),auth:null==t?void 0:t.auth})}}},42:(e,t,o)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Connection=t.CloseReason=void 0;const n=o(87),r=o(884);var s;!function(e){e[e.CLIENT_DISCONNECT=0]="CLIENT_DISCONNECT",e[e.SERVER_DISCONNECT=1]="SERVER_DISCONNECT",e[e.PING_TIMEOUT=2]="PING_TIMEOUT",e[e.TRANSPORT_CLOSE=3]="TRANSPORT_CLOSE",e[e.TRANSPORT_ERROR=4]="TRANSPORT_ERROR"}(s||(t.CloseReason=s={}));class i extends r.Observable{constructor(e,t){var o;super(),t=null!=t?t:{},this._socket=(0,n.io)(e,Object.assign(Object.assign({},t),{perMessageDeflate:{threshold:1024},transports:["websocket"],path:null!==(o=t.path)&&void 0!==o?o:r.DEFAULT_REQUEST_PATH})),this._socket.on("connect",this.onopen.bind(this)),this._socket.on("disconnect",this.onclose.bind(this)),this._socket.on("connect_error",(e=>this.emit("error",[e]))),this._socket.on(r.SOCKET_IO_MESSAGE_EVENT,this.onmessage.bind(this))}get id(){return this._socket.id}get canSend(){return this._socket.connected}send(e,t){this._socket.emit(r.SOCKET_IO_MESSAGE_EVENT,(0,r.encodeMessage)(e,t))}close(){this._socket.disconnect()}onopen(){this.emit("open",[]),this.emit("connectionStateChanged",[])}onmessage(e){this.emit("message",(0,r.decodeMessage)(e))}onclose(e){this.emit("close",[c(e)]),this.emit("connectionStateChanged",[])}}function c(e){switch(e){case"io server disconnect":return s.SERVER_DISCONNECT;case"io client disconnect":return s.CLIENT_DISCONNECT;case"transport close":return s.TRANSPORT_CLOSE;default:return s.TRANSPORT_ERROR}}t.Connection=i},871:e=>{e.exports=require("buffer")},331:e=>{e.exports=require("pako")},87:e=>{e.exports=require("socket.io-client")},884:function(e,t,o){var n=this&&this.__createBinding||(Object.create?function(e,t,o,n){void 0===n&&(n=o);var r=Object.getOwnPropertyDescriptor(t,o);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[o]}}),Object.defineProperty(e,n,r)}:function(e,t,o,n){void 0===n&&(n=o),e[n]=t[o]}),r=this&&this.__exportStar||function(e,t){for(var o in e)"default"===o||Object.prototype.hasOwnProperty.call(t,o)||n(t,e,o)};Object.defineProperty(t,"__esModule",{value:!0}),t.DEFAULT_REQUEST_PATH=void 0,r(o(589),t),r(o(735),t),r(o(31),t),r(o(76),t),r(o(959),t),t.DEFAULT_REQUEST_PATH="/collaboration/"},31:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.logger=void 0,t.logger=class{static info(e,...t){}static warn(e,...t){}static error(e,...t){}}},735:function(e,t,o){var n=this&&this.__createBinding||(Object.create?function(e,t,o,n){void 0===n&&(n=o);var r=Object.getOwnPropertyDescriptor(t,o);r&&!("get"in r?!t.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return t[o]}}),Object.defineProperty(e,n,r)}:function(e,t,o,n){void 0===n&&(n=o),e[n]=t[o]}),r=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),s=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var o in e)"default"!==o&&Object.prototype.hasOwnProperty.call(e,o)&&n(t,e,o);return r(t,e),t};Object.defineProperty(t,"__esModule",{value:!0}),t.SOCKET_IO_MESSAGE_EVENT=void 0,t.encodeMessage=function(e,t=null){return[t,"string"==typeof e?a(e):e]},t.decodeMessage=function(e){return["string"==typeof e[1]?u(e[1]):e[1],e[0]]};const i=s(o(331)),c=o(871);function a(e){const t=(new TextEncoder).encode(e),o=i.deflate(t);return c.Buffer.from(o).toString("base64")}function u(e){const t=c.Buffer.from(e,"base64"),o=i.inflate(new Uint8Array(t));return(new TextDecoder).decode(o)}t.SOCKET_IO_MESSAGE_EVENT="m"},589:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Middleware=void 0,t.Middleware=class{constructor(){this.middlewares=new Map,this.hooks=new Map}use(e,t){this.middlewares.has(e)||this.middlewares.set(e,[]),this.middlewares.get(e).push(t)}on(e,t){this.hooks.has(e)||this.hooks.set(e,[]),this.hooks.get(e).push(t)}async trigger(e,t){let o=this.middlewares.get(e);if(!o)return;o=o.slice();const n=async e=>{if(e)throw e;const r=null==o?void 0:o.shift();r&&await r(t,n)};await n()}emit(e,t){const o=this.hooks.get(e);o&&o.forEach((e=>e(t)))}}},959:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Observable=void 0,t.Observable=class{constructor(){this._observers=new Map}on(e,t){return o(this._observers,e,(()=>new Set)).add(t),t}once(e,t){const o=(...n)=>{this.off(e,o),t(...n)};this.on(e,o)}off(e,t){const o=this._observers.get(e);void 0!==o&&(o.delete(t),0===o.size&&this._observers.delete(e))}emit(e,t){return Array.from((this._observers.get(e)||new Map).values()).forEach((e=>e(...t)))}destroy(){this._observers=new Map}};const o=(e,t,o)=>{let n=e.get(t);return void 0===n&&(n=o(),e.set(t,n)),n}},76:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.isNullOrUndefined=function(e){return null==e}}},t={};function o(n){var r=t[n];if(void 0!==r)return r.exports;var s=t[n]={exports:{}};return e[n].call(s.exports,s,s.exports,o),s.exports}var n={};return(()=>{var e=n;Object.defineProperty(e,"__esModule",{value:!0}),e.logger=e.Connection=e.CloseReason=e.Client=void 0;const t=o(234);Object.defineProperty(e,"Client",{enumerable:!0,get:function(){return t.Client}});const r=o(42);Object.defineProperty(e,"CloseReason",{enumerable:!0,get:function(){return r.CloseReason}}),Object.defineProperty(e,"Connection",{enumerable:!0,get:function(){return r.Connection}});const s=o(884);Object.defineProperty(e,"logger",{enumerable:!0,get:function(){return s.logger}})})(),n})()));

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@mescius/js-collaboration-client",
+  "version": "18.0.0",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": {
+    "email": "us.sales@mescius.com",
+    "name": "MESCIUS inc"
+  },
+  "license": "Commercial",
+  "dependencies": {
+    "socket.io-client": "4.8.1",
+    "buffer": "6.0.3",
+    "pako": "2.1.0"
+  },
+  "description": "SpreadJS Collaboration plugin",
+  "keywords": [
+    "js-collaboration-client",
+    "js-collaboration",
+    "collaboration",
+    "spread",
+    "sheet",
+    "javascript",
+    "excel",
+    "spreadjs"
+  ],
+  "homepage": "https://developer.mescius.com/spreadjs"
+}