sonic-ws 1.3.3 → 2.0.0

package/LICENSE

@@ -1,196 +1,56 @@
-Copyright 2026 Lily (liwybloc)
-
-Licensed under the Apache License, Version 2.0 (the "License");
-You may not use this software 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.
-
-                                 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
-
-   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.
+Copyright (c) 2026 Lily (liwybloc)
+
+Personal Non-Commercial License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to use,
+copy, and modify the Software solely for personal, non-commercial purposes,
+subject to the following conditions:
+
+1. Permitted Use
+
+The Software may be used, copied, and modified for personal, non-commercial
+purposes only.
+
+2. Restrictions
+
+You may not, without prior written permission from the copyright holder:
+
+- Use the Software, in whole or in part, for any commercial purpose
+- Sell, sublicense, rent, lease, publish, host, or otherwise distribute the
+  Software or copies of the Software
+- Provide the Software as part of a paid service, paid product, commercial
+  product, or commercial offering
+- Distribute modified versions of the Software
+- Remove or alter any copyright, license, or attribution notices
+
+3. Contributions
+
+You may create modifications and submit them to the original project
+(for example, via pull requests). By submitting a contribution, you grant
+the copyright holder a non-exclusive, worldwide, royalty-free, perpetual,
+irrevocable license to use, copy, modify, merge, publish, distribute,
+sublicense, and otherwise incorporate your contribution into the Software.
+
+4. Commercial Licensing
+
+A separate commercial license is required for any commercial use of the
+Software. To obtain a commercial license, contact: yinuwu12@gmail.com
+
+5. Ownership
+
+The Software is licensed, not sold. All rights not expressly granted are
+reserved by the copyright holder.
+
+6. Disclaimer of Warranty
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
+
+7. Limitation of Liability
+
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR
+OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,26 +1,31 @@
 # sonic-ws
 
-### WebSockets that handle correctness, security, and performance for you
-
-- No race conditions
-- No invalid packets
-- No accidental DoS
-- No cleanup bugs
-- No boilerplate
-- Many built-in security features
-- Lower bandwidth cost
-- Works much better on mobile
-- More readable than every other socket library
+### The socket library that handle correctness, security, and performance for you
+
+SonicWS is a schema-driven WebSocket library for multiple languages. It uses a shared Rust packet codec, to provide compact binary packets, validation before listener execution, batching, compression, built-in rate limiting, and more.
+
+It is designed for real-time applications such as games, dashboards, collaborative tools, and distributed systems where packet correctness, bandwidth efficiency, and predictable socket lifecycle behavior matter.
+
+## Why SonicWS?
+
+- Define exactly which packets each side may send.
+- Reject invalid packets before user callbacks run.
+- Use compact numeric packet IDs instead of repeated string keys.
+- Share the same packet codec across Node and browser clients.
+- Batch, validate, compress, and rate-limit packets with minimal boilerplate.
+- Code is much more readable than every other socket library*
 
 <details>
 <summary>DETAILED INFO</summary>
 
 SonicWS is an ultra-lightweight, high-performance WebSocket library focused on maximum bandwidth efficiency, speed, and security.
 
+The packet codec is written in Rust and shared by every runtime. Node can use the native N-API addon (with a WASM fallback), while browsers use the same core compiled to WebAssembly. This keeps packet encoding, decoding, validation, batching, and compression consistent between the server and client.
+
 Compression:
 - Lossless compression up to 70% or more (for example, 38kb -> 14kb)
 - Optimized bandwidth for many different types to fit special constraints
-- Automatic helpers to flatten typed nested arrays for maximum wire efficiency (for example, [[1,false,"text"],[4,true,"other"]] to [[1,4],[false,true],["text,"other"]])
+- Automatic helpers to flatten typed nested arrays for maximum wire efficiency (for example, [[1,false,"text"],[4,true,"other"]] to [[1,4],[false,true],["text","other"]])
 - Uses raw binary bytes to transmit data as efficiently as possible while still using high level readable code
 - Built-in ability to use compression libraries
 
@@ -28,7 +33,7 @@ Developer Friendly:
 - Predefined data types of various sized integers, single and double precision floating point numbers, strings, enums, etc. and RAW to allow for developers to do anything they want
 - Keys are automatically indexed before transfer, improving readability and efficiency (for example, send("pixel") and send("p") use the same bandwidth)
 - Data is validated and supports custom validation, ensuring only valid, safe, and untampered packets ever call your listeners
-- Edge cases are heavily tested with heavy data ranges; supports code points fully up to the max of 0x10FFFF
+- Edge cases are heavily tested across large data ranges; strings support code points up to the max of 0x10FFFF
 - Debug tools to view all packets
 
 Security:
@@ -53,12 +58,34 @@ Developer Experience:
 - Many data types to maximize speed, clarity, bandwidth, and security
 - Debug tools for socket ids, byte size, data logging, etc. for troubleshooting
 - Very minimal learning curve, easy to work in
-- JSDoc's for understanding; immensely intuitive (personally, I took a break for half a year and came back and snapped right back in)
+- JSDoc for understanding; immensely intuitive (personally, I took a break for half a year and came back and snapped right back in)
 - Almost every case has a pre-made wire optimization and boilerplate removal.
 
 Whether you're making a real-time game, a dashboard, a distributed system, or anything else, SonicWS gets you safe, structured packets; fast.
+
+\* = More readable than code I've seen written for socket.io and other libraries
 </details>
 
+## HOW IT WORKS
+
+You define the packets each side is allowed to send. SonicWS exchanges that schema during the connection handshake, assigns compact numeric packet IDs, and validates incoming data before calling your listeners.
+
+The TypeScript layer handles connections, packet definitions, middleware, and the public API. The Rust core handles the wire format:
+
+- Primitive and object packet encoding/decoding
+- Packet validation and range checks
+- Enum, string, boolean, varint, delta, float, and hex codecs
+- Object framing, batching, and raw DEFLATE compression
+- TypeScript-side JSON conversion transported through reserved wire type 16 as raw bytes
+
+The same Rust implementation is exposed through N-API for native Node use and through WASM for browsers and the portable Node fallback. Protocol behavior therefore does not depend on which runtime is connected.
+
+## INSTALLATION
+
+```sh
+npm install sonic-ws
+```
+
 ## SAMPLES
 
 ### Node (Client & Server)
@@ -68,9 +95,23 @@ import { SonicWS, SonicWSServer, CreatePacket, PacketType } from "sonic-ws";
 
 Browser (Client):
 ```html
-<script src="https://cdn.jsdelivr.net/gh/liwybloc/sonic-ws/release/SonicWS_bundle"></script>
+<script src="/SonicWS/bundle.js"></script>
+<script>
+    async function connect() {
+        await SonicWS.initialize();
+        const ws = new SonicWS(`ws://${location.host}`);
+        // Register listeners and send packets here.
+    }
+
+    connect();
+</script>
 ```
-*This will always give the latest release build. I will add branches for each release if this project actually goes anywhere.
+
+`SonicWSServer` serves this browser bundle and its WASM module automatically at
+`/SonicWS/bundle.js` and `/SonicWS/bundle.wasm`. Set
+`sonicServerSettings.serveBrowserClient` to `false` to disable these routes.
+
+The WASM core must finish initializing before constructing a browser client. Node initializes its codec automatically.
 
 ### Simple Example: Clicker Server
 
@@ -97,7 +138,7 @@ wss.on_connect(ws => {
 
     ws.on("token", token => {
         if(!isValidToken(token)) // No listeners will ever trigger after this, unlike base websocket
-            return socket.close();
+            return ws.close();
     })
 
     // auto validation, no boilerplate. always passed the token check
@@ -113,6 +154,7 @@ wss.on_ready(() => console.log("Server ready!"));
 
 #### Client
 ```js
+await SonicWS.initialize();
 const ws = new SonicWS("ws://localhost:1234");
 
 ws.on_ready(() => console.log("Connected to server"));
@@ -127,6 +169,35 @@ button.addEventListener("click", () => {
 
 ```
 
+## BUILDING AND TESTING
+
+Building requires Node.js, Rust with the `wasm32-unknown-unknown` target, and `wasm-pack`.
+
+```sh
+npm run build       # TypeScript, Node WASM, browser WASM, and browser bundle
+npm run build_node  # Node distribution and WASM fallback
+npm run build_web   # Browser bundle and WASM
+npm run test_node   # Node end-to-end packet tests
+npm run test_web    # Headless browser/WASM end-to-end tests
+```
+
+The Rust crate lives in `src/core`, and the TypeScript API lives in `src/ts`. Generated JavaScript is written to `dist/ts`; browser artifacts are written to `bundled/bundle.js` and `bundled/bundle.wasm`.
+
 ## KNOWN ISSUES
 
+- `KEY_EFFECTIVE` is reserved but still a work in progress.
+- Native `.node` addons are platform-specific. WASM is used as the portable fallback, while prebuilt native binaries will need separate builds for each supported operating system and architecture.
+
 ## PLANNED FEATURES
+- Better encoding for the first packet that sends packet information
+- Publish the Rust core as a standalone, documented crate
+- Add first-class Python and Go bindings
+- Provide prebuilt N-API binaries for the main Node platforms
+
+## LICENSE
+This project is source-available.
+
+You are free to use, modify, and contribute for personal,
+non-commercial purposes.
+
+Commercial use requires a separate license. Please contact me regarding information on this.

package/dist/{index.d.ts → ts/index.d.ts}

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
 export { SonicWS } from './ws/client/node/ClientNode';
 export { SonicWSConnection } from './ws/server/SonicWSConnection';
 export { SonicWSServer } from './ws/server/SonicWSServer';
@@ -5,3 +10,4 @@ export { PacketType } from './ws/packets/PacketType';
 export { BasicMiddleware, ConnectionMiddleware, ServerMiddleware, BCInfo } from './ws/PacketProcessor';
 export { CreatePacket, CreateObjPacket, CreateEnumPacket, FlattenData, UnFlattenData } from './ws/util/packets/PacketUtils';
 export { DefineEnum, WrapEnum } from './ws/util/enums/EnumHandler';
+export { initializeWasmCore } from './native/wrapper';

package/dist/{index.js → ts/index.js}

@@ -1,21 +1,18 @@
 "use strict";
 /*
- * Copyright 2026 Lily (liwybloc)
+ * Copyright (c) 2026 Lily (liwybloc)
  *
- * 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
+ * Licensed for personal, non-commercial use only.
+ * Commercial use, redistribution, sublicensing, sale, rental, lease,
+ * or inclusion in a paid product or service is prohibited without prior
+ * written permission from the copyright holder.
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * See the LICENSE file in the project root for the full license terms.
  *
- * 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.
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WrapEnum = exports.DefineEnum = exports.UnFlattenData = exports.FlattenData = exports.CreateEnumPacket = exports.CreateObjPacket = exports.CreatePacket = exports.PacketType = exports.SonicWSServer = exports.SonicWSConnection = exports.SonicWS = void 0;
+exports.initializeWasmCore = exports.WrapEnum = exports.DefineEnum = exports.UnFlattenData = exports.FlattenData = exports.CreateEnumPacket = exports.CreateObjPacket = exports.CreatePacket = exports.PacketType = exports.SonicWSServer = exports.SonicWSConnection = exports.SonicWS = void 0;
 var ClientNode_1 = require("./ws/client/node/ClientNode");
 Object.defineProperty(exports, "SonicWS", { enumerable: true, get: function () { return ClientNode_1.SonicWS; } });
 var SonicWSConnection_1 = require("./ws/server/SonicWSConnection");
@@ -33,3 +30,5 @@ Object.defineProperty(exports, "UnFlattenData", { enumerable: true, get: functio
 var EnumHandler_1 = require("./ws/util/enums/EnumHandler");
 Object.defineProperty(exports, "DefineEnum", { enumerable: true, get: function () { return EnumHandler_1.DefineEnum; } });
 Object.defineProperty(exports, "WrapEnum", { enumerable: true, get: function () { return EnumHandler_1.WrapEnum; } });
+var wrapper_1 = require("./native/wrapper");
+Object.defineProperty(exports, "initializeWasmCore", { enumerable: true, get: function () { return wrapper_1.initializeWasmCore; } });

package/dist/ts/native/wrapper.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
+import { PacketType } from "../ws/packets/PacketType";
+import { EnumPackage } from "../ws/util/enums/EnumType";
+export interface SonicNativeCore {
+    encodeSigned(kind: number, values: number[]): Uint8Array;
+    decodeSigned(kind: number, data: Uint8Array): number[];
+    encodeUnsigned(kind: number, values: number[]): Uint8Array;
+    decodeUnsigned(kind: number, data: Uint8Array): number[];
+    encodeFloats(kind: number, values: number[]): Uint8Array;
+    decodeFloats(kind: number, data: Uint8Array): number[];
+    encodeStrings(kind: number, values: string[]): Uint8Array;
+    decodeStrings(kind: number, data: Uint8Array): string[];
+    encodeBooleans(values: boolean[]): Uint8Array;
+    decodeBooleans(data: Uint8Array, count: number): boolean[];
+    encodeRaw(data: Uint8Array): Uint8Array;
+    decodeRaw(data: Uint8Array): Uint8Array;
+    encodeHex(value: string): Uint8Array;
+    decodeHex(data: Uint8Array): string;
+    frameObject(sectors: Uint8Array[]): Uint8Array;
+    unframeObject(data: Uint8Array, fieldCount: number): Uint8Array[];
+    encodeBatch(payloads: Uint8Array[], compress: boolean): Uint8Array;
+    decodeBatch(data: Uint8Array, compressed: boolean, maxBatchSize: number, maxOutputSize?: number): Uint8Array[];
+    deflateRaw(data: Uint8Array): Uint8Array;
+    inflateRaw(data: Uint8Array, maxOutputSize?: number): Uint8Array;
+    validateEncoded(kind: number, data: Uint8Array, min: number, max: number, compressed: boolean, batched: boolean, maxBatchSize?: number): void;
+    validateEnum(data: Uint8Array, enumSize: number, min: number, max: number): void;
+    validateObject(data: Uint8Array, kinds: number[], minimums: number[], maximums: number[], enumSizes: number[]): void;
+}
+export interface NativeObjectSchema {
+    types: readonly PacketType[];
+    dataMins: readonly number[];
+    dataMaxes: readonly number[];
+    enumData?: readonly EnumPackage[];
+}
+/** Injects a native implementation, primarily for tests or custom addon loaders. */
+export declare function setNativeCore(core: SonicNativeCore): void;
+/** Loads and selects the webpack-compatible browser WASM implementation. */
+export declare function initializeWasmCore(): Promise<SonicNativeCore>;
+/** Loads the platform-specific Node addon lazily. */
+export declare function loadNativeCore(addonPath?: string): SonicNativeCore;
+export declare function encodeNative(type: PacketType, input: unknown, enumData?: EnumPackage, core?: SonicNativeCore): Uint8Array;
+export declare function decodeNative(type: PacketType, data: Uint8Array, dataMax?: number, enumData?: EnumPackage, core?: SonicNativeCore): unknown;
+export declare function validateNative(type: PacketType, data: Uint8Array, dataMin: number, dataMax: number, options?: {
+    compressed?: boolean;
+    batched?: boolean;
+    maxBatchSize?: number;
+    enumData?: EnumPackage;
+}, core?: SonicNativeCore): void;
+export declare function encodeNativeObject(schema: NativeObjectSchema, fields: readonly unknown[], core?: SonicNativeCore): Uint8Array;
+export declare function decodeNativeObject(schema: NativeObjectSchema, data: Uint8Array, core?: SonicNativeCore): unknown[];
+export declare function validateNativeObject(schema: NativeObjectSchema, data: Uint8Array, core?: SonicNativeCore): void;
+export declare function encodeNativeBatch(payloads: readonly Uint8Array[], compressed: boolean, core?: SonicNativeCore): Uint8Array;
+export declare function decodeNativeBatch(data: Uint8Array, compressed: boolean, maxBatchSize?: number, maxOutputSize?: number, core?: SonicNativeCore): Uint8Array[];
+export declare function deflateNative(data: Uint8Array, core?: SonicNativeCore): Uint8Array;
+export declare function inflateNative(data: Uint8Array, maxOutputSize?: number, core?: SonicNativeCore): Uint8Array;

package/dist/ts/native/wrapper.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
+
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.setNativeCore=setNativeCore,exports.initializeWasmCore=initializeWasmCore,exports.loadNativeCore=loadNativeCore,exports.encodeNative=encodeNative,exports.decodeNative=decodeNative,exports.validateNative=validateNative,exports.encodeNativeObject=encodeNativeObject,exports.decodeNativeObject=decodeNativeObject,exports.validateNativeObject=validateNativeObject,exports.encodeNativeBatch=encodeNativeBatch,exports.decodeNativeBatch=decodeNativeBatch,exports.deflateNative=deflateNative,exports.inflateNative=inflateNative;const PacketType_1=require("../ws/packets/PacketType");let loadedCore;function buffer(e){return"undefined"!=typeof Buffer?Buffer.from(e.buffer,e.byteOffset,e.byteLength):new Uint8Array(e.buffer,e.byteOffset,e.byteLength)}function values(e){return Array.isArray(e)?[...e]:[e]}function assertNativeCore(e){const t=["encodeSigned","decodeSigned","encodeUnsigned","decodeUnsigned","encodeFloats","decodeFloats","encodeStrings","decodeStrings","encodeBooleans","decodeBooleans","encodeRaw","decodeRaw","encodeHex","decodeHex","frameObject","unframeObject","encodeBatch","decodeBatch","deflateRaw","inflateRaw","validateEncoded","validateEnum","validateObject"].filter(t=>"function"!=typeof e[t]);if(t.length>0)throw new Error(`Invalid SonicWS native addon; missing: ${t.join(", ")}`)}function setNativeCore(e){assertNativeCore(e),loadedCore=e}async function initializeWasmCore(){const wasm="undefined"==typeof window?eval("require")("./wasm/node/sonic_ws_core.js"):await import("./wasm/pkg/sonic_ws_core.js");return setNativeCore(wasm),loadedCore}function loadNativeCore(addonPath){if(loadedCore&&!addonPath)return loadedCore;const candidates=addonPath?[addonPath]:["undefined"!=typeof process?process.env.SONIC_WS_CORE_PATH:void 0,"undefined"!=typeof __dirname?`${__dirname}/sonic_ws_core.node`:void 0,"undefined"!=typeof __dirname?`${__dirname}/../../../native/sonic_ws_core.node`:void 0].filter(e=>Boolean(e)),failures=[],nodeRequire="undefined"==typeof window?eval("require"):void 0;for(const e of candidates)try{const t=nodeRequire(e);return assertNativeCore(t),addonPath||(loadedCore=t),t}catch(t){failures.push(`${e}: ${t instanceof Error?t.message:String(t)}`)}if("undefined"==typeof window)try{const e=nodeRequire("./wasm/node/sonic_ws_core.js");return assertNativeCore(e),loadedCore=e,e}catch(e){failures.push(`Node WASM fallback: ${e instanceof Error?e.message:String(e)}`)}throw new Error(`SonicWS codec is not initialized. In Node, set SONIC_WS_CORE_PATH; in browsers, await initializeWasmCore().\n${failures.join("\n")}`)}function enumIndex(e,t){const a=e.values.findIndex(e=>e===t||"number"==typeof e&&"number"==typeof t&&Number.isNaN(e)&&Number.isNaN(t));if(a<0)throw new Error(`Value ${String(t)} does not exist in enum ${e.tag}`);return a}function encodeNative(e,t,a,r=loadNativeCore()){switch(e){case PacketType_1.PacketType.NONE:if(null!=t&&(!Array.isArray(t)||0!==t.length))throw new TypeError("NONE only accepts null, undefined, or an empty array");return new Uint8Array(0);case PacketType_1.PacketType.RAW:case PacketType_1.PacketType.JSON:if(!(t instanceof Uint8Array||Array.isArray(t)))throw new TypeError((e===PacketType_1.PacketType.JSON?"JSON wire data":"RAW")+" requires a Uint8Array or number array");return r.encodeRaw(t instanceof Uint8Array?buffer(t):Uint8Array.from(t));case PacketType_1.PacketType.BYTES:case PacketType_1.PacketType.SHORTS:case PacketType_1.PacketType.VARINT:case PacketType_1.PacketType.DELTAS:return r.encodeSigned(e,values(t));case PacketType_1.PacketType.UBYTES:case PacketType_1.PacketType.USHORTS:case PacketType_1.PacketType.UVARINT:return r.encodeUnsigned(e,values(t));case PacketType_1.PacketType.FLOATS:case PacketType_1.PacketType.DOUBLES:return r.encodeFloats(e,values(t));case PacketType_1.PacketType.STRINGS_ASCII:case PacketType_1.PacketType.STRINGS_UTF16:return r.encodeStrings(e,values(t));case PacketType_1.PacketType.BOOLEANS:return r.encodeBooleans(values(t));case PacketType_1.PacketType.HEX:{const e=Array.isArray(t)?t[0]:t;if("string"!=typeof e)throw new TypeError("HEX requires one string");return r.encodeHex(e)}case PacketType_1.PacketType.ENUMS:if(!a)throw new Error("ENUMS requires an EnumPackage");return Uint8Array.from(values(t).map(e=>enumIndex(a,e)));case PacketType_1.PacketType.KEY_EFFECTIVE:throw new Error("KEY_EFFECTIVE is not implemented");default:throw new Error(`Unknown packet type: ${e}`)}}function decodeNative(e,t,a=4294967295,r,n=loadNativeCore()){const o=buffer(t);switch(e){case PacketType_1.PacketType.NONE:if(0!==t.byteLength)throw new Error("NONE packet contains data");return;case PacketType_1.PacketType.RAW:case PacketType_1.PacketType.JSON:return n.decodeRaw(o);case PacketType_1.PacketType.BYTES:case PacketType_1.PacketType.SHORTS:case PacketType_1.PacketType.VARINT:case PacketType_1.PacketType.DELTAS:return n.decodeSigned(e,o);case PacketType_1.PacketType.UBYTES:case PacketType_1.PacketType.USHORTS:case PacketType_1.PacketType.UVARINT:return n.decodeUnsigned(e,o);case PacketType_1.PacketType.FLOATS:case PacketType_1.PacketType.DOUBLES:return n.decodeFloats(e,o);case PacketType_1.PacketType.STRINGS_ASCII:case PacketType_1.PacketType.STRINGS_UTF16:return n.decodeStrings(e,o);case PacketType_1.PacketType.BOOLEANS:return n.decodeBooleans(o,a);case PacketType_1.PacketType.HEX:return n.decodeHex(o);case PacketType_1.PacketType.ENUMS:if(!r)throw new Error("ENUMS requires an EnumPackage");return[...t].map(e=>{if(e>=r.values.length)throw new Error(`Enum index ${e} is out of range`);return r.values[e]});case PacketType_1.PacketType.KEY_EFFECTIVE:throw new Error("KEY_EFFECTIVE is not implemented");default:throw new Error(`Unknown packet type: ${e}`)}}function validateNative(e,t,a,r,n={},o=loadNativeCore()){if(e!==PacketType_1.PacketType.ENUMS)o.validateEncoded(e,buffer(t),a,r,n.compressed??!1,n.batched??!1,n.maxBatchSize);else{if(!n.enumData)throw new Error("ENUMS requires an EnumPackage");o.validateEnum(buffer(t),n.enumData.values.length,a,r)}}function encodeNativeObject(e,t,a=loadNativeCore()){if(t.length!==e.types.length)throw new Error("Object field count does not match schema");let r=0;const n=e.types.map((n,o)=>encodeNative(n,t[o],n===PacketType_1.PacketType.ENUMS?e.enumData?.[r++]:void 0,a));return a.frameObject(n)}function decodeNativeObject(e,t,a=loadNativeCore()){const r=a.unframeObject(buffer(t),e.types.length);let n=0;return r.map((t,r)=>decodeNative(e.types[r],t,e.dataMaxes[r],e.types[r]===PacketType_1.PacketType.ENUMS?e.enumData?.[n++]:void 0,a))}function validateNativeObject(e,t,a=loadNativeCore()){a.validateObject(buffer(t),[...e.types],[...e.dataMins],[...e.dataMaxes],(e.enumData??[]).map(e=>e.values.length))}function encodeNativeBatch(e,t,a=loadNativeCore()){return a.encodeBatch(e.map(buffer),t)}function decodeNativeBatch(e,t,a=0,r,n=loadNativeCore()){const o=Number.isFinite(a)&&a>0?a:0;return n.decodeBatch(buffer(e),t,o,r)}function deflateNative(e,t=loadNativeCore()){return t.deflateRaw(buffer(e))}function inflateNative(e,t,a=loadNativeCore()){return a.inflateRaw(buffer(e),t)}

package/dist/{version.d.ts → ts/version.d.ts}

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
 /** Current protocol version */
 export declare const VERSION = 22;
 /** Server data suffix */

package/dist/ts/version.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
+
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.SERVER_SUFFIX_NUMS=exports.SERVER_SUFFIX=exports.VERSION=void 0;const e=require("./ws/util/StringUtil");exports.VERSION=22,exports.SERVER_SUFFIX="SWS",exports.SERVER_SUFFIX_NUMS=(0,e.processCharCodes)(exports.SERVER_SUFFIX);

package/dist/{ws → ts/ws}/Connection.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
 import { ConnectionMiddleware, IMiddlewareHolder, MiddlewareHolder } from "./PacketProcessor";
 import { BatchHelper } from "./util/packets/BatchHelper";
 /**

package/dist/ts/ws/Connection.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
+
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.CloseCodes=exports.Connection=void 0,exports.getClosureCause=function(e){if(e>=4e3)return r[e]??"UNKNOWN";switch(e){case 1e3:return"NORMAL_CLOSURE";case 1001:return"GOING_AWAY";case 1002:return"PROTOCOL_ERROR";case 1003:return"UNSUPPORTED_DATA";case 1006:return"ABNORMAL_CLOSURE";default:return"UNKNOWN"}};const e=require("./PacketProcessor"),t=require("./util/packets/BatchHelper");class s extends e.MiddlewareHolder{listeners;name;closed=!1;socket;_timers={};batcher;_on;_off;id;constructor(e,s,r,o,i){super(),this.id=s,this.listeners={},this.name=r,this.socket=e,this.batcher=new t.BatchHelper,this._on=o,this._off=i,this._on("close",()=>{this.callMiddleware("onStatusChange",WebSocket.CLOSED),this.closed=!0;for(const[e,t,s]of Object.values(this._timers))this.clearTimeout(e),s&&t(!0)}),this._on("open",()=>this.callMiddleware("onStatusChange",WebSocket.OPEN))}setTimeout(e,t,s=!1){const r=setTimeout(()=>{e(),this.clearTimeout(r)},t);return this._timers[r]=[r,e,s],r}setInterval(e,t,s=!1){const r=setInterval(e,t);return this._timers[r]=[r,e,s],r}clearTimeout(e){clearTimeout(e),delete this._timers[e]}clearInterval(e){this.clearTimeout(e)}raw_send(e){this.socket.send(e)}raw_onmessage(e){this._on("message",e)}close(e=1e3,t){this.closed=!0,this.socket.close(e,t?.toString())}isClosed(){return this.closed||this.socket.readyState==WebSocket.CLOSED}async setName(e){await this.callMiddleware("onNameChange",e)||(this.name=e)}getName(){return this.name}}var r;exports.Connection=s,function(e){e[e.RATELIMIT=4e3]="RATELIMIT",e[e.SMALL=4001]="SMALL",e[e.INVALID_KEY=4002]="INVALID_KEY",e[e.INVALID_PACKET=4003]="INVALID_PACKET",e[e.INVALID_DATA=4004]="INVALID_DATA",e[e.REPEATED_HANDSHAKE=4005]="REPEATED_HANDSHAKE",e[e.DISABLED_PACKET=4006]="DISABLED_PACKET",e[e.MIDDLEWARE=4007]="MIDDLEWARE",e[e.MANUAL_SHUTDOWN=4008]="MANUAL_SHUTDOWN"}(r||(exports.CloseCodes=r={}));

package/dist/{ws → ts/ws}/PacketProcessor.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
 import { SonicWSConnection } from "./server/SonicWSConnection";
 /**
  * A basic middleware interface; extended by other middleware types

package/dist/ts/ws/PacketProcessor.js

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
+
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.MiddlewareHolder=void 0;exports.MiddlewareHolder=class{middlewares=[];addMiddleware(e){this.middlewares.push(e);const r=e;try{"function"==typeof r.init&&r.init(this)}catch(e){console.warn("Middleware init threw an error:",e)}}async callMiddleware(e,...r){let t=!1;for(const d of this.middlewares){const i=d[e];if(i)try{await i(...r)&&(t=!0)}catch(r){console.warn(`Middleware ${String(e)} threw an error:`,r)}}return t}};

package/dist/{ws → ts/ws}/client/core/ClientCore.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Copyright (c) 2026 Lily (liwybloc)
+ * License-Identifier: LicenseRef-Lily-Personal-NonCommercial-2026
+ * See LICENSE for personal, non-commercial license terms.
+ */
 import { PacketHolder } from "../../util/packets/PacketHolder";
 import { Connection } from "../../Connection";
 import { AsyncPQ, ClientPQ, PacketQueue } from "../../PacketProcessor";