@univerjs/network 0.8.0 → 0.8.1-nightly.202506131607

package/lib/index.js

@@ -1,16 +1,16 @@
 var Z = Object.defineProperty;
 var P = (e, t, r) => t in e ? Z(e, t, { enumerable: !0, configurable: !0, writable: !0, value: r }) : e[t] = r;
-var p = (e, t, r) => P(e, typeof t != "symbol" ? t + "" : t, r);
+var u = (e, t, r) => P(e, typeof t != "symbol" ? t + "" : t, r);
 import { createIdentifier as V, Disposable as J, toDisposable as R, remove as z, ILogService as D, Inject as S, Injector as H, Plugin as C, Quantity as T, LookUp as ee, registerDependencies as re, mergeOverrideWithDependencies as te, DisposableCollection as ne } from "@univerjs/core";
-import { of as M, firstValueFrom as se, Observable as m, catchError as oe, throwError as ie } from "rxjs";
-import { concatMap as j, share as b, retry as ce } from "rxjs/operators";
+import { of as j, firstValueFrom as se, Observable as m, catchError as oe, throwError as ie } from "rxjs";
+import { concatMap as M, share as b, retry as ce } from "rxjs/operators";
 const U = "application/json";
 function ae(e) {
   return Array.isArray(e) ? e.some((t) => t.includes(U)) : e.includes(U);
 }
 class I {
   constructor(t) {
-    p(this, "_headers", /* @__PURE__ */ new Map());
+    u(this, "_headers", /* @__PURE__ */ new Map());
     typeof t == "string" ? this._handleHeadersString(t) : t instanceof Headers ? this._handleHeaders(t) : t && this._handleHeadersConstructorProps(t);
   }
   forEach(t) {
@@ -66,7 +66,7 @@ class B {
 let le = 0;
 class G {
   constructor(t, r, n) {
-    p(this, "uid", le++);
+    u(this, "uid", le++);
     this.method = t, this.url = r, this.requestParams = n;
   }
   get headers() {
@@ -93,17 +93,17 @@ class G {
     return this.headers.toHeadersInit((r = this.requestParams) == null ? void 0 : r.body);
   }
 }
-var he = Object.getOwnPropertyDescriptor, de = (e, t, r, n) => {
+var he = Object.getOwnPropertyDescriptor, pe = (e, t, r, n) => {
   for (var s = n > 1 ? void 0 : n ? he(t, r) : t, o = e.length - 1, i; o >= 0; o--)
     (i = e[o]) && (s = i(s) || s);
   return s;
-}, pe = (e, t) => (r, n) => t(r, n, e);
+}, de = (e, t) => (r, n) => t(r, n, e);
 let x = class extends J {
   constructor(t) {
     super();
-    p(this, "_interceptors", []);
+    u(this, "_interceptors", []);
     // eslint-disable-next-line ts/no-explicit-any
-    p(this, "_pipe");
+    u(this, "_pipe");
     this._http = t;
   }
   /**
@@ -121,46 +121,74 @@ let x = class extends J {
     }), this._pipe = null, R(() => z(this._interceptors, t));
   }
   get(t, r) {
-    return this._request("GET", t, r);
+    return this.request("GET", t, r);
   }
   post(t, r) {
-    return this._request("POST", t, r);
+    return this.request("POST", t, r);
   }
   put(t, r) {
-    return this._request("PUT", t, r);
+    return this.request("PUT", t, r);
   }
   delete(t, r) {
-    return this._request("DELETE", t, r);
+    return this.request("DELETE", t, r);
   }
   patch(t, r) {
-    return this._request("PATCH", t, r);
+    return this.request("PATCH", t, r);
   }
-  getSSE(t, r, n) {
-    var c, y;
+  /**
+   * The HTTP request implementations. Normally you should use the `get`, `post`, `put`, `delete`,
+   * `patch` methods instead.
+   * @param method HTTP request method, e.g. GET, POST, PUT, DELETE, etc.
+   * @param url The URL to send the request to.
+   * @param options Optional parameters for the request.
+   * @returns A promise that resolves to the HTTP response.
+   */
+  async request(t, r, n) {
+    var l, h;
     const s = new I(n == null ? void 0 : n.headers), o = new B(n == null ? void 0 : n.params), i = new G(t, r, {
       headers: s,
       params: o,
-      withCredentials: (c = n == null ? void 0 : n.withCredentials) != null ? c : !1,
-      reportProgress: !0,
-      responseType: (y = n == null ? void 0 : n.responseType) != null ? y : "json",
+      withCredentials: (l = n == null ? void 0 : n.withCredentials) != null ? l : !1,
+      // default value for withCredentials is false by MDN
+      responseType: (h = n == null ? void 0 : n.responseType) != null ? h : "json",
       body: ["GET", "DELETE"].includes(t) || n == null ? void 0 : n.body
-    });
-    return M(i).pipe(j((a) => this._runInterceptorsAndImplementation(a)));
+    }), c = j(i).pipe(
+      M((a) => this._runInterceptorsAndImplementation(a))
+    );
+    return await se(c);
   }
-  /** The HTTP request implementations */
-  async _request(t, r, n) {
-    var a, h;
+  /**
+   * Send an HTTP request. It returns an observable that emits HTTP events. For example, it can be used to
+   * send Server-Sent Events (SSE) requests.
+   * @deprecated Please use `stream` method instead.
+   * @param method HTTP request method, e.g. GET, POST, PUT, DELETE, etc.
+   * @param url The URL to send the request to.
+   * @param _params Optional parameters for the request.
+   * @returns An observable of the HTTP event.
+   */
+  stream(t, r, n) {
+    return this.getSSE(t, r, n);
+  }
+  /**
+   * Send a Server-Sent Events (SSE) request. It returns an observable that emits HTTP events. It is the observable
+   * pair of the `request` method.
+   * @deprecated Please use `stream` method instead.
+   * @param method HTTP request method, e.g. GET, POST, PUT, DELETE, etc.
+   * @param url The URL to send the request to.
+   * @param _params Optional parameters for the request.
+   * @returns An observable of the HTTP event.
+   */
+  getSSE(t, r, n) {
+    var c, d;
     const s = new I(n == null ? void 0 : n.headers), o = new B(n == null ? void 0 : n.params), i = new G(t, r, {
       headers: s,
       params: o,
-      withCredentials: (a = n == null ? void 0 : n.withCredentials) != null ? a : !1,
-      // default value for withCredentials is false by MDN
-      responseType: (h = n == null ? void 0 : n.responseType) != null ? h : "json",
+      withCredentials: (c = n == null ? void 0 : n.withCredentials) != null ? c : !1,
+      reportProgress: !0,
+      responseType: (d = n == null ? void 0 : n.responseType) != null ? d : "json",
       body: ["GET", "DELETE"].includes(t) || n == null ? void 0 : n.body
-    }), c = M(i).pipe(
-      j((l) => this._runInterceptorsAndImplementation(l))
-    );
-    return await se(c);
+    });
+    return j(i).pipe(M((l) => this._runInterceptorsAndImplementation(l)));
   }
   // eslint-disable-next-line ts/no-explicit-any
   _runInterceptorsAndImplementation(t) {
@@ -174,8 +202,8 @@ let x = class extends J {
     );
   }
 };
-x = de([
-  pe(0, K)
+x = pe([
+  de(0, K)
 ], x);
 function ue(e, t) {
   return (r, n) => t(r, (s) => e(s, n));
@@ -189,17 +217,17 @@ class $ {
     status: n,
     statusText: s
   }) {
-    p(this, "type", 1);
-    p(this, "body");
-    p(this, "headers");
-    p(this, "status");
-    p(this, "statusText");
+    u(this, "type", 1);
+    u(this, "body");
+    u(this, "headers");
+    u(this, "status");
+    u(this, "statusText");
     this.body = t, this.headers = r, this.status = n, this.statusText = s;
   }
 }
 class ye {
   constructor(t, r, n) {
-    p(this, "type", 0);
+    u(this, "type", 0);
     this.total = t, this.loaded = r, this.partialText = n;
   }
 }
@@ -216,11 +244,11 @@ class v {
     statusText: s,
     error: o
   }) {
-    p(this, "request");
-    p(this, "headers");
-    p(this, "status");
-    p(this, "statusText");
-    p(this, "error");
+    u(this, "request");
+    u(this, "headers");
+    u(this, "status");
+    u(this, "statusText");
+    u(this, "error");
     this.request = t, this.headers = r, this.status = n, this.statusText = s, this.error = o;
   }
 }
@@ -236,7 +264,7 @@ var me = Object.getOwnPropertyDescriptor, ve = (e, t, r, n) => {
   for (var s = n > 1 ? void 0 : n ? me(t, r) : t, o = e.length - 1, i; o >= 0; o--)
     (i = e[o]) && (s = i(s) || s);
   return s;
-}, _e = (e, t) => (r, n) => t(r, n, e);
+}, Ee = (e, t) => (r, n) => t(r, n, e);
 let N = class {
   constructor(e) {
     this._logService = e;
@@ -253,23 +281,23 @@ let N = class {
     });
   }
   async _send(e, t, r) {
-    var a, h;
+    var l, h;
     let n;
     try {
-      const l = Q(e), w = e.getUrlWithParams(), d = fetch(w, {
+      const a = Q(e), g = e.getUrlWithParams(), p = fetch(g, {
         signal: r.signal,
-        ...l
+        ...a
       });
-      this._logService.debug(`[FetchHTTPImplementation]: sending request to url ${w} with params ${l}`), n = await d;
-    } catch (l) {
-      const w = new v({
+      this._logService.debug(`[FetchHTTPImplementation]: sending request to url ${g} with params ${a}`), n = await p;
+    } catch (a) {
+      const g = new v({
         request: e,
-        error: l,
-        status: (a = l.status) != null ? a : 0,
-        statusText: (h = l.statusText) != null ? h : "Unknown Error",
-        headers: l.headers
+        error: a,
+        status: (l = a.status) != null ? l : 0,
+        statusText: (h = a.statusText) != null ? h : "Unknown Error",
+        headers: a.headers
       });
-      this._logService.error("[FetchHTTPImplementation]: network error", w), t.error(w);
+      this._logService.error("[FetchHTTPImplementation]: network error", g), t.error(g);
       return;
     }
     const s = new I(n.headers), o = n.status, i = n.statusText;
@@ -282,52 +310,52 @@ let N = class {
         statusText: i
       }));
     else {
-      const l = new v({
+      const a = new v({
         request: e,
         error: c,
         status: o,
         statusText: i,
         headers: s
       });
-      this._logService.error("[FetchHTTPImplementation]: network error", l), t.error(l);
+      this._logService.error("[FetchHTTPImplementation]: network error", a), t.error(a);
     }
     t.complete();
   }
   async _readBody(e, t, r) {
-    var w, d;
+    var g, p;
     const n = [], s = t.body.getReader(), o = t.headers.get("content-length");
     let i = 0;
-    const c = (w = e.requestParams) == null ? void 0 : w.reportProgress, y = e.responseType;
-    let a, h;
+    const c = (g = e.requestParams) == null ? void 0 : g.reportProgress, d = e.responseType;
+    let l, h;
     for (; ; ) {
-      const { done: u, value: f } = await s.read();
-      if (u) break;
-      n.push(f), i += f.length, c && y === "text" && (a = (a != null ? a : "") + (h != null ? h : h = new TextDecoder()).decode(f, { stream: !0 }), r.next(new ye(
+      const { done: f, value: y } = await s.read();
+      if (f) break;
+      n.push(y), i += y.length, c && d === "text" && (l = (l != null ? l : "") + (h != null ? h : h = new TextDecoder()).decode(y, { stream: !0 }), r.next(new ye(
         o ? Number.parseInt(o, 10) : void 0,
         i,
-        a
+        l
       )));
     }
-    const l = Ee(n, i);
+    const a = _e(n, i);
     try {
-      const u = (d = t.headers.get("content-type")) != null ? d : "";
-      return Ie(e, l, u);
-    } catch (u) {
-      const f = new v({
+      const f = (p = t.headers.get("content-type")) != null ? p : "";
+      return Ie(e, a, f);
+    } catch (f) {
+      const y = new v({
         request: e,
-        error: u,
+        error: f,
         status: t.status,
         statusText: t.statusText,
         headers: new I(t.headers)
       });
-      return this._logService.error("[FetchHTTPImplementation]: network error", f), r.error(f), null;
+      return this._logService.error("[FetchHTTPImplementation]: network error", y), r.error(y), null;
     }
   }
 };
 N = ve([
-  _e(0, D)
+  Ee(0, D)
 ], N);
-function Ee(e, t) {
+function _e(e, t) {
   const r = new Uint8Array(t);
   let n = 0;
   for (const s of e)
@@ -361,57 +389,57 @@ let O = class {
   }
   send(e) {
     return new m((t) => {
-      const r = new XMLHttpRequest(), n = e.getUrlWithParams(), s = Q(e);
-      r.open(e.method, n), e.withCredentials && (r.withCredentials = !0), s.headers && Object.entries(s.headers).forEach(([a, h]) => r.setRequestHeader(a, h));
-      const o = () => {
-        const a = r.statusText || "OK", h = new I(r.getAllResponseHeaders());
-        return new we(h, r.status, a);
-      }, i = () => {
-        const { headers: a, statusText: h, status: l } = o(), { responseType: w } = e;
-        let d = null, u = null;
-        l !== L.NoContent && (d = typeof r.response > "u" ? r.responseText : r.response);
-        let f = l >= ge && l < fe;
-        if (w === "json" && typeof d == "string") {
-          const g = d;
+      const r = new XMLHttpRequest(), n = e.getUrlWithParams(), s = Q(e), { responseType: o } = e;
+      r.open(e.method, n), e.withCredentials && (r.withCredentials = !0), s.headers && Object.entries(s.headers).forEach(([h, a]) => r.setRequestHeader(h, a));
+      const i = () => {
+        const h = r.statusText || "OK", a = new I(r.getAllResponseHeaders());
+        return new we(a, r.status, h);
+      }, c = () => {
+        const { headers: h, statusText: a, status: g } = i();
+        let p = null, f = null;
+        g !== L.NoContent && (p = typeof r.response > "u" ? r.responseText : r.response);
+        let y = g >= ge && g < fe;
+        if (o === "json" && typeof p == "string") {
+          const w = p;
           try {
-            d = d ? JSON.parse(d) : null;
-          } catch (_) {
-            f = !1, d = g, u = _;
+            p = p ? JSON.parse(p) : null;
+          } catch (E) {
+            y = !1, p = w, f = E;
           }
         }
-        if (f)
+        if (o === "blob" && !(p instanceof Blob) && (y = !1, f = new Error("Response is not a Blob object")), y)
           t.next(
             new $({
-              body: d,
-              headers: a,
-              status: l,
-              statusText: h
+              body: p,
+              headers: h,
+              status: g,
+              statusText: a
             })
           );
         else {
-          const g = new v({
+          const w = new v({
             request: e,
-            error: u,
-            headers: a,
-            status: l,
-            statusText: h
+            error: f,
+            headers: h,
+            status: g,
+            statusText: a
           });
-          this._logService.error("[XHRHTTPImplementation]: network error", g), t.error(g);
+          this._logService.error("[XHRHTTPImplementation]: network error", w), t.error(w);
         }
-      }, c = (a) => {
-        const h = new v({
+      }, d = (h) => {
+        const a = new v({
           request: e,
-          error: a,
+          error: h,
           status: r.status || 0,
           statusText: r.statusText || "Unknown Error",
-          headers: o().headers
+          headers: i().headers
         });
-        this._logService.error("[XHRHTTPImplementation]: network error", h), t.error(h);
+        this._logService.error("[XHRHTTPImplementation]: network error", a), t.error(a);
       };
-      r.addEventListener("load", i), r.addEventListener("error", c), r.addEventListener("abort", c), r.addEventListener("timeout", c);
-      const y = e.getBody();
-      return r.send(y), this._logService.debug("[XHRHTTPImplementation]", `sending request to url ${n} with params ${s}`), () => {
-        r.readyState !== r.DONE && r.abort(), r.removeEventListener("load", i), r.removeEventListener("error", c), r.removeEventListener("abort", c), r.removeEventListener("timeout", c);
+      r.responseType = o || "", r.addEventListener("load", c), r.addEventListener("error", d), r.addEventListener("abort", d), r.addEventListener("timeout", d);
+      const l = e.getBody();
+      return r.send(l), this._logService.debug("[XHRHTTPImplementation]", `sending request to url ${n} with params ${s}`), () => {
+        r.readyState !== r.DONE && r.abort(), r.removeEventListener("load", c), r.removeEventListener("error", d), r.removeEventListener("abort", d), r.removeEventListener("timeout", d);
       };
     });
   }
@@ -443,12 +471,12 @@ let X = (k = class extends C {
       [K, { useClass: t }]
     ], (s = this._config) == null ? void 0 : s.override));
   }
-}, p(k, "pluginName", "UNIVER_NETWORK_PLUGIN"), k);
+}, u(k, "pluginName", "UNIVER_NETWORK_PLUGIN"), k);
 X = Ae([
   W(1, D),
   W(2, S(H))
 ], X);
-const je = V("univer.network.socket.service");
+const Me = V("univer.network.socket.service");
 class Be extends J {
   createSocket(t) {
     try {
@@ -497,13 +525,13 @@ const Fe = 3, ke = 1e3, Ge = (e) => {
   };
   return (s, o) => new m((i) => {
     const c = () => o(s).subscribe({
-      next: (a) => i.next(a),
-      error: (a) => i.error(a),
+      next: (l) => i.next(l),
+      error: (l) => i.error(l),
       complete: () => i.complete()
-    }), y = () => {
+    }), d = () => {
       r.delete(c), z(t, c), n();
     };
-    return t.push(c), n(), y;
+    return t.push(c), n(), d;
   });
 }, Xe = (e) => {
   const { errorStatusCodes: t, onAuthError: r } = e;
@@ -523,36 +551,36 @@ const Fe = 3, ke = 1e3, Ge = (e) => {
     };
   });
 }, Oe = () => (e, t) => t.map((r) => ({ config: r, result: e })), Ve = (e, t = {}) => {
-  const { isMatch: r, getParamsFromRequest: n, mergeParamsToRequest: s } = e, { fetchCheck: o = Ue(300), distributeResult: i = Oe() } = t, c = [], y = (a) => a.map((h) => h.config);
-  return (a, h) => r(a) ? new m((l) => {
-    const w = n(a);
+  const { isMatch: r, getParamsFromRequest: n, mergeParamsToRequest: s } = e, { fetchCheck: o = Ue(300), distributeResult: i = Oe() } = t, c = [], d = (l) => l.map((h) => h.config);
+  return (l, h) => r(l) ? new m((a) => {
+    const g = n(l);
     c.push({
-      next: (u) => l.next(u),
-      error: (u) => l.error(u),
-      config: w
+      next: (f) => a.next(f),
+      error: (f) => a.error(f),
+      config: g
     });
-    const d = y(c);
-    o(a).then((u) => {
-      if (u) {
-        const f = [];
-        d.forEach((g) => {
-          const _ = c.findIndex((E) => E.config === g);
-          if (_ >= 0) {
-            const [E] = c.splice(_, 1);
-            f.push(E);
+    const p = d(c);
+    o(l).then((f) => {
+      if (f) {
+        const y = [];
+        p.forEach((w) => {
+          const E = c.findIndex((_) => _.config === w);
+          if (E >= 0) {
+            const [_] = c.splice(E, 1);
+            y.push(_);
           }
-        }), h(s(d, a)).subscribe({
-          next: (g) => {
-            if (g.type === Y.Response) {
-              const _ = g.body, E = i(_, d);
-              f.forEach((A) => {
-                const q = E.find((F) => F.config === A.config);
+        }), h(s(p, l)).subscribe({
+          next: (w) => {
+            if (w.type === Y.Response) {
+              const E = w.body, _ = i(E, p);
+              y.forEach((A) => {
+                const q = _.find((F) => F.config === A.config);
                 if (q) {
                   const F = new $({
                     body: q.result,
-                    headers: g.headers,
-                    status: g.status,
-                    statusText: g.statusText
+                    headers: w.headers,
+                    status: w.status,
+                    statusText: w.statusText
                   });
                   A.next(F);
                 } else
@@ -560,12 +588,12 @@ const Fe = 3, ke = 1e3, Ge = (e) => {
               });
             }
           },
-          complete: () => l.complete(),
-          error: (g) => l.error(g)
+          complete: () => a.complete(),
+          error: (w) => a.error(w)
         });
       }
     });
-  }) : h(a);
+  }) : h(l);
 };
 export {
   Xe as AuthInterceptorFactory,
@@ -579,7 +607,7 @@ export {
   x as HTTPService,
   L as HTTPStatusCode,
   K as IHTTPImplementation,
-  je as ISocketService,
+  Me as ISocketService,
   Ve as MergeInterceptorFactory,
   we as ResponseHeader,
   Ge as RetryInterceptorFactory,

package/lib/types/services/http/http.service.d.ts

@@ -3,7 +3,7 @@ import { Observable } from 'rxjs';
 import { HTTPResponseType } from './http';
 import { HTTPInterceptorFn } from './interceptor';
 import { HTTPRequestMethod } from './request';
-import { HTTPEvent } from './response';
+import { HTTPEvent, HTTPResponse } from './response';
 import { IHTTPImplementation } from './implementations/implementation';
 export interface IRequestParams {
     /** Query params. These params would be append to the url before the request is sent. */
@@ -56,13 +56,39 @@ export declare class HTTPService extends Disposable {
      * @returns a disposable handler to remove the interceptor
      */
     registerHTTPInterceptor(interceptor: IHTTPInterceptor): IDisposable;
-    get<T>(url: string, params?: IRequestParams): Promise<HTTPEvent<T>>;
-    post<T>(url: string, params?: IPostRequestParams): Promise<HTTPEvent<T>>;
-    put<T>(url: string, params?: IPostRequestParams): Promise<HTTPEvent<T>>;
-    delete<T>(url: string, params?: IRequestParams): Promise<HTTPEvent<T>>;
-    patch<T>(url: string, params?: IPostRequestParams): Promise<HTTPEvent<T>>;
+    get<T>(url: string, params?: IRequestParams): Promise<HTTPResponse<T>>;
+    post<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>;
+    put<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>;
+    delete<T>(url: string, params?: IRequestParams): Promise<HTTPResponse<T>>;
+    patch<T>(url: string, params?: IPostRequestParams): Promise<HTTPResponse<T>>;
+    /**
+     * The HTTP request implementations. Normally you should use the `get`, `post`, `put`, `delete`,
+     * `patch` methods instead.
+     * @param method HTTP request method, e.g. GET, POST, PUT, DELETE, etc.
+     * @param url The URL to send the request to.
+     * @param options Optional parameters for the request.
+     * @returns A promise that resolves to the HTTP response.
+     */
+    request<T>(method: HTTPRequestMethod, url: string, options?: IRequestParams): Promise<HTTPResponse<T>>;
+    /**
+     * Send an HTTP request. It returns an observable that emits HTTP events. For example, it can be used to
+     * send Server-Sent Events (SSE) requests.
+     * @deprecated Please use `stream` method instead.
+     * @param method HTTP request method, e.g. GET, POST, PUT, DELETE, etc.
+     * @param url The URL to send the request to.
+     * @param _params Optional parameters for the request.
+     * @returns An observable of the HTTP event.
+     */
+    stream<T>(method: HTTPRequestMethod, url: string, _params?: IRequestParams): Observable<HTTPEvent<T>>;
+    /**
+     * Send a Server-Sent Events (SSE) request. It returns an observable that emits HTTP events. It is the observable
+     * pair of the `request` method.
+     * @deprecated Please use `stream` method instead.
+     * @param method HTTP request method, e.g. GET, POST, PUT, DELETE, etc.
+     * @param url The URL to send the request to.
+     * @param _params Optional parameters for the request.
+     * @returns An observable of the HTTP event.
+     */
     getSSE<T>(method: HTTPRequestMethod, url: string, _params?: IPostRequestParams): Observable<HTTPEvent<T>>;
-    /** The HTTP request implementations */
-    private _request;
     private _runInterceptorsAndImplementation;
 }