vortez-io 1.0.0

package/.gitignore

@@ -0,0 +1,15 @@
+# Build setting
+**/node_modules/
+**/build/
+**/build-*/
+**/.**
+**/*.log
+**/*.env
+**/*.tsbuildinfo
+!.gitignore
+
+# Work space setting
+!.vscode/
+
+# Test setting
+test.ts

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 2026 NetFeez
+
+   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/PROTOCOL.md

@@ -0,0 +1,245 @@
+# Vortez IO Protocol
+
+Vortez IO Protocol works over WebSocket protocol and defines a binary frame structure for multiplexed messaging (events, requests, responses and errors).
+
+Each WebSocket frame **MUST** contain exactly **one Vortez frame**.
+
+---
+
+## Protocol Frame Description
+
+### Header description map
+
+| byte | bit | Function | description                       |
+| ---- | --- | -------- | --------------------------------- |
+| 0    | 0-3 | TYPE     | [Reference for type](#type)       |
+| 0    | 4-7 | MODE     | [Reference for mode](#mode)       |
+| 1    | all | RESERVED | Future use                        |
+| 2    | 0-1 | ID_TYPE  | [Reference for id-type](#id_type) |
+| 2    | 2-7 | RESERVED | MUST be `0`                       |
+
+> [!IMPORTANT]
+>
+> 🔒 **Invariant:** Header bytes (0, 1, 2) are always present.
+>
+> 🔒 **Invariant:** Reserved bits **MUST** be `0`.
+
+---
+
+## Frame Layout
+
+After byte `2`, the frame continues depending on `ID_TYPE`.
+
+---
+
+### If `ID_TYPE = 0x0 (NONE)`
+
+| byte | Function | description |
+| ---- | -------- | ----------- |
+| 3..  | DATA     | Payload     |
+
+---
+
+### If `ID_TYPE = 0x1 (UUID)`
+
+| byte | Function | description                 |
+| ---- | -------- | --------------------------- |
+| 3-18 | UUID     | 16-byte identifier (binary) |
+| 19.. | DATA     | Payload                     |
+
+---
+
+### If `ID_TYPE = 0x2 (STRING)`
+
+| byte   | Function       | description                        |
+| ------ |----------------|------------------------------------|
+| 3..N   | VARINT LENGTH  | Length of the string               |
+| N+1..M | STRING         | UTF-8 identifier                   |
+| M+1..  | DATA           | Payload                            |
+
+---
+
+## ID_TYPE
+
+Defines the type of identifier present in the frame.
+
+| Value | Name     | Description                |
+| ----- |----------|----------------------------|
+| `0x0` | NONE     | No identifier              |
+| `0x1` | UUID     | 16-byte binary identifier  |
+| `0x2` | STRING   | UTF-8 string identifier    |
+| `0x3` | RESERVED | Reserved for future use    |
+
+---
+
+## UUID Specification
+
+* UUID **MUST** be exactly **16 bytes**
+* UUID **MUST** be treated as opaque binary (no string encoding)
+* Endianness is **network order (big-endian)**
+* UUID is used for **request-response correlation**
+
+---
+
+## STRING Specification
+
+* Length **MUST** be encoded using varint
+* Content **MUST** be valid UTF-8
+* SHOULD be used for event names or routing keys
+
+---
+
+## Varint Encoding
+
+Used for encoding STRING length.
+
+| bit | Function |
+|-----|----------|
+| 7   | CONTINUE |
+| 0-6 | VALUE    |
+
+Rules:
+
+* CONTINUE = `1` → more bytes follow
+* CONTINUE = `0` → last byte
+* Encoding uses **unsigned LEB128 (base-128)**
+
+---
+
+## TYPE
+
+Defines the semantic meaning of the frame.
+
+| Value | Name     | Description                |
+| ----- | -------- | -------------------------- |
+| `0x0` | RAW      | Unstructured binary data   |
+| `0x1` | EVENT    | Fire-and-forget message    |
+| `0x2` | REQUEST  | Request expecting response |
+| `0x3` | RESPONSE | Response to a request      |
+| `0x4` | ERROR    | Error frame                |
+
+---
+
+### TYPE Rules
+
+#### `0x0` RAW
+
+* **MAY** include any MODE
+* **MUST NOT** rely on protocol-level semantics
+
+---
+
+#### `0x1` EVENT
+
+* MUST use STRING identifier
+* MUST NOT require response
+
+---
+
+#### `0x2` REQUEST
+
+* MUST use `UUID`
+* UUID MUST be unique per connection
+* Receiver MUST respond with:
+
+  * `RESPONSE (0x3)`
+  * or `ERROR (0x4)`
+
+---
+
+#### `0x3` RESPONSE
+
+* MUST use `UUID`
+* MUST match an existing request
+
+---
+
+#### `0x4` ERROR
+
+* MAY include identifier
+* Behavior depends on context
+
+---
+
+## ERROR Semantics
+
+### 1. Error Response (Request-bound)
+
+* TYPE: `0x4`
+* ID_TYPE: `UUID`
+* MUST reference an existing request
+
+---
+
+### 2. Error Feedback (Protocol-level)
+
+* TYPE: `0x4`
+* ID_TYPE: `NONE`
+* MUST NOT include identifier
+
+---
+
+### Error Behavior Rules
+
+If a frame violates protocol:
+
+* Receiver **MUST** send `ERROR (0x4)`
+* If request context exists → **MUST include UUID**
+* Otherwise → **MUST use ID_TYPE = NONE**
+
+---
+
+## MODE
+
+Defines how DATA should be interpreted.
+
+| Value | Name   | Description                          |
+| ----- | ------ | ------------------------------------ |
+| `0x0` | BINARY | Raw binary                           |
+| `0x1` | JSON   | UTF-8 encoded JSON                   |
+| `0x2` | LINE   | UTF-8 text terminated by LF (`0x0A`) |
+| `0x3` | CUSTOM | Application-defined                  |
+
+---
+
+### MODE Rules
+
+#### JSON (`0x1`)
+
+* DATA **MUST** be valid UTF-8 JSON
+
+---
+
+#### LINE (`0x2`)
+
+* DATA **MUST** be UTF-8 text
+* Messages **SHOULD** end with `\n` (`0x0A`)
+* Receiver **MAY** trim trailing newline
+
+---
+
+#### CUSTOM (`0x3`)
+
+* Interpretation is application-defined
+* Protocol **MUST NOT** enforce structure
+
+---
+
+## Reserved Space (Future Use)
+
+* Byte `1` is reserved
+* ID_META reserved bits MUST be `0`
+* Future versions MAY introduce:
+
+  * flags
+  * compression
+  * fragmentation
+
+---
+
+## Protocol Guarantees
+
+* One WebSocket frame = one Vortez frame
+* No internal framing is used
+* Ordering is delegated to WebSocket
+* Reliability is delegated to transport

package/README.md

@@ -0,0 +1,103 @@
+# Vortez IO Protocol
+
+`vortez-io-protocol` is a small TypeScript library for encoding and decoding the Vortez IO binary frame format used over WebSocket connections. It implements the protocol described in [PROTOCOL.md](PROTOCOL.md) and provides helpers for request/response correlation, event delivery, and frame validation.
+
+## Features
+
+- Binary frame encoding and decoding
+- Request/response correlation with UUID identifiers
+- Event frames with string identifiers
+- Support for `BINARY`, `JSON`, `LINE`, and `CUSTOM` payload modes
+- Strict protocol validation with typed errors
+- Higher-level typed wrapper via `VIOStrict`
+
+## Installation
+
+```bash
+npm install vortez-io
+```
+
+The library is published from the TypeScript source in this repository and targets an ES module environment.
+
+## Quick Start
+
+```ts
+import VIO from './build/VIO.js';
+import VIOError from './build/VIOError.js';
+
+const vio = new VIO({
+	setTimeout,
+	clearTimeout,
+	createUUID: () => crypto.randomUUID()
+});
+
+vio.transport.on('send', (frame) => {
+	websocket.send(frame);
+});
+
+websocket.onmessage = (event) => {
+	vio.handle(event.data);
+};
+
+vio.on('event', (name, mode, data) => {
+	console.log('event:', name, mode, data);
+});
+
+vio.on('request', (mode, data, respond, reject) => {
+	if (mode !== 'JSON') {
+		reject(new VIOError(VIOError.Code.INVALID_DATA, 'Unsupported request mode'));
+		return;
+	}
+
+	respond({ ok: true });
+});
+
+vio.event('connected', { ok: true });
+const response = await vio.request({ action: 'ping' });
+```
+
+## Core API
+
+### `VIO`
+
+The main transport-aware protocol runtime.
+
+- `request(data, options?)`: send a request and await a response
+- `event(name, data)`: send an event frame
+- `handle(data)`: decode an incoming frame and dispatch it
+- `transport`: event emitter that exposes outgoing frames through `send`
+
+### `Frame`
+
+Low-level frame encoder/decoder for protocol payloads.
+
+- `Frame.encode(...)`
+- `Frame.decode(...)`
+
+Use this when you need direct access to protocol bytes instead of the higher-level `VIO` API.
+
+### `VIOStrict`
+
+Typed wrapper for validating request and event payloads with schemas from `@netfeez/common`.
+
+## Protocol Summary
+
+The protocol is described in detail in [PROTOCOL.md](PROTOCOL.md). In short:
+
+- Each WebSocket message contains exactly one Vortez frame
+- Every frame starts with three header bytes
+- `REQUEST` and `RESPONSE` frames use UUID identifiers
+- `EVENT` frames use string identifiers
+- `ERROR` frames can be protocol-level (`NONE`) or request-bound (`UUID`)
+
+## Development
+
+```bash
+npm run build
+```
+
+The build script compiles the TypeScript sources into the `build/` directory.
+
+## License
+
+Apache-2.0

package/build/Frame.d.ts

@@ -0,0 +1,118 @@
+import VIOError from "./VIOError.js";
+export declare class Frame<T extends Frame.Type = Frame.Type> implements Frame.Frame<T> {
+    readonly type: T;
+    readonly mode: Frame.Mode;
+    readonly identifier: Frame.IdentifierMap[T];
+    readonly data: ArrayBuffer;
+    readonly reservedRaw: number;
+    protected static readonly TYPE_TO_BITS: Record<Frame.Type, number>;
+    protected static readonly TYPE_MAP: Record<number, Frame.Type>;
+    protected static readonly MODE_TO_BITS: Record<Frame.Mode, number>;
+    protected static readonly MODE_MAP: Record<number, Frame.Mode>;
+    protected static readonly ID_TYPE_TO_BITS: Record<Frame.IDType, number>;
+    protected static readonly ID_TYPE_MAP: Record<number, Frame.IDType>;
+    constructor(type: T, mode: Frame.Mode, identifier: Frame.IdentifierMap[T], data: ArrayBuffer, reservedRaw: number);
+    /**
+     * Decodes a binary frame from the given ArrayBuffer or Uint8Array according to the protocol specification.
+     * The method parses the frame header to determine the type, mode, and identifier, and then extracts the payload data.
+     * It performs various validations to ensure the frame adheres to the protocol rules, such as checking reserved bits and validating identifier types based on frame type.
+     * @param buffer The input buffer containing the binary frame data to decode.
+     * @returns A Frame object representing the decoded frame with its components (type, mode, identifier, data).
+     * @throws VIOError if the buffer is too short, contains invalid header values, or violates protocol rules regarding type and identifier combinations.
+     */
+    static decode(buffer: ArrayBuffer | Uint8Array): Frame.FrameUnion;
+    /**
+     * Assembles a Frame object from the given components, performing additional validation to ensure that the combination of type and identifier adheres to protocol rules.
+     * This method is called after decoding the raw components of a frame to construct the final Frame object with proper typing and validation.
+     * It checks that REQUEST and RESPONSE frames use UUID identifiers, EVENT frames use STRING identifiers, and ERROR frames can use either NONE or UUID identifiers.
+     * If the components are valid, it returns a new Frame object; otherwise, it throws a VIOError indicating the specific protocol violation.
+     * @param parts An object containing the decoded components of the frame (type, mode, identifier, data, reservedRaw) to be assembled into a Frame object.
+     * @returns A Frame object representing the assembled frame with its components.
+     * @throws VIOError if the combination of type and identifier is invalid according to protocol rules.
+     */
+    protected static assemble(parts: Frame.Frame): Frame.FrameUnion;
+    /**
+     * Encodes the given frame components into a binary format according to the protocol specification.
+     * The resulting ArrayBuffer will contain the frame header followed by the identifier (if applicable) and the payload data.
+     * @param type The type of the frame (e.g., 'REQUEST', 'RESPONSE', etc.).
+     * @param mode The mode of the frame (e.g., 'BINARY', 'JSON', etc.).
+     * @param data The payload data to include in the frame, as an ArrayBuffer or Uint8Array.
+     * @param identifier An optional identifier for the frame, which can be of type NONE, UUID, or STRING. Defaults to NONE if not provided.
+     * @returns An ArrayBuffer containing the encoded frame ready for transmission.
+     * @throws VIOError if the provided type, mode, or identifier combination is invalid according to the protocol rules.
+     */
+    static encode(type: 'RAW', mode: Frame.Mode, data: ArrayBuffer | Uint8Array, identifier?: Frame.IdentifierMap['RAW']): ArrayBuffer;
+    static encode(type: 'EVENT', mode: Frame.Mode, data: ArrayBuffer | Uint8Array, identifier: Frame.IdentifierMap['EVENT']): ArrayBuffer;
+    static encode(type: 'REQUEST', mode: Frame.Mode, data: ArrayBuffer | Uint8Array, identifier: Frame.IdentifierMap['REQUEST']): ArrayBuffer;
+    static encode(type: 'RESPONSE', mode: Frame.Mode, data: ArrayBuffer | Uint8Array, identifier: Frame.IdentifierMap['RESPONSE']): ArrayBuffer;
+    static encode(type: 'ERROR', mode: Frame.Mode, data: ArrayBuffer | Uint8Array, identifier?: Frame.IdentifierMap['ERROR']): ArrayBuffer;
+    /**
+     * Validates the combination of frame type and identifier type according to protocol rules:
+     * - REQUEST and RESPONSE frames MUST use UUID identifiers.
+     * - EVENT frames MUST NOT use UUID identifiers (they can use STRING or NONE).
+     * - ERROR and RAW frames have no restrictions on identifier type.
+     * @param type The frame type to validate.
+     * @param idType The identifier type to validate against the frame type.
+     * @throws VIOError if the combination of type and idType is invalid according to the protocol rules.
+     */
+    protected static validate(type: Frame.Type, idType: Frame.IDType): void;
+    /**
+     * Creates a copy of the ArrayBuffer from a Uint8Array view, ensuring it is not a shared buffer.
+     * This is necessary because the input Uint8Array may be a view into a larger buffer, and we want to ensure that the Frame's data is isolated and immutable.
+     * @param view The Uint8Array view to convert into an ArrayBuffer.
+     * @returns A new ArrayBuffer containing the data from the view.
+     */
+    protected static toArrayBuffer(view: Uint8Array): ArrayBuffer;
+    /**
+     * Utility method to assert that a value is defined (not undefined) and throw a VIOError with the provided message if it is not.
+     * This is used to ensure that required values are present during decoding and validation processes.
+     * @param value The value to check for being defined.
+     * @param code The VIOError code to use if the value is undefined.
+     * @param msg The error message to include in the VIOError if the value is undefined.
+     * @returns The input value if it is defined, otherwise throws a VIOError.
+     * @throws VIOError if the value is undefined, with the provided message.
+     */
+    protected static assertDefined<T>(value: T | undefined, code: VIOError.Code, msg: string): T;
+}
+export declare namespace Frame {
+    type Type = 'RAW' | 'EVENT' | 'REQUEST' | 'RESPONSE' | 'ERROR';
+    type Mode = 'BINARY' | 'JSON' | 'LINE' | 'CUSTOM';
+    type IDType = 'NONE' | 'UUID' | 'STRING';
+    namespace Identifier {
+        interface Base {
+            type: IDType;
+        }
+        interface None extends Base {
+            type: 'NONE';
+        }
+        interface UUID extends Base {
+            type: 'UUID';
+            id: string;
+            idRaw?: Uint8Array;
+        }
+        interface String extends Base {
+            type: 'STRING';
+            id: string;
+            idRaw?: Uint8Array;
+        }
+    }
+    type Identifier = Identifier.None | Identifier.UUID | Identifier.String;
+    interface IdentifierMap {
+        RAW: Identifier.None | Identifier.UUID | Identifier.String;
+        EVENT: Identifier.String;
+        REQUEST: Identifier.UUID;
+        RESPONSE: Identifier.UUID;
+        ERROR: Identifier.None | Identifier.UUID;
+    }
+    interface Frame<T extends Type = Type> {
+        type: T;
+        mode: Mode;
+        identifier: IdentifierMap[T];
+        data: ArrayBuffer;
+        reservedRaw: number;
+    }
+    type FrameUnion = {
+        [K in Type]: Frame<K>;
+    }[Type];
+}
+export default Frame;