fix: improve TypeDoc documentation and fix linting issues

- Add proper JSDoc comments for interfaces
- Fix unused parameter linting error in tests
- Update TypeDoc generation
- Clean up documentation warnings

Author: vveerrgg

docs/README.md

@@ -1,4 +1,4 @@
-**nostr-websocket-utils v0.2.5**
+**nostr-websocket-utils v0.3.0**
 
 ***
 
@@ -23,18 +23,72 @@ A TypeScript library for building Nostr protocol WebSocket clients and servers.
 - 🎯 Type-safe message handling
 - 📦 Easy to use API
 
+## NIPs Support Status
+
+🟢 Fully implemented 🟡 Partially implemented 🔴 Not implemented
+
+| NIP | Status | Description |
+|-----|--------|-------------|
+| 01 | 🟢 | Basic protocol flow & WebSocket connections |
+| 02 | 🟢 | Contact List and Petnames |
+| 11 | 🟢 | Relay Information Document |
+| 15 | 🟢 | End of Stored Events Notice |
+| 16 | 🟢 | Event Treatment |
+| 20 | 🟢 | Command Results |
+| 42 | 🟢 | Authentication of clients to relays |
+
+### WebSocket Protocol Implementation Details
+
+This package implements the Nostr WebSocket protocol with full support for the core NIPs that define WebSocket behavior. Here's how it works:
+
+#### Key Features & Compliance
+
+1. **Protocol Implementation**:
+   - Full implementation of Nostr WebSocket protocol
+   - Support for all standard message types (EVENT, REQ, CLOSE, etc.)
+   - Robust error handling and status reporting
+
+2. **Connection Management**:
+   - Automatic reconnection with configurable backoff
+   - Heartbeat mechanism for connection health
+   - Connection pooling and load balancing
+
+3. **Message Handling**:
+   - Type-safe message processing
+   - Support for subscription management
+   - Efficient event filtering
+
+4. **Security & Best Practices**:
+   - Secure WebSocket connections (WSS)
+   - Implementation of authentication protocols
+   - Rate limiting and protection mechanisms
+
+#### Interoperability
+
+This implementation ensures compatibility with:
+- All major Nostr relays
+- Other Nostr clients and libraries
+- Standard WebSocket tooling and infrastructure
+
+#### Validation & Testing
+
+The package includes:
+- Comprehensive test suites for protocol compliance
+- Connection reliability testing
+- Performance benchmarks for message handling
+
 ## Installation
 
 ```bash
-npm install @humanjavaenterprises/nostr-websocket-utils
+npm install nostr-websocket-utils
 ```
 
 ## Quick Start
 
 ### Creating a Nostr WebSocket Client
 
 ```typescript
-import { NostrWSClient } from '@humanjavaenterprises/nostr-websocket-utils';
+import { NostrWSClient } from 'nostr-websocket-utils';
 
 const client = new NostrWSClient('wss://relay.example.com', {
   logger: console,
@@ -66,6 +120,14 @@ const server = await createNostrServer(8080, {
 });
 ```
 
+## Dependencies
+
+This package relies on:
+- [nostr-crypto-utils](https://github.com/HumanjavaEnterprises/nostr-crypto-utils) - For all cryptographic operations
+- [ws](https://github.com/websockets/ws) - For WebSocket functionality
+- [pino](https://github.com/pinojs/pino) - For logging
+- [uuid](https://github.com/uuidjs/uuid) - For unique identifiers
+
 ## Documentation
 
 Comprehensive API documentation is available in our [documentation site](https://humanjavaenterprises.github.io/nostr-websocket-utils/). Here's what you'll find:
@@ -86,7 +148,7 @@ Comprehensive API documentation is available in our [documentation site](https:/
 - [getLogger](_media/getLogger.md) - Logging utility
 
 ### Type Definitions
-- [MessageType](_media/NostrWSMessageType.md) - Message type enumeration
+- [MessageType](docs/enumerations/NostrWSMessageType.md) - Message type enumeration
 - [Global Types](_media/globals.md) - Global type definitions
 
 ## Examples
@@ -114,16 +176,9 @@ server.broadcast({
 });
 ```
 
-## Getting Help
-
-1. Check the [documentation](https://humanjavaenterprises.github.io/nostr-websocket-utils/)
-2. Open an [issue](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/issues)
-
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Submit a Pull Request
+Contributions are welcome! Please read our [Contributing Guide](_media/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
 
 ## License
 
@@ -132,4 +187,10 @@ This project is licensed under the MIT License - see the [LICENSE](_media/LICENS
 ## Related Projects
 
 - [nostr-protocol](https://github.com/nostr-protocol/nostr)
-- [nostr-tools](https://github.com/nbd-wtf/nostr-tools)
+
+## Support
+
+If you have any questions or need help, please:
+
+1. Check the [documentation](https://humanjavaenterprises.github.io/nostr-websocket-utils/)
+2. Open an [issue](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/issues)

docs/_media/ExtendedWebSocket.md

@@ -1,90 +1,73 @@
-[**nostr-websocket-utils v0.2.5**](../README.md)
+[**nostr-websocket-utils v0.3.0**](../README.md)
 
 ***
 
 [nostr-websocket-utils](../globals.md) / ExtendedWebSocket
 
 # Interface: ExtendedWebSocket
 
-Extended WebSocket interface with additional properties
- ExtendedWebSocket
+Extended WebSocket interface with client ID
 
 ## Extends
 
 - `WebSocket`
 
-## Extended by
-
-- [`NostrSocket`](NostrSocket.md)
-
 ## Properties
 
-### isAlive?
-
-> `optional` **isAlive**: `boolean`
+### clientId?
 
-Whether the WebSocket connection is alive
+> `optional` **clientId**: `string`
 
 #### Defined in
 
-[types/index.ts:180](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L180)
+[types/index.ts:21](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L21)
 
 ***
 
-### subscriptions?
-
-> `optional` **subscriptions**: `Set`\<`string`\>
+### isAlive?
 
-Set of subscription channels
+> `optional` **isAlive**: `boolean`
 
 #### Defined in
 
-[types/index.ts:185](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L185)
+[types/index.ts:22](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L22)
 
 ***
 
-### clientId?
-
-> `optional` **clientId**: `string`
+### subscriptions?
 
-Unique client identifier
+> `optional` **subscriptions**: `Set`\<`string`\>
 
 #### Defined in
 
-[types/index.ts:190](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L190)
+[types/index.ts:23](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L23)
 
 ***
 
-### messageQueue?
-
-> `optional` **messageQueue**: [`NostrWSMessage`](NostrWSMessage.md)[]
+### lastPing?
 
-Queue of messages to be sent
+> `optional` **lastPing**: `number`
 
 #### Defined in
 
-[types/index.ts:195](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L195)
+[types/index.ts:24](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L24)
 
 ***
 
-### lastPing?
-
-> `optional` **lastPing**: `number`
+### reconnectAttempts?
 
-Timestamp of the last ping message
+> `optional` **reconnectAttempts**: `number`
 
 #### Defined in
 
-[types/index.ts:200](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L200)
+[types/index.ts:25](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L25)
 
 ***
 
-### reconnectAttempts?
-
-> `optional` **reconnectAttempts**: `number`
+### messageQueue?
 
-Number of reconnect attempts
+> `optional` **messageQueue**: [`NostrWSMessage`](NostrWSMessage.md)[]
 
 #### Defined in
 
-[types/index.ts:205](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L205)
+[types/index.ts:26](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/types/index.ts#L26)

docs/_media/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 MaiQR Platform
+Copyright (c) 2024 Humanjava Enterprises
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/_media/NostrServer.md

@@ -1,4 +1,4 @@
-[**nostr-websocket-utils v0.2.5**](../README.md)
+[**nostr-websocket-utils v0.3.0**](../README.md)
 
 ***
 
@@ -20,7 +20,7 @@ Creates a new Nostr WebSocket server instance
 
 ##### options
 
-[`NostrWSServerOptions`](../interfaces/NostrWSServerOptions.md)
+`NostrWSServerOptions`
 
 Server configuration options
 
@@ -30,37 +30,25 @@ Server configuration options
 
 #### Defined in
 
-[nostr-server.ts:24](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/nostr-server.ts#L24)
+[core/nostr-server.ts:22](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/core/nostr-server.ts#L22)
 
 ## Properties
 
 ### server
 
-> `private` **server**: `Server`\<*typeof* `WebSocket`, *typeof* `IncomingMessage`\>
+> `private` **server**: `WebSocketServer`
 
 The underlying WebSocket server instance
 
 #### Defined in
 
-[nostr-server.ts:12](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/nostr-server.ts#L12)
-
-***
-
-### logger
-
-> `private` **logger**: `Logger`
-
-Logger instance for this server
-
-#### Defined in
-
-[nostr-server.ts:17](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/nostr-server.ts#L17)
+[core/nostr-server.ts:15](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/core/nostr-server.ts#L15)
 
 ## Methods
 
-### close()
+### stop()
 
-> **close**(): `void`
+> **stop**(): `void`
 
 Closes the WebSocket server
 
@@ -70,4 +58,4 @@ Closes the WebSocket server
 
 #### Defined in
 
-[nostr-server.ts:112](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/nostr-server.ts#L112)
+[core/nostr-server.ts:97](https://github.com/HumanjavaEnterprises/nostr-websocket-utils/blob/main/src/core/nostr-server.ts#L97)