@mescius/js-collaboration 18.0.0

package/README.md

@@ -0,0 +1,18 @@
+# SpreadJS Collaboration Plugin
+
+The js collaboration package 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
+```
+
+## 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,195 @@
+import { Server as HTTPServer } from "http";
+import { Server as HTTPSServer } from "https";
+import { Http2SecureServer, Http2Server } from "http2";
+
+/**
+ * The collaboration server, provides bidirectional communication, middleware and hooks mechanism.
+ */
+export declare class Server {
+    constructor(config?: IServerConfig);
+
+    /**
+     * Register middlewares to the server
+     * @param middlewares - middlewares to register
+     */
+    use(middlewares: IMiddlewares): void;
+    /**
+     * Register middleware to the server
+     * @param action - action name
+     * @param middleware - middleware to register
+     */
+    use<K extends keyof IMiddlewareContext>(action: K, middleware: IMiddleware<IMiddlewareContext[K]>): void;
+
+    /**
+     * Register hooks to the server
+     * @param hooks - hooks to register
+     */
+    on(hooks: IHooks): void;
+    /**
+     * Register hooks to the server
+     * @param action - action name
+     * @param hook - hook to register
+     */
+    on<K extends keyof IHookContext>(action: K, hook: IHook<IHookContext[K]>): void;
+
+    /**
+     * Register feature to the server
+     * @param feature - feature to register
+     */
+    useFeature(feature: IFeature): void;
+}
+
+export interface IServerConfig {
+    httpServer?: HTTPServer | HTTPSServer | Http2SecureServer | Http2Server;
+    port?: number;
+    /**
+     * The request path of the server. default is '/collaboration/'
+     */
+    path?: string;
+}
+
+export interface IMiddleware<T> {
+    (context: T, next: INext): Promise<void>;
+}
+
+export interface IMiddlewares {
+    connect?: IMiddleware<IConnectMiddlewareContext>,
+    message?: IMiddleware<IMessageMiddlewareContext>
+}
+
+export interface IMiddlewareContext {
+    connect: IConnectMiddlewareContext,
+    message: IMessageMiddlewareContext
+}
+
+export interface IConnectMiddlewareContext {
+    connection: Connection;
+    roomId: string;
+}
+
+export interface IMessageMiddlewareContext {
+    roomId: string;
+    connection: Connection;
+    type: MessageType;
+    data: MessageData;
+}
+
+export type MessageType = string | null;
+export type MessageData = unknown;
+
+export interface INext {
+    (error?: Error | string): Promise<void>;
+}
+
+export interface IHook<T> {
+    (context: T): void;
+}
+export interface IHooks {
+    connect?: IHook<IConnectContext>,
+    message?: IHook<IMessageContext>,
+    createRoom?: IHook<ICreateRoomContext>,
+    disconnect?: IHook<IDisconnectContext>,
+    enterRoom?: IHook<IEnterRoomContext>,
+    leaveRoom?: IHook<ILeaveRoomContext>,
+    destroyRoom?: IHook<IDestroyRoomContext>,
+}
+
+export interface IHookContext {
+    connect: IConnectContext,
+    createRoom: ICreateRoomContext,
+    enterRoom: IEnterRoomContext,
+    message: IMessageContext,
+    disconnect: IDisconnectContext,
+    leaveRoom: ILeaveRoomContext,
+    destroyRoom: IDestroyRoomContext,
+}
+
+export interface IConnectContext {
+    roomId: string;
+    connection: Connection;
+}
+
+export interface IMessageContext {
+    roomId: string;
+    connection: Connection;
+    type: MessageType;
+    data: MessageData;
+}
+
+export interface ICreateRoomContext {
+    roomId: string;
+}
+
+export interface IEnterRoomContext {
+    roomId: string;
+    connection: Connection;
+}
+
+export interface IDisconnectContext {
+    roomId: string;
+    connection: Connection;
+}
+
+export interface ILeaveRoomContext {
+    roomId: string;
+    connection: Connection;
+}
+
+export interface IDestroyRoomContext {
+    roomId: string;
+}
+
+export interface IFeature {
+    middlewares?: IMiddlewares;
+    hooks?: IHooks;
+}
+
+/**
+ * The collaboration connection of server.
+ */
+export declare class Connection {
+    /**
+     * Save custom data for each connection.
+     */
+    tags: Map<string, unknown>;
+    /**
+     * Get the id of the connection.
+     * @returns {string} Returns the id of the connection.
+     */
+    get id(): string;
+    /**
+     * The room id of the connection.
+     * @returns {string} Returns the room id of the connection.
+     */
+    get roomId(): string;
+    /**
+     * Get the query arguments of the connection.
+     * @returns {Record<string, unknown>} Returns the query arguments of the connection.
+     */
+    get query(): Record<string, unknown>;
+    /**
+     * Get the authentication data of the connection.
+     * @returns {[key: string]: any} Returns the authentication data of the connection.
+     */
+    get auth(): {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        [key: string]: any;
+    };
+    /**
+     * Send message to client
+     * @param data - message data to send
+     * @param type - message type
+     */
+    send(data: MessageData, type?: MessageType): void;
+    /**
+     * Broadcast message to all connections in the room
+     * @param data - message data to send
+     * @param type - message type
+     * @param includeSelf - whether to send to self
+     */
+    broadcast(data: string | Uint8Array, type: MessageType, includeSelf?: boolean): void;
+    /**
+     * Close the connection
+     */
+    close(): void;
+}

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 r in o)("object"==typeof exports?exports:e)[r]=o[r]}}(this,(()=>(()=>{"use strict";var e={42:(e,t,o)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.Connection=void 0,t.getConnection=function(e){return e.__conn__};const r=o(884);class n extends r.Observable{constructor(e){super(),this.tags=new Map,this.innerTags=new Map;const t=e.handshake.query;this._roomId=t.roomId,this._query=t,this._socket=e,this._socket.__conn__=this,this._socket.on(r.SOCKET_IO_MESSAGE_EVENT,this.onmessage.bind(this))}get id(){return this._socket.id}get roomId(){return this._roomId}get query(){return this._query}get auth(){return this._socket.handshake.auth}get socket(){return this._socket}send(e,t){this._socket.emit(r.SOCKET_IO_MESSAGE_EVENT,(0,r.encodeMessage)(e,t))}close(){this._socket.disconnect()}broadcast(e,t,o=!1){const n=(0,r.encodeMessage)(e,t);o&&this._socket.emit(r.SOCKET_IO_MESSAGE_EVENT,n),this._socket.to(this.roomId).emit(r.SOCKET_IO_MESSAGE_EVENT,n)}onmessage(e){this.emit("message",(0,r.decodeMessage)(e))}}t.Connection=n},273:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0})},897:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0})},271:function(e,t,o){var r=this&&this.__createBinding||(Object.create?function(e,t,o,r){void 0===r&&(r=o);var n=Object.getOwnPropertyDescriptor(t,o);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[o]}}),Object.defineProperty(e,r,n)}:function(e,t,o,r){void 0===r&&(r=o),e[r]=t[o]}),n=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)&&r(t,e,o);return n(t,e),t};Object.defineProperty(t,"__esModule",{value:!0}),t.Server=void 0;const i=s(o(952)),c=o(884),a=o(42);class u extends c.Middleware{constructor(e){var t;super(),this.rooms=new Set,e=null!=e?e:{port:3e3},this.io=new i.Server(e.httpServer||e.port,{path:null!==(t=e.path)&&void 0!==t?t:c.DEFAULT_REQUEST_PATH,maxHttpBufferSize:1e10,perMessageDeflate:{threshold:1024}}),this.io.use(((e,t)=>{const o=new a.Connection(e),r={connection:o,roomId:o.roomId};this.trigger("connect",r).then((()=>t())).catch((e=>t((e=>e instanceof Error?e:new Error(e))(e))))}));const o=this.io.of("/").adapter;this.io.on("connection",(e=>{const t=(0,a.getConnection)(e);this.emit("connect",{connection:t,roomId:t.roomId}),this.rooms.add(t.roomId),t.socket.join(t.roomId),t.on("message",((e,o)=>{this.trigger("message",{connection:t,data:e,type:o,roomId:t.roomId}).then((()=>this.emit("message",{connection:t,data:e,type:o,roomId:t.roomId}))).catch((e=>t.socket.emit("error",e)))}))})),o.on("create-room",(e=>{this.rooms.has(e)&&this.emit("createRoom",{roomId:e})})),o.on("join-room",((e,t)=>{if(!this.rooms.has(e))return;const o=this.io.sockets.sockets.get(t);this.emit("enterRoom",{roomId:e,connection:(0,a.getConnection)(o)})})),o.on("leave-room",((e,t)=>{if(!this.rooms.has(e))return;const o=this.io.sockets.sockets.get(t);this.emit("leaveRoom",{roomId:e,connection:(0,a.getConnection)(o)})})),o.on("delete-room",(e=>{this.rooms.has(e)&&(this.rooms.delete(e),this.emit("destroyRoom",{roomId:e}))}))}use(e,t){if("string"==typeof e){const o=e;super.use(o,t)}else{const t=e;t.connect&&super.use("connect",t.connect),t.message&&super.use("message",t.message)}}on(e,t){if("string"==typeof e){const o=e;super.on(o,t)}else{const t=e;t.connect&&super.on("connect",t.connect),t.createRoom&&super.on("createRoom",t.createRoom),t.enterRoom&&super.on("enterRoom",t.enterRoom),t.message&&super.on("message",t.message),t.disconnect&&super.on("disconnect",t.disconnect),t.leaveRoom&&super.on("leaveRoom",t.leaveRoom),t.destroyRoom&&super.on("destroyRoom",t.destroyRoom)}}useFeature(e){e.middlewares&&this.use(e.middlewares),e.hooks&&this.on(e.hooks)}}t.Server=u},871:e=>{e.exports=require("buffer")},331:e=>{e.exports=require("pako")},952:e=>{e.exports=require("socket.io")},884:function(e,t,o){var r=this&&this.__createBinding||(Object.create?function(e,t,o,r){void 0===r&&(r=o);var n=Object.getOwnPropertyDescriptor(t,o);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[o]}}),Object.defineProperty(e,r,n)}:function(e,t,o,r){void 0===r&&(r=o),e[r]=t[o]}),n=this&&this.__exportStar||function(e,t){for(var o in e)"default"===o||Object.prototype.hasOwnProperty.call(t,o)||r(t,e,o)};Object.defineProperty(t,"__esModule",{value:!0}),t.DEFAULT_REQUEST_PATH=void 0,n(o(589),t),n(o(735),t),n(o(31),t),n(o(76),t),n(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 r=this&&this.__createBinding||(Object.create?function(e,t,o,r){void 0===r&&(r=o);var n=Object.getOwnPropertyDescriptor(t,o);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[o]}}),Object.defineProperty(e,r,n)}:function(e,t,o,r){void 0===r&&(r=o),e[r]=t[o]}),n=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)&&r(t,e,o);return n(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 r=async e=>{if(e)throw e;const n=null==o?void 0:o.shift();n&&await n(t,r)};await r()}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=(...r)=>{this.off(e,o),t(...r)};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 r=e.get(t);return void 0===r&&(r=o(),e.set(t,r)),r}},76:(e,t)=>{Object.defineProperty(t,"__esModule",{value:!0}),t.isNullOrUndefined=function(e){return null==e}}},t={};function o(r){var n=t[r];if(void 0!==n)return n.exports;var s=t[r]={exports:{}};return e[r].call(s.exports,s,s.exports,o),s.exports}var r={};return(()=>{var e=r;Object.defineProperty(e,"__esModule",{value:!0}),e.Middleware=e.logger=e.Connection=e.Server=void 0,o(897),o(273);const t=o(271);Object.defineProperty(e,"Server",{enumerable:!0,get:function(){return t.Server}});const n=o(42);Object.defineProperty(e,"Connection",{enumerable:!0,get:function(){return n.Connection}});const s=o(884);Object.defineProperty(e,"logger",{enumerable:!0,get:function(){return s.logger}}),Object.defineProperty(e,"Middleware",{enumerable:!0,get:function(){return s.Middleware}})})(),r})()));

package/package.json

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

package/wrapper.mjs

@@ -0,0 +1,5 @@
+import * as collaborationModule from './dist/index.js';
+import collaboration from './dist/index.js';
+const { Server, Connection, logger, Middleware } = { ...(collaboration ?? {}), ...collaborationModule };
+
+export { collaboration as default, Server, Connection, logger, Middleware };