@univerjs/network 0.6.4 → 0.6.5

package/lib/cjs/facade.js

@@ -1 +1 @@
-"use strict";const o=require("@univerjs/core/facade"),i=require("@univerjs/core"),v=require("@univerjs/network");var a=Object.getOwnPropertyDescriptor,_=(e,t,r,c)=>{for(var s=c>1?void 0:c?a(t,r):t,n=e.length-1,p;n>=0;n--)(p=e[n])&&(s=p(s)||s);return s},u=(e,t)=>(r,c)=>t(r,c,e);let h=class extends o.FBase{constructor(e,t){super(),this._injector=e,this._httpService=t}get(e,t){return this._httpService.get(e,t)}post(e,t){return this._httpService.post(e,t)}put(e,t){return this._httpService.put(e,t)}delete(e,t){return this._httpService.delete(e,t)}patch(e,t){return this._httpService.patch(e,t)}getSSE(e,t,r){return this._httpService.getSSE(e,t,r)}};h=_([u(0,i.Inject(i.Injector)),u(1,i.Inject(v.HTTPService))],h);class S extends o.FUniver{getNetwork(){return this._injector.createInstance(h)}}o.FUniver.extend(S);
+"use strict";const a=require("@univerjs/core/facade"),S=require("@univerjs/network"),n=require("@univerjs/core");var u=Object.getOwnPropertyDescriptor,p=(t,e,c,r)=>{for(var s=r>1?void 0:r?u(e,c):e,i=t.length-1,h;i>=0;i--)(h=t[i])&&(s=h(s)||s);return s},v=(t,e)=>(c,r)=>e(c,r,t);let o=class extends a.FBase{constructor(t,e){super(),this._injector=t,this._httpService=e}get(t,e){return this._httpService.get(t,e)}post(t,e){return this._httpService.post(t,e)}put(t,e){return this._httpService.put(t,e)}delete(t,e){return this._httpService.delete(t,e)}patch(t,e){return this._httpService.patch(t,e)}getSSE(t,e,c){return this._httpService.getSSE(t,e,c)}};o=p([v(0,n.Inject(n.Injector)),v(1,n.Inject(S.HTTPService))],o);class _ extends a.FUniver{getNetwork(){return this._injector.createInstance(o)}createSocket(e){const r=this._injector.createInstance(S.WebSocketService).createSocket(e);if(!r)throw new Error("[WebSocketService]: failed to create socket!");return r}}a.FUniver.extend(_);

package/lib/es/facade.js

@@ -1,12 +1,12 @@
-import { FBase as _, FUniver as v } from "@univerjs/core/facade";
-import { Inject as h, Injector as a } from "@univerjs/core";
-import { HTTPService as u } from "@univerjs/network";
-var S = Object.getOwnPropertyDescriptor, l = (t, e, r, i) => {
-  for (var s = i > 1 ? void 0 : i ? S(e, r) : e, c = t.length - 1, p; c >= 0; c--)
-    (p = t[c]) && (s = p(s) || s);
-  return s;
-}, o = (t, e) => (r, i) => e(r, i, t);
-let n = class extends _ {
+import { FBase as v, FUniver as p } from "@univerjs/core/facade";
+import { HTTPService as S, WebSocketService as _ } from "@univerjs/network";
+import { Inject as h, Injector as u } from "@univerjs/core";
+var w = Object.getOwnPropertyDescriptor, l = (t, e, c, r) => {
+  for (var i = r > 1 ? void 0 : r ? w(e, c) : e, s = t.length - 1, o; s >= 0; s--)
+    (o = t[s]) && (i = o(i) || i);
+  return i;
+}, a = (t, e) => (c, r) => e(c, r, t);
+let n = class extends v {
   constructor(t, e) {
     super(), this._injector = t, this._httpService = e;
   }
@@ -63,17 +63,23 @@ let n = class extends _ {
    * @param {IPostRequestParams} [params] - params Query parameters
    * @returns {Observable<HTTPEvent>} An observable that emits the network response.
    */
-  getSSE(t, e, r) {
-    return this._httpService.getSSE(t, e, r);
+  getSSE(t, e, c) {
+    return this._httpService.getSSE(t, e, c);
   }
 };
 n = l([
-  o(0, h(a)),
-  o(1, h(u))
+  a(0, h(u)),
+  a(1, h(S))
 ], n);
-class g extends v {
+class f extends p {
   getNetwork() {
     return this._injector.createInstance(n);
   }
+  createSocket(e) {
+    const r = this._injector.createInstance(_).createSocket(e);
+    if (!r)
+      throw new Error("[WebSocketService]: failed to create socket!");
+    return r;
+  }
 }
-v.extend(g);
+p.extend(f);

package/lib/types/facade/f-univer.d.ts

@@ -1,3 +1,4 @@
+import { ISocket } from '@univerjs/network';
 import { FUniver } from '@univerjs/core/facade';
 import { FNetwork } from './f-network';
 /**
@@ -8,9 +9,60 @@ interface IFUniverNetworkMixin {
      * Get the network API of Univer, with the help of which you can send HTTP requests.
      */
     getNetwork(): FNetwork;
+    /**
+     * Set WebSocket URL for WebSocketService
+     *
+     * @param {string} url WebSocket URL
+     * @returns {ISocket} WebSocket instance
+     * @example
+     * ```typescript
+     * // Replace the URL with the address of your own WebSocket service
+     * const ws = univerAPI.createSocket('ws://47.100.177.253:8449/ws');
+     *
+     * ws.open$.subscribe(() => {
+     *   console.log('websocket opened');
+     *   ws.send('hello');
+     * });
+     *
+     * ws.message$.subscribe((message) => {
+     *   console.log('websocket message', message);
+     *   const content = JSON.parse(message.data).content;
+     *   if (!content.includes('command')) {
+     *     return;
+     *   }
+     *
+     *   const commandInfo = JSON.parse(content);
+     *   const { command, options } = commandInfo;
+     *   const { id, params } = command;
+     *
+     *   // Upon receiving collaborative data, it is locally saved
+     *   univerAPI.executeCommand(id, params, options);
+     * });
+     *
+     * ws.close$.subscribe(() => {
+     *   console.log('websocket closed');
+     * });
+     *
+     * ws.error$.subscribe((error) => {
+     *   console.log('websocket error', error);
+     * });
+     *
+     * univerAPI.onCommandExecuted((command, options) => {
+     *   // Only synchronize local mutations
+     *   if (command.type !== 2 || options?.fromCollab || options?.onlyLocal || command.id === 'doc.mutation.rich-text-editing') {
+     *     return;
+     *   }
+     *
+     *   const commandInfo = JSON.stringify({ command, options: { fromCollab: true } });
+     *   ws.send(commandInfo);
+     * });
+     * ```
+     */
+    createSocket(url: string): ISocket;
 }
 export declare class FUniverNetworkMixin extends FUniver implements IFUniverNetworkMixin {
     getNetwork(): FNetwork;
+    createSocket(url: string): ISocket;
 }
 declare module '@univerjs/core/facade' {
     interface FUniver extends IFUniverNetworkMixin {

package/lib/umd/facade.js

@@ -1 +1 @@
-(function(r,n){typeof exports=="object"&&typeof module<"u"?n(require("@univerjs/core/facade"),require("@univerjs/core"),require("@univerjs/network")):typeof define=="function"&&define.amd?define(["@univerjs/core/facade","@univerjs/core","@univerjs/network"],n):(r=typeof globalThis<"u"?globalThis:r||self,n(r.UniverCoreFacade,r.UniverCore,r.UniverNetwork))})(this,function(r,n,p){"use strict";var d=Object.getOwnPropertyDescriptor,_=(e,t,i,s)=>{for(var c=s>1?void 0:s?d(t,i):t,o=e.length-1,h;o>=0;o--)(h=e[o])&&(c=h(c)||c);return c},v=(e,t)=>(i,s)=>t(i,s,e);let u=class extends r.FBase{constructor(e,t){super(),this._injector=e,this._httpService=t}get(e,t){return this._httpService.get(e,t)}post(e,t){return this._httpService.post(e,t)}put(e,t){return this._httpService.put(e,t)}delete(e,t){return this._httpService.delete(e,t)}patch(e,t){return this._httpService.patch(e,t)}getSSE(e,t,i){return this._httpService.getSSE(e,t,i)}};u=_([v(0,n.Inject(n.Injector)),v(1,n.Inject(p.HTTPService))],u);class a extends r.FUniver{getNetwork(){return this._injector.createInstance(u)}}r.FUniver.extend(a)});
+(function(r,n){typeof exports=="object"&&typeof module<"u"?n(require("@univerjs/core/facade"),require("@univerjs/network"),require("@univerjs/core")):typeof define=="function"&&define.amd?define(["@univerjs/core/facade","@univerjs/network","@univerjs/core"],n):(r=typeof globalThis<"u"?globalThis:r||self,n(r.UniverCoreFacade,r.UniverNetwork,r.UniverCore))})(this,function(r,n,o){"use strict";var S=Object.getOwnPropertyDescriptor,a=(t,e,c,i)=>{for(var s=i>1?void 0:i?S(e,c):e,v=t.length-1,p;v>=0;v--)(p=t[v])&&(s=p(s)||s);return s},h=(t,e)=>(c,i)=>e(c,i,t);let u=class extends r.FBase{constructor(t,e){super(),this._injector=t,this._httpService=e}get(t,e){return this._httpService.get(t,e)}post(t,e){return this._httpService.post(t,e)}put(t,e){return this._httpService.put(t,e)}delete(t,e){return this._httpService.delete(t,e)}patch(t,e){return this._httpService.patch(t,e)}getSSE(t,e,c){return this._httpService.getSSE(t,e,c)}};u=a([h(0,o.Inject(o.Injector)),h(1,o.Inject(n.HTTPService))],u);class d extends r.FUniver{getNetwork(){return this._injector.createInstance(u)}createSocket(e){const i=this._injector.createInstance(n.WebSocketService).createSocket(e);if(!i)throw new Error("[WebSocketService]: failed to create socket!");return i}}r.FUniver.extend(d)});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/network",
-  "version": "0.6.4",
+  "version": "0.6.5",
   "private": false,
   "author": "DreamNum <developer@univer.ai>",
   "license": "Apache-2.0",
@@ -52,14 +52,14 @@
     "rxjs": ">=7.0.0"
   },
   "dependencies": {
-    "@univerjs/core": "0.6.4"
+    "@univerjs/core": "0.6.5"
   },
   "devDependencies": {
     "rxjs": "^7.8.1",
     "typescript": "^5.8.2",
-    "vite": "^6.2.0",
-    "vitest": "^3.0.7",
-    "@univerjs-infra/shared": "0.6.4"
+    "vite": "^6.2.1",
+    "vitest": "^3.0.8",
+    "@univerjs-infra/shared": "0.6.5"
   },
   "scripts": {
     "test": "vitest run",