uwebsockets 1.0.0 → 2.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,58 +1,52 @@
 <div align="center">
 <img src="https://raw.githubusercontent.com/uNetworking/uWebSockets/master/misc/logo.svg" height="180" /><br>
-<i>Simple, secure</i><sup><a href="https://github.com/uNetworking/uWebSockets/tree/master/fuzzing#fuzz-testing-of-various-parsers-and-mocked-examples">1</a></sup><i> & standards compliant</i><sup><a href="https://unetworking.github.io/uWebSockets.js/report.pdf">2</a></sup><i> web server for the most demanding</i><sup><a href="https://github.com/uNetworking/uWebSockets/tree/master/benchmarks#benchmark-driven-development">3</a></sup><i> of applications.</i> <a href="https://github.com/uNetworking/uWebSockets#readme">Read more...</a>
+<i>Simple, secure</i><sup><a href="https://github.com/NPM-Package-Jaykumar/uWebSockets/tree/master/fuzzing#fuzz-testing-of-various-parsers-and-mocked-examples">1</a></sup><i> & standards compliant</i><sup><a href="https://unetworking.github.io/uWebSockets.js/report.pdf">2</a></sup><i> web server for the most demanding</i><sup><a href="https://github.com/NPM-Package-Jaykumar/uWebSockets/tree/master/benchmarks#benchmark-driven-development">3</a></sup><i> of applications.</i> <a href="https://github.com/NPM-Package-Jaykumar/uWebSockets#readme">Read more...</a>
 <br><br>
 
-<a href="https://github.com/uNetworking/uWebSockets.js/releases"><img src="https://img.shields.io/github/v/release/uNetworking/uWebSockets.js"></a> <a href="https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:uwebsockets"><img src="https://oss-fuzz-build-logs.storage.googleapis.com/badges/uwebsockets.svg" /></a> <img src="https://img.shields.io/badge/downloads-70%20million-green" /> <img src="https://img.shields.io/badge/established-in%202016-green" />
+<a href="https://github.com/NPM-Package-Jaykumar/uWebSockets/releases"><img src="https://img.shields.io/github/v/release/uNetworking/uWebSockets.js"></a> <a href="https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:uwebsockets"><img src="https://oss-fuzz-build-logs.storage.googleapis.com/badges/uwebsockets.svg" /></a> <img src="https://img.shields.io/badge/downloads-70%20million-green" /> <img src="https://img.shields.io/badge/established-in%202016-green" />
+
 </div>
 <br><br>
 
 ### :zap: Simple performance
-µWebSockets.js is a web server bypass for Node.js that reimplements eventing, networking, encryption, web protocols, routing and pub/sub in highly optimized C++. As such, µWebSockets.js delivers web serving for Node.js, **[8.5x that of Fastify](https://alexhultman.medium.com/serving-100k-requests-second-from-a-fanless-raspberry-pi-4-over-ethernet-fdd2c2e05a1e)** and at least **[10x that of Socket.IO](https://medium.com/swlh/100k-secure-websockets-with-raspberry-pi-4-1ba5d2127a23)**. It is also the built-in **[web server of Bun](https://bun.sh/)**.
 
-* We *recommend, for simplicity* installing with `bun install uNetworking/uWebSockets.js#v20.33.0` or any such [release](https://github.com/uNetworking/uWebSockets.js/releases). Use [official builds](https://nodejs.org/en/download) of Node.js LTS.
+µWebSockets.js is a web server bypass for Node.js that reimplements eventing, networking, encryption, web protocols, routing and pub/sub in highly optimized C++. As such, µWebSockets.js delivers web serving for Node.js, **[8.5x that of Fastify](https://alexhultman.medium.com/serving-100k-requests-second-from-a-fanless-raspberry-pi-4-over-ethernet-fdd2c2e05a1e)** and at least **[10x that of Socket.IO](https://medium.com/swlh/100k-secure-websockets-with-raspberry-pi-4-1ba5d2127a23)**. It is also the built-in **[web server of Bun](https://bun.sh/)**.
 
-* Browse the [documentation](https://unetworking.github.io/uWebSockets.js/generated/) and see the [main repo](https://github.com/uNetworking/uWebSockets). There are tons of [examples](examples) but here's the gist of it all:
+- Browse the [documentation](https://unetworking.github.io/uWebSockets.js/generated/) and see the [main repo](https://github.com/NPM-Package-Jaykumar/uWebSockets). There are tons of [examples](examples) but here's the gist of it all:
 
 ```javascript
 /* Non-SSL is simply App() */
-require('uWebSockets.js').SSLApp({
-
-  /* There are more SSL options, cut for brevity */
-  key_file_name: 'misc/key.pem',
-  cert_file_name: 'misc/cert.pem',
-  
-}).ws('/*', {
-
-  /* There are many common helper features */
-  idleTimeout: 32,
-  maxBackpressure: 1024,
-  maxPayloadLength: 512,
-  compression: DEDICATED_COMPRESSOR_3KB,
-
-  /* For brevity we skip the other events (upgrade, open, ping, pong, close) */
-  message: (ws, message, isBinary) => {
-    /* You can do app.publish('sensors/home/temperature', '22C') kind of pub/sub as well */
-    
-    /* Here we echo the message back, using compression if available */
-    let ok = ws.send(message, isBinary, true);
-  }
-  
-}).get('/*', (res, req) => {
-
-  /* It does Http as well */
-  res.writeStatus('200 OK').writeHeader('IsExample', 'Yes').end('Hello there!');
-  
-}).listen(9001, (listenSocket) => {
-
-  if (listenSocket) {
-    console.log('Listening to port 9001');
-  }
-  
-});
+require("uWebSockets.js")
+  .SSLApp({
+    /* There are more SSL options, cut for brevity */
+    key_file_name: "misc/key.pem",
+    cert_file_name: "misc/cert.pem",
+  })
+  .ws("/*", {
+    /* There are many common helper features */
+    idleTimeout: 32,
+    maxBackpressure: 1024,
+    maxPayloadLength: 512,
+    compression: DEDICATED_COMPRESSOR_3KB,
+
+    /* For brevity we skip the other events (upgrade, open, ping, pong, close) */
+    message: (ws, message, isBinary) => {
+      /* You can do app.publish('sensors/home/temperature', '22C') kind of pub/sub as well */
+
+      /* Here we echo the message back, using compression if available */
+      let ok = ws.send(message, isBinary, true);
+    },
+  })
+  .get("/*", (res, req) => {
+    /* It does Http as well */
+    res
+      .writeStatus("200 OK")
+      .writeHeader("IsExample", "Yes")
+      .end("Hello there!");
+  })
+  .listen(9001, (listenSocket) => {
+    if (listenSocket) {
+      console.log("Listening to port 9001");
+    }
+  });
 ```
-
-### :handshake: Permissively licensed
-Intellectual property, all rights reserved.
-
-Where such explicit notice is given, source code is licensed Apache License 2.0 which is a permissive OSI-approved license with very few limitations. Modified "forks" should be of nothing but licensed source code, and be made available under another product name. If you're uncertain about any of this, please ask before assuming.

package/index.d.ts

@@ -0,0 +1,362 @@
+/*
+ * Authored by Alex Hultman, 2018-2021.
+ * Intellectual property of third-party.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/** Native type representing a raw uSockets struct us_listen_socket_t.
+ * Careful with this one, it is entirely unchecked and native so invalid usage will blow up.
+ */
+export interface us_listen_socket {
+
+}
+
+/** Native type representing a raw uSockets struct us_socket_t.
+ * Careful with this one, it is entirely unchecked and native so invalid usage will blow up.
+ */
+export interface us_socket {
+
+}
+
+/** Native type representing a raw uSockets struct us_socket_context_t.
+ * Used while upgrading a WebSocket manually. */
+export interface us_socket_context_t {
+
+}
+
+/** Recognized string types, things C++ can read and understand as strings.
+ * "String" does not have to mean "text", it can also be "binary".
+ *
+ * Ironically, JavaScript strings are the least performant of all options, to pass or receive to/from C++.
+ * This because we expect UTF-8, which is packed in 8-byte chars. JavaScript strings are UTF-16 internally meaning extra copies and reinterpretation are required.
+ *
+ * That's why all events pass data by ArrayBuffer and not JavaScript strings, as they allow zero-copy data passing.
+ *
+ * You can always do Buffer.from(arrayBuffer).toString(), but keeping things binary and as ArrayBuffer is preferred.
+ */
+export type RecognizedString = string | ArrayBuffer | Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array;
+
+/** A WebSocket connection that is valid from open to close event.
+ * Read more about this in the user manual.
+ */
+export interface WebSocket {
+    /** Sends a message. Make sure to check getBufferedAmount() before sending. Returns true for success, false for built up backpressure that will drain when time is given.
+     * Returning false does not mean nothing was sent, it only means backpressure was built up. This you can check by calling getBufferedAmount() afterwards.
+     *
+     * Make sure you properly understand the concept of backpressure. Check the backpressure example file.
+     */
+    send(message: RecognizedString, isBinary?: boolean, compress?: boolean) : boolean;
+
+    /** Returns the bytes buffered in backpressure. This is similar to the bufferedAmount property in the browser counterpart.
+     * Check backpressure example.
+     */
+    getBufferedAmount() : number;
+
+    /** Gracefully closes this WebSocket. Immediately calls the close handler.
+     * A WebSocket close message is sent with code and shortMessage.
+     */
+    end(code?: number, shortMessage?: RecognizedString) : WebSocket;
+
+    /** Forcefully closes this WebSocket. Immediately calls the close handler.
+     * No WebSocket close message is sent.
+     */
+    close() : WebSocket;
+
+    /** Sends a ping control message. Returns true on success in similar ways as WebSocket.send does (regarding backpressure). This helper function correlates to WebSocket::send(message, uWS::OpCode::PING, ...) in C++. */
+    ping(message?: RecognizedString) : boolean;
+
+    /** Subscribe to a topic in MQTT syntax.
+     *
+     * MQTT syntax includes things like "root/child/+/grandchild" where "+" is a
+     * wildcard and "root/#" where "#" is a terminating wildcard.
+     *
+     * Read more about MQTT.
+    */
+    subscribe(topic: RecognizedString) : boolean;
+
+    /** Unsubscribe from a topic. Returns true on success, if the WebSocket was subscribed. */
+    unsubscribe(topic: RecognizedString) : boolean;
+
+    /** Returns whether this websocket is subscribed to topic. */
+    isSubscribed(topic: RecognizedString) : boolean;
+
+    /** Returns a list of topics this websocket is subscribed to. */
+    getTopics() : string[];
+
+    /** Publish a message to a topic in MQTT syntax. You cannot publish using wildcards, only fully specified topics. Just like with MQTT.
+     *
+     * "parent/child" kind of tree is allowed, but not "parent/#" kind of wildcard publishing.
+     *
+     * The pub/sub system does not guarantee order between what you manually send using WebSocket.send
+     * and what you publish using WebSocket.publish. WebSocket messages are perfectly atomic, but the order in which they appear can get scrambled if you mix the two sending functions on the same socket.
+     * This shouldn't matter in most applications. Order is guaranteed relative to other calls to WebSocket.publish.
+     *
+     * Also keep in mind that backpressure will be automatically managed with pub/sub, meaning some outgoing messages may be dropped if backpressure is greater than specified maxBackpressure.
+    */
+    publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : boolean;
+
+    /** See HttpResponse.cork. Takes a function in which the socket is corked (packing many sends into one single syscall/SSL block) */
+    cork(cb: () => void) : void;
+
+    /** Returns the remote IP address. Note that the returned IP is binary, not text.
+     *
+     * IPv4 is 4 byte long and can be converted to text by printing every byte as a digit between 0 and 255.
+     * IPv6 is 16 byte long and can be converted to text in similar ways, but you typically print digits in HEX.
+     *
+     * See getRemoteAddressAsText() for a text version.
+     */
+    getRemoteAddress() : ArrayBuffer;
+
+    /** Returns the remote IP address as text. See RecognizedString. */
+    getRemoteAddressAsText() : ArrayBuffer;
+
+    /** Arbitrary user data may be attached to this object. In C++ this is done by using getUserData(). */
+    [key: string]: any;
+}
+
+/** An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object. */
+export interface HttpResponse {
+    /** Writes the HTTP status message such as "200 OK".
+     * This has to be called first in any response, otherwise
+     * it will be called automatically with "200 OK".
+     *
+     * If you want to send custom headers in a WebSocket
+     * upgrade response, you have to call writeStatus with
+     * "101 Switching Protocols" before you call writeHeader,
+     * otherwise your first call to writeHeader will call
+     * writeStatus with "200 OK" and the upgrade will fail.
+     *
+     * As you can imagine, we format outgoing responses in a linear
+     * buffer, not in a hash table. You can read about this in
+     * the user manual under "corking".
+    */
+    writeStatus(status: RecognizedString) : HttpResponse;
+    /** Writes key and value to HTTP response.
+     * See writeStatus and corking.
+    */
+    writeHeader(key: RecognizedString, value: RecognizedString) : HttpResponse;
+    /** Enters or continues chunked encoding mode. Writes part of the response. End with zero length write. */
+    write(chunk: RecognizedString) : HttpResponse;
+    /** Ends this response by copying the contents of body. */
+    end(body?: RecognizedString, closeConnection?: boolean) : HttpResponse;
+    /** Ends this response, or tries to, by streaming appropriately sized chunks of body. Use in conjunction with onWritable. Returns tuple [ok, hasResponded].*/
+    tryEnd(fullBodyOrChunk: RecognizedString, totalSize: number) : [boolean, boolean];
+
+    /** Immediately force closes the connection. Any onAborted callback will run. */
+    close() : HttpResponse;
+
+    /** Returns the global byte write offset for this response. Use with onWritable. */
+    getWriteOffset() : number;
+
+    /** Registers a handler for writable events. Continue failed write attempts in here.
+     * You MUST return true for success, false for failure.
+     * Writing nothing is always success, so by default you must return true.
+     */
+    onWritable(handler: (offset: number) => boolean) : HttpResponse;
+
+    /** Every HttpResponse MUST have an attached abort handler IF you do not respond
+     * to it immediately inside of the callback. Returning from an Http request handler
+     * without attaching (by calling onAborted) an abort handler is ill-use and will termiante.
+     * When this event emits, the response has been aborted and may not be used. */
+    onAborted(handler: () => void) : HttpResponse;
+
+    /** Handler for reading data from POST and such requests. You MUST copy the data of chunk if isLast is not true. We Neuter ArrayBuffers on return, making it zero length.*/
+    onData(handler: (chunk: ArrayBuffer, isLast: boolean) => void) : HttpResponse;
+
+    /** Returns the remote IP address in binary format (4 or 16 bytes). */
+    getRemoteAddress() : ArrayBuffer;
+
+    /** Returns the remote IP address as text. */
+    getRemoteAddressAsText() : ArrayBuffer;
+
+    /** Returns the remote IP address in binary format (4 or 16 bytes), as reported by the PROXY Protocol v2 compatible proxy. */
+    getProxiedRemoteAddress() : ArrayBuffer;
+
+    /** Returns the remote IP address as text, as reported by the PROXY Protocol v2 compatible proxy. */
+    getProxiedRemoteAddressAsText() : ArrayBuffer;
+
+    /** Corking a response is a performance improvement in both CPU and network, as you ready the IO system for writing multiple chunks at once.
+     * By default, you're corked in the immediately executing top portion of the route handler. In all other cases, such as when returning from
+     * await, or when being called back from an async database request or anything that isn't directly executing in the route handler, you'll want
+     * to cork before calling writeStatus, writeHeader or just write. Corking takes a callback in which you execute the writeHeader, writeStatus and
+     * such calls, in one atomic IO operation. This is important, not only for TCP but definitely for TLS where each write would otherwise result
+     * in one TLS block being sent off, each with one send syscall.
+     *
+     * Example usage:
+     *
+     * res.cork(() => {
+     *   res.writeStatus("200 OK").writeHeader("Some", "Value").write("Hello world!");
+     * });
+     */
+    cork(cb: () => void) : void;
+
+    /** Upgrades a HttpResponse to a WebSocket. See UpgradeAsync, UpgradeSync example files. */
+    upgrade<T>(userData : T, secWebSocketKey: RecognizedString, secWebSocketProtocol: RecognizedString, secWebSocketExtensions: RecognizedString, context: us_socket_context_t) : void;
+
+    /** Arbitrary user data may be attached to this object */
+    [key: string]: any;
+}
+
+/** An HttpRequest is stack allocated and only accessible during the callback invocation. */
+export interface HttpRequest {
+    /** Returns the lowercased header value or empty string. */
+    getHeader(lowerCaseKey: RecognizedString) : string;
+    /** Returns the parsed parameter at index. Corresponds to route. */
+    getParameter(index: number) : string;
+    /** Returns the URL including initial /slash */
+    getUrl() : string;
+    /** Returns the HTTP method, useful for "any" routes. */
+    getMethod() : string;
+    /** Returns the raw querystring (the part of URL after ? sign) or empty string. */
+    getQuery() : string;
+    /** Returns a decoded query parameter value or empty string. */
+    getQuery(key: string) : string;
+    /** Loops over all headers. */
+    forEach(cb: (key: string, value: string) => void) : void;
+    /** Setting yield to true is to say that this route handler did not handle the route, causing the router to continue looking for a matching route handler, or fail. */
+    setYield(yield: boolean) : HttpRequest;
+}
+
+/** A structure holding settings and handlers for a WebSocket URL route handler. */
+export interface WebSocketBehavior {
+    /** Maximum length of received message. If a client tries to send you a message larger than this, the connection is immediately closed. Defaults to 16 * 1024. */
+    maxPayloadLength?: number;
+    /** Maximum amount of seconds that may pass without sending or getting a message. Connection is closed if this timeout passes. Resolution (granularity) for timeouts are typically 4 seconds, rounded to closest.
+     * Disable by using 0. Defaults to 120.
+     */
+    idleTimeout?: number;
+    /** What permessage-deflate compression to use. uWS.DISABLED, uWS.SHARED_COMPRESSOR or any of the uWS.DEDICATED_COMPRESSOR_xxxKB. Defaults to uWS.DISABLED. */
+    compression?: CompressOptions;
+    /** Maximum length of allowed backpressure per socket when publishing or sending messages. Slow receivers with too high backpressure will be skipped until they catch up or timeout. Defaults to 1024 * 1024. */
+    maxBackpressure?: number;
+    /** Upgrade handler used to intercept HTTP upgrade requests and potentially upgrade to WebSocket.
+     * See UpgradeAsync and UpgradeSync example files.
+     */
+    upgrade?: (res: HttpResponse, req: HttpRequest, context: us_socket_context_t) => void;
+    /** Handler for new WebSocket connection. WebSocket is valid from open to close, no errors. */
+    open?: (ws: WebSocket) => void;
+    /** Handler for a WebSocket message. Messages are given as ArrayBuffer no matter if they are binary or not. Given ArrayBuffer is valid during the lifetime of this callback (until first await or return) and will be neutered. */
+    message?: (ws: WebSocket, message: ArrayBuffer, isBinary: boolean) => void;
+    /** Handler for when WebSocket backpressure drains. Check ws.getBufferedAmount(). Use this to guide / drive your backpressure throttling. */
+    drain?: (ws: WebSocket) => void;
+    /** Handler for close event, no matter if error, timeout or graceful close. You may not use WebSocket after this event. Do not send on this WebSocket from within here, it is closed. */
+    close?: (ws: WebSocket, code: number, message: ArrayBuffer) => void;
+    /** Handler for received ping control message. You do not need to handle this, pong messages are automatically sent as per the standard. */
+    ping?: (ws: WebSocket, message: ArrayBuffer) => void;
+    /** Handler for received pong control message. */
+    pong?: (ws: WebSocket, message: ArrayBuffer) => void;
+}
+
+/** Options used when constructing an app. Especially for SSLApp.
+ * These are options passed directly to uSockets, C layer.
+ */
+export interface AppOptions {
+    key_file_name?: RecognizedString;
+    cert_file_name?: RecognizedString;
+    passphrase?: RecognizedString;
+    dh_params_file_name?: RecognizedString;
+    /** This translates to SSL_MODE_RELEASE_BUFFERS */
+    ssl_prefer_low_memory_usage?: boolean;
+}
+
+export enum ListenOptions {
+  LIBUS_LISTEN_DEFAULT = 0,
+  LIBUS_LISTEN_EXCLUSIVE_PORT = 1
+}
+
+/** TemplatedApp is either an SSL or non-SSL app. See App for more info, read user manual. */
+export interface TemplatedApp {
+    /** Listens to hostname & port. Callback hands either false or a listen socket. */
+    listen(host: RecognizedString, port: number, cb: (listenSocket: us_listen_socket) => void): TemplatedApp;
+    /** Listens to port. Callback hands either false or a listen socket. */
+    listen(port: number, cb: (listenSocket: any) => void): TemplatedApp;
+    /** Listens to port and sets Listen Options. Callback hands either false or a listen socket. */
+    listen(port: number, options: ListenOptions, cb: (listenSocket: us_listen_socket | false) => void): TemplatedApp;
+    /** Registers an HTTP GET handler matching specified URL pattern. */
+    get(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP POST handler matching specified URL pattern. */
+    post(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP OPTIONS handler matching specified URL pattern. */
+    options(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP DELETE handler matching specified URL pattern. */
+    del(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP PATCH handler matching specified URL pattern. */
+    patch(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP PUT handler matching specified URL pattern. */
+    put(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP HEAD handler matching specified URL pattern. */
+    head(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP CONNECT handler matching specified URL pattern. */
+    connect(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP TRACE handler matching specified URL pattern. */
+    trace(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers an HTTP handler matching specified URL pattern on any HTTP method. */
+    any(pattern: RecognizedString, handler: (res: HttpResponse, req: HttpRequest) => void) : TemplatedApp;
+    /** Registers a handler matching specified URL pattern where WebSocket upgrade requests are caught. */
+    ws(pattern: RecognizedString, behavior: WebSocketBehavior) : TemplatedApp;
+    /** Publishes a message under topic, for all WebSockets under this app. See WebSocket.publish. */
+    publish(topic: RecognizedString, message: RecognizedString, isBinary?: boolean, compress?: boolean) : boolean;
+    /** Returns number of subscribers for this topic. */
+    numSubscribers(topic: RecognizedString) : number;
+    /** Adds a server name. */
+    addServerName(hostname: string, options: AppOptions): TemplatedApp;
+    /** Removes a server name. */
+    removeServerName(hostname: string): TemplatedApp;
+    /** Registers a synchronous callback on missing server names. See /examples/ServerName.js. */
+    missingServerName(cb: (hostname: string) => void): TemplatedApp;
+}
+
+/** Constructs a non-SSL app. An app is your starting point where you attach behavior to URL routes.
+ * This is also where you listen and run your app, set any SSL options (in case of SSLApp) and the like.
+ */
+export function App(options?: AppOptions): TemplatedApp;
+
+/** Constructs an SSL app. See App. */
+export function SSLApp(options: AppOptions): TemplatedApp;
+
+/** Closes a uSockets listen socket. */
+export function us_listen_socket_close(listenSocket: us_listen_socket): void;
+
+/** Gets local port of socket (or listenSocket) or -1. */
+export function us_socket_local_port(socket: us_socket): number;
+
+export interface MultipartField {
+    data: ArrayBuffer;
+    name: string;
+    type?: string;
+    filename?: string;
+}
+
+/** Takes a POSTed body and contentType, and returns an array of parts if the request is a multipart request */
+export function getParts(body: RecognizedString, contentType: RecognizedString): MultipartField[] | undefined;
+
+/** WebSocket compression options */
+export type CompressOptions = number;
+/** No compression (always a good idea if you operate using an efficient binary protocol) */
+export var DISABLED: CompressOptions;
+/** Zero memory overhead compression (recommended for pub/sub where same message is sent to many receivers) */
+export var SHARED_COMPRESSOR: CompressOptions;
+/** Sliding dedicated compress window, requires 3KB of memory per socket */
+export var DEDICATED_COMPRESSOR_3KB: CompressOptions;
+/** Sliding dedicated compress window, requires 4KB of memory per socket */
+export var DEDICATED_COMPRESSOR_4KB: CompressOptions;
+/** Sliding dedicated compress window, requires 8KB of memory per socket */
+export var DEDICATED_COMPRESSOR_8KB: CompressOptions;
+/** Sliding dedicated compress window, requires 16KB of memory per socket */
+export var DEDICATED_COMPRESSOR_16KB: CompressOptions;
+/** Sliding dedicated compress window, requires 32KB of memory per socket */
+export var DEDICATED_COMPRESSOR_32KB: CompressOptions;
+/** Sliding dedicated compress window, requires 64KB of memory per socket */
+export var DEDICATED_COMPRESSOR_64KB: CompressOptions;
+/** Sliding dedicated compress window, requires 128KB of memory per socket */
+export var DEDICATED_COMPRESSOR_128KB: CompressOptions;
+/** Sliding dedicated compress window, requires 256KB of memory per socket */
+export var DEDICATED_COMPRESSOR_256KB: CompressOptions;

package/package.json

@@ -1,16 +1,9 @@
 {
   "name": "uwebsockets",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "µWebSockets.js is a web server bypass for Node.js that reimplements eventing, networking, encryption, web protocols, routing and pub/sub in highly optimized C++. As such, µWebSockets.js delivers web serving for Node.js, 8.5x that of Fastify and at least 10x that of Socket.IO. It is also the built-in web server of Bun.",
-  "main": "index.js",
-  "directories": {
-    "doc": "docs",
-    "example": "examples",
-    "test": "tests"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "main": "uws.js",
+  "types": "./index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NPM-Package-Jaykumar/uWebSockets.git"

package/source_commit

@@ -0,0 +1 @@
+c70d2e6d2d923183885e991c6cb4189419b521a5

package/uws.js

@@ -0,0 +1,24 @@
+/*
+ * Authored by Alex Hultman, 2018-2021.
+ * Intellectual property of third-party.
+
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+
+ *     http://www.apache.org/licenses/LICENSE-2.0
+
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+module.exports = (() => {
+	try {
+		return require('./uws_' + process.platform + '_' + process.arch + '_' + process.versions.modules + '.node');
+	} catch (e) {
+		throw new Error('This version of µWS is not compatible with your Node.js build:\n\n' + e.toString());
+	}
+})();

package/.gitattributes

@@ -1,3 +0,0 @@
-*.js linguist-vendored
-*.pro linguist-vendored
-src/* linguist-vendored=false

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "uWebSockets"]
-	path = uWebSockets
-	url = https://github.com/uNetworking/uWebSockets