@gjsify/websocket 0.51.1 → 0.53.0

package/globals.mjs

@@ -5,3 +5,9 @@
 export const WebSocket = globalThis.WebSocket;
 export const MessageEvent = globalThis.MessageEvent;
 export const CloseEvent = globalThis.CloseEvent;
+
+// The internal hook @gjsify/ws reads (src/abort.ts). Symbol.for() yields the
+// same key; a host WebSocket carries no method under it, so ws falls back to
+// the W3C calls. No Soup here, so no Soup transport error either.
+export const kClose = Symbol.for('gjsify.websocket.close');
+export const isTransportFailure = () => false;

package/lib/esm/abort.js

@@ -0,0 +1 @@
+import"./_virtual/_rolldown/runtime.js";import e from"@girs/glib-2.0";import t from"@girs/gio-2.0";import n from"@girs/soup-3.0";const r=Symbol.for(`gjsify.websocket.close`),i=1006;function soupCloseCode(e,t){let r=e.get_connection_type()===n.WebsocketConnectionType.SERVER;return t===1010?r?1002:t:t===1011?r?t:1002:t>=1e3&&t<=1003||t>=1007&&t<=1009||t>=3e3&&t<=4999?t:1002}function isRefusedEcho(e,t){let r=e.get_close_code();return t.matches(n.websocket_error_quark(),n.WebsocketCloseCode.PROTOCOL_ERROR)&&r>=1012&&r<=1014}function isTransportFailure(n){return n instanceof e.Error&&(n.domain===t.io_error_quark()||n.domain===t.tls_error_quark())}function socketOf(e){let n=e;for(let e=0;n&&e<4;e++){if(n instanceof t.SocketConnection)return n.get_socket();let e=n;n=e.base_iostream??e.base_io_stream}return null}function abortConnection(e){let t=socketOf(e.get_io_stream());if(t)try{t.shutdown(!0,!0)}catch{}else e.get_state()===n.WebsocketState.OPEN&&e.close(n.WebsocketCloseCode.GOING_AWAY,null)}export{i as ABORT_CODE,abortConnection,isRefusedEcho,isTransportFailure,r as kClose,soupCloseCode};

package/lib/esm/index.js

@@ -1 +1 @@
-import"./_virtual/_rolldown/runtime.js";import e from"@girs/glib-2.0";import t from"@girs/soup-3.0";import n from"@girs/gio-2.0";import{CloseEvent as r,Event as i,EventTarget as a,MessageEvent as o}from"@gjsify/dom-events";function extensionName(e){return e instanceof t.WebsocketExtensionDeflate?`permessage-deflate`:(e.constructor.$gtype?.name??``).replace(/^SoupWebsocketExtension/,``).toLowerCase()}function serializeExtensions(e){return!e||e.length===0?``:e.map(e=>{let t=e.get_response_params();return t?`${extensionName(e)}${t}`:extensionName(e)}).join(`, `)}var WebSocket=class extends a{static CONNECTING=0;static OPEN=1;static CLOSING=2;static CLOSED=3;CONNECTING=0;OPEN=1;CLOSING=2;CLOSED=3;url;readyState=0;bufferedAmount=0;extensions=``;protocol=``;binaryType=`blob`;onopen=null;onmessage=null;onerror=null;onclose=null;_connection=null;_session;_protocols;_cancellable=null;_handshakeTimedOut=!1;_handshakeTimer=null;constructor(e,n,r){super(),this.url=typeof e==`string`?e:e.toString(),this._protocols=typeof n==`string`?[n]:n??[],this._session=new t.Session,r?.perMessageDeflate&&(this._session.add_feature_by_type(t.WebsocketExtensionManager.$gtype),this._session.add_feature_by_type(t.WebsocketExtensionDeflate.$gtype)),this._connect(r)}_connect(a){let o=e.Uri.parse(this.url,e.UriFlags.NONE),s=new t.Message({method:`GET`,uri:o});if(a?.headers){let e=s.get_request_headers();for(let[t,n]of Object.entries(a.headers))Array.isArray(n)?n.forEach(n=>e.append(t,n)):e.replace(t,n)}if(a?.handshakeTimeout){this._cancellable=new n.Cancellable;let e=this._cancellable;this._handshakeTimer=setTimeout(()=>{this._handshakeTimedOut=!0,this._handshakeTimer=null,e.cancel()},a.handshakeTimeout)}this._session.websocket_connect_async(s,a?.origin??null,this._protocols.length>0?this._protocols:null,e.PRIORITY_DEFAULT,this._cancellable,(e,t)=>{this._handshakeTimer!==null&&(clearTimeout(this._handshakeTimer),this._handshakeTimer=null);try{this._connection=this._session.websocket_connect_finish(t),this._connection.max_incoming_payload_size=100*1024*1024,this.readyState=1,this.protocol=this._connection.get_protocol()??``,this.extensions=serializeExtensions(this._connection.get_extensions()),this._connection.connect(`message`,(e,t,n)=>{this._onMessage(t,n)}),this._connection.connect(`closed`,()=>{this._onClosed()}),this._connection.connect(`error`,(e,t)=>{this._onError(t)});let e=new i(`open`);this.dispatchEvent(e),this.onopen&&this.onopen.call(this,e)}catch(e){this.readyState=3;let t=this._handshakeTimedOut?`Opening handshake has timed out`:e instanceof Error?e.message:String(e),n=Error(t),a=new i(`error`);a.error=n,a.message=t,this.dispatchEvent(a),this.onerror&&this.onerror.call(this,a);let o=new r(`close`,{code:1006,reason:t,wasClean:!1});this.dispatchEvent(o),this.onclose&&this.onclose.call(this,o)}})}_onMessage(e,n){let r;if(e===t.WebsocketDataType.TEXT)r=new TextDecoder().decode(n.toArray());else{let e=n.toArray();r=e.buffer.slice(e.byteOffset,e.byteOffset+e.byteLength)}let i=new o(`message`,{data:r,origin:this.url});this.dispatchEvent(i),this.onmessage&&this.onmessage.call(this,i)}_onError(e){let t=new i(`error`);this.dispatchEvent(t),this.onerror&&this.onerror.call(this,t)}_onClosed(){let e=this._connection?.get_close_code()??1006,t=this._connection?.get_close_data()??``,n=e===1e3;this.readyState=3,this._connection=null;let i=new r(`close`,{code:e,reason:t,wasClean:n});this.dispatchEvent(i),this.onclose&&this.onclose.call(this,i)}send(n){if(this.readyState!==1)throw new DOMException(`WebSocket is not open`,`InvalidStateError`);if(this._connection)if(typeof n==`string`){let r=new TextEncoder().encode(n);this._connection.send_message(t.WebsocketDataType.TEXT,new e.Bytes(r))}else{let r;r=n instanceof ArrayBuffer?new Uint8Array(n):new Uint8Array(n.buffer,n.byteOffset,n.byteLength),this._connection.send_message(t.WebsocketDataType.BINARY,new e.Bytes(r))}}close(e,t){if(!(this.readyState===3||this.readyState===2)){if(e!==void 0&&e!==1e3&&(e<3e3||e>4999))throw new DOMException(`The code must be either 1000, or between 3000 and 4999. ${e} is neither.`,`InvalidAccessError`);if(this.readyState=2,this._connection)this._connection.close(e??1e3,t??null);else{this.readyState=3;let e=new r(`close`,{code:1006,wasClean:!1});this.dispatchEvent(e),this.onclose&&this.onclose.call(this,e)}}}};export{r as CloseEvent,o as MessageEvent,WebSocket,WebSocket as default};
+import"./_virtual/_rolldown/runtime.js";import{ABORT_CODE as e,abortConnection as t,isRefusedEcho as n,isTransportFailure as r,kClose as i,soupCloseCode as a}from"./abort.js";import o from"@girs/glib-2.0";import s from"@girs/gio-2.0";import c from"@girs/soup-3.0";import{CloseEvent as l,Event as u,EventTarget as d,MessageEvent as f}from"@gjsify/dom-events";function extensionName(e){return e instanceof c.WebsocketExtensionDeflate?`permessage-deflate`:(e.constructor.$gtype?.name??``).replace(/^SoupWebsocketExtension/,``).toLowerCase()}function serializeExtensions(e){return!e||e.length===0?``:e.map(e=>{let t=e.get_response_params();return t?`${extensionName(e)}${t}`:extensionName(e)}).join(`, `)}function acceptsAnyCertificate(e){return e===void 0?o.getenv(`NODE_TLS_REJECT_UNAUTHORIZED`)===`0`:!e}var WebSocket=class extends d{static CONNECTING=0;static OPEN=1;static CLOSING=2;static CLOSED=3;CONNECTING=0;OPEN=1;CLOSING=2;CLOSED=3;url;readyState=0;bufferedAmount=0;extensions=``;protocol=``;binaryType=`blob`;onopen=null;onmessage=null;onerror=null;onclose=null;_connection=null;_session;_protocols;_cancellable=new s.Cancellable;_failReason=null;_handshakeTimer=null;constructor(e,t,n){super(),this.url=typeof e==`string`?e:e.toString(),this._protocols=typeof t==`string`?[t]:t??[],this._session=new c.Session,n?.perMessageDeflate&&(this._session.add_feature_by_type(c.WebsocketExtensionManager.$gtype),this._session.add_feature_by_type(c.WebsocketExtensionDeflate.$gtype)),this._connect(n)}_connect(e){let r=o.Uri.parse(this.url,o.UriFlags.NONE);r.get_path()||(r=o.Uri.build(o.UriFlags.NONE,r.get_scheme(),r.get_userinfo(),r.get_host(),r.get_port(),`/`,r.get_query(),r.get_fragment()));let i=new c.Message({method:`GET`,uri:r});if(e?.headers){let t=i.get_request_headers();for(let[n,r]of Object.entries(e.headers))Array.isArray(r)?r.forEach(e=>t.append(n,e)):t.replace(n,r)}r.get_scheme()===`wss`&&acceptsAnyCertificate(e?.rejectUnauthorized)&&i.connect(`accept-certificate`,()=>!0),e?.handshakeTimeout&&(this._handshakeTimer=setTimeout(()=>{this._handshakeTimer=null,this._failConnecting(`Opening handshake has timed out`)},e.handshakeTimeout)),this._session.websocket_connect_async(i,e?.origin??null,this._protocols.length>0?this._protocols:null,o.PRIORITY_DEFAULT,this._cancellable,(e,r)=>{this._handshakeTimer!==null&&(clearTimeout(this._handshakeTimer),this._handshakeTimer=null);try{let e=this._session.websocket_connect_finish(r);if(this._failReason!==null)throw t(e),Error(this._failReason);this._connection=e,this._connection.max_incoming_payload_size=100*1024*1024,this.readyState=1,this.protocol=this._connection.get_protocol()??``,this.extensions=serializeExtensions(this._connection.get_extensions()),this._connection.connect(`message`,(e,t,n)=>{this._onMessage(t,n)}),this._connection.connect(`closing`,()=>{this.readyState===1&&(this.readyState=2)}),this._connection.connect(`closed`,()=>{this._onClosed()}),this._connection.connect(`error`,(e,t)=>{n(e,t)||this._onError(t)});let i=new u(`open`);this.dispatchEvent(i),this.onopen&&this.onopen.call(this,i)}catch(e){this.readyState=3;let t=this._failReason??(e instanceof Error?e.message:String(e)),n=Error(t),r=new u(`error`);r.error=n,r.message=t,this.dispatchEvent(r),this.onerror&&this.onerror.call(this,r);let i=new l(`close`,{code:1006,reason:``,wasClean:!1});this.dispatchEvent(i),this.onclose&&this.onclose.call(this,i)}})}_onMessage(e,t){let n;if(e===c.WebsocketDataType.TEXT)n=new TextDecoder().decode(t.toArray());else{let e=t.toArray();n=e.buffer.slice(e.byteOffset,e.byteOffset+e.byteLength)}let r=new f(`message`,{data:n,origin:this.url});this.dispatchEvent(r),this.onmessage&&this.onmessage.call(this,r)}_onError(e){let t=new u(`error`);t.error=Error(e.message,{cause:e}),t.message=e.message,this.dispatchEvent(t),this.onerror&&this.onerror.call(this,t)}_onClosed(){let e=this._connection?.get_close_code()||1006,t=this._connection?.get_close_data()??``,n=e!==1006;this.readyState=3,this._connection=null;let r=new l(`close`,{code:e,reason:t,wasClean:n});this.dispatchEvent(r),this.onclose&&this.onclose.call(this,r)}send(e){if(this.readyState===0)throw new DOMException(`WebSocket is not open`,`InvalidStateError`);if(this.readyState!==1||!this._isSoupOpen()){this.bufferedAmount+=typeof e==`string`?new TextEncoder().encode(e).byteLength:e.byteLength;return}if(this._connection)if(typeof e==`string`){let t=new TextEncoder().encode(e);this._connection.send_message(c.WebsocketDataType.TEXT,new o.Bytes(t))}else{let t;t=e instanceof ArrayBuffer?new Uint8Array(e):new Uint8Array(e.buffer,e.byteOffset,e.byteLength),this._connection.send_message(c.WebsocketDataType.BINARY,new o.Bytes(t))}}close(e,t){if(e!==void 0&&e!==1e3&&(e<3e3||e>4999))throw new DOMException(`The code must be either 1000, or between 3000 and 4999. ${e} is neither.`,`InvalidAccessError`);if(t!==void 0&&new TextEncoder().encode(t).byteLength>123)throw new DOMException(`The close reason must not be greater than 123 UTF-8 bytes.`,`SyntaxError`);this[i](e,t)}[i](n,r){if(this.readyState===3)return;let i=n===e;if(!(this.readyState===2&&!i)){if(!this._connection){this._failConnecting(`WebSocket was closed before the connection was established`);return}if(this.readyState=2,i){t(this._connection);return}this._isSoupOpen()&&this._connection.close(a(this._connection,n??1e3),r??null)}}_failConnecting(e){this.readyState===3||this._failReason!==null||(this._failReason=e,this.readyState=2,this._handshakeTimer!==null&&(clearTimeout(this._handshakeTimer),this._handshakeTimer=null),this._cancellable.cancel())}_isSoupOpen(){return this._connection?.get_state()===c.WebsocketState.OPEN}};export{l as CloseEvent,f as MessageEvent,WebSocket,WebSocket as default,t as abortConnection,n as isRefusedEcho,r as isTransportFailure,i as kClose,a as soupCloseCode};

package/lib/types/abort.d.ts

@@ -0,0 +1,46 @@
+import GLib from '@girs/glib-2.0';
+import Soup from '@girs/soup-3.0';
+/** The one internal hook on {@link WebSocket} instances: close() without the
+ *  W3C restriction on `code`. The spec's close() admits only 1000 and
+ *  3000–4999 from script; npm ws also sends 1001–1014, and its terminate()
+ *  drops the connection with no Close frame at all. `@gjsify/ws` validates by
+ *  ws's rules and calls this for both. 1006 is RFC 6455's code for "closed
+ *  without a Close frame" and never goes on the wire, so it selects the
+ *  abort: `[kClose](1006)` is terminate(), any other code a Close frame.
+ *  @internal */
+export declare const kClose: unique symbol;
+/** The status code that makes {@link kClose} abort instead of closing. */
+export declare const ABORT_CODE = 1006;
+/** The code Soup will actually put in a Close frame for `code`. libsoup's
+ *  close_connection() knows only 1000–1003, 1007–1011 and 3000–4999 —
+ *  RFC 6455's original registry — and restricts 1010 to clients and 1011 to
+ *  servers. An unknown code (1012–1014, registered later) it turns into a
+ *  protocol error plus an 'error' signal; a role-restricted one is a
+ *  g_return_if_fail CRITICAL that sends nothing and leaves the connection
+ *  open. Both are worse than the substitute libsoup itself falls back to, so
+ *  we send 1002 directly: the connection closes, no CRITICAL, no spurious
+ *  'error'. Upstream: status/upstream-patch-candidates.md.
+ *  @internal */
+export declare function soupCloseCode(conn: Soup.WebsocketConnection, code: number): number;
+/** Whether an error Soup emitted is its own refusal to echo a peer's valid
+ *  close code. On a received Close, libsoup answers through the same
+ *  close_connection() that rejects 1012–1014 (see soupCloseCode), so a peer's
+ *  "service restart" raises a protocol error although the peer broke nothing.
+ *  The close still carries the peer's code; only the 'error' is spurious — for
+ *  the W3C API and npm ws alike.
+ *  @internal */
+export declare function isRefusedEcho(conn: Soup.WebsocketConnection, error: GLib.Error): boolean;
+/** Whether an error Soup's WebsocketConnection emitted is the transport
+ *  failing — a reset, a TLS EOF — rather than the peer breaking the protocol
+ *  (Soup.WebsocketError). npm ws reports only the latter as 'error'; the
+ *  former ends in 'close' (1006) alone, which Soup emits next.
+ *  @internal */
+export declare function isTransportFailure(error: unknown): boolean;
+/** Drop the connection without a Close frame. Soup's close() cannot: it
+ *  rejects 1006 with a CRITICAL and sends nothing. Shutting the socket down —
+ *  never closing it — lets Soup's pending read see EOF, record a dirty close
+ *  and emit 'closed' itself, exactly once; Soup still owns and closes the
+ *  stream. Closing the fd instead would leave Soup polling a dead descriptor
+ *  and emitting 'error'.
+ *  @internal */
+export declare function abortConnection(conn: Soup.WebsocketConnection): void;

package/lib/types/index.d.ts

@@ -1,5 +1,7 @@
 import { Event, EventTarget, MessageEvent, CloseEvent } from '@gjsify/dom-events';
+import { abortConnection, isRefusedEcho, isTransportFailure, kClose, soupCloseCode } from './abort.js';
 export { MessageEvent, CloseEvent };
+export { abortConnection, isRefusedEcho, isTransportFailure, kClose, soupCloseCode };
 /** Options for the WebSocket constructor. Extends the W3C spec with Soup-level knobs. */
 export interface WebSocketOptions {
     /** Offer permessage-deflate (RFC 7692) during the WebSocket handshake.
@@ -21,6 +23,11 @@ export interface WebSocketOptions {
     /** Abort the opening handshake after this many milliseconds. Fires an
      *  'error' event with message "Opening handshake has timed out". */
     handshakeTimeout?: number;
+    /** `false` accepts any server certificate on a `wss:` URL — npm ws's
+     *  (and Node TLS's) option of the same name. Applies to this connection's
+     *  upgrade message only. Unset, `NODE_TLS_REJECT_UNAUTHORIZED=0` opts
+     *  out as it does in Node; `true` keeps verification regardless. */
+    rejectUnauthorized?: boolean;
 }
 /**
  * W3C WebSocket API implementation using Soup 3.0.
@@ -54,7 +61,8 @@ export declare class WebSocket extends EventTarget {
     private _session;
     private _protocols;
     private _cancellable;
-    private _handshakeTimedOut;
+    /** Why the handshake is being abandoned; the failure path reports it. */
+    private _failReason;
     private _handshakeTimer;
     constructor(url: string | URL, protocols?: string | string[], options?: WebSocketOptions);
     private _connect;
@@ -78,5 +86,17 @@ export declare class WebSocket extends EventTarget {
      * Close the WebSocket connection.
      */
     close(code?: number, reason?: string): void;
+    /** @internal close() without the W3C restriction on `code`: any status
+     *  RFC 6455 lets an endpoint send (1000–1003, 1007–1014, 3000–4999),
+     *  which is what npm ws accepts, or {@link ABORT_CODE} to drop the
+     *  connection without a Close frame (ws's terminate()); 'close' then
+     *  follows with 1006. The caller validates. Codes libsoup cannot send go
+     *  out as 1002 (see soupCloseCode). See {@link kClose}. */
+    [kClose](code?: number, reason?: string): void;
+    /** Abandon the handshake. The connect callback runs with the cancel
+     *  error and reports `reason` — asynchronously, as the spec's "fail the
+     *  WebSocket connection" queues its events. The first reason wins. */
+    private _failConnecting;
+    private _isSoupOpen;
 }
 export default WebSocket;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/websocket",
-    "version": "0.51.1",
+    "version": "0.53.0",
     "description": "W3C WebSocket API for GJS using Soup 3.0",
     "type": "module",
     "module": "lib/esm/index.js",
@@ -42,17 +42,17 @@
         "soup"
     ],
     "devDependencies": {
-        "@gjsify/cli": "^0.51.1",
-        "@gjsify/unit": "^0.51.1",
+        "@gjsify/cli": "^0.53.0",
+        "@gjsify/unit": "^0.53.0",
         "@types/node": "^25.9.2",
         "typescript": "^6.0.3"
     },
     "dependencies": {
-        "@girs/gio-2.0": "5.0.0",
-        "@girs/gjs": "5.0.0",
-        "@girs/glib-2.0": "5.0.0",
-        "@girs/soup-3.0": "5.0.0",
-        "@gjsify/dom-events": "^0.51.1"
+        "@girs/gio-2.0": "5.4.0",
+        "@girs/gjs": "5.4.0",
+        "@girs/glib-2.0": "5.4.0",
+        "@girs/soup-3.0": "5.4.0",
+        "@gjsify/dom-events": "^0.53.0"
     },
     "gjsify": {
         "runtimes": {