feat(TypedSocket): Add SmartServe integration to TypedSocket, support SmartServe connections and tagging; update dependencies and docs; remove GitLab CI config
This commit is contained in:
128
.gitlab-ci.yml
128
.gitlab-ci.yml
@@ -1,128 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- pnpm install -g pnpm
|
||||
- pnpm install -g @shipzone/npmci
|
||||
- npmci npm prepare
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --prod
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command pnpm audit --audit-level=high --dev
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run buildDocs
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
47
changelog.md
Normal file
47
changelog.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-12-02 - 3.1.0 - feat(TypedSocket)
|
||||
Add SmartServe integration to TypedSocket, support SmartServe connections and tagging; update dependencies and docs; remove GitLab CI config
|
||||
|
||||
- Add TypedSocket.fromSmartServe(smartServe, typedRouter) to bind TypedSocket to an existing SmartServe instance for native WebSocket handling.
|
||||
- Introduce ISmartServeConnectionWrapper and wrapSmartServePeer to provide tag compatibility between SmartServe (Set<string>) and TypedSocket (id/payload). Tag payloads are stored in peer.data with '__typedsocket_tag__' prefix.
|
||||
- Server-initiated requests in SmartServe mode use TypedRouter.fireEventInterestMap to correlate requests and responses asynchronously.
|
||||
- Extend createTypedRequest, findAllTargetConnections, findTargetConnection, findAllTargetConnectionsByTag and findTargetConnectionByTag to support both Smartsocket and SmartServe backends (via wrappers).
|
||||
- eventSubject: Emit a warning and return a new Subject in SmartServe mode (SmartServe lifecycle/events should be consumed via SmartServe hooks).
|
||||
- stop(): In SmartServe mode TypedSocket clears internal wrappers but does not stop SmartServe (SmartServe lifecycle is managed externally).
|
||||
- Add optional peer dependency @push.rocks/smartserve and expose type-only imports in ts/typedsocket.plugins.ts.
|
||||
- Bump several devDependencies and runtime dependencies to newer versions (tsbuild, tsbundle, tsrun, tstest, smartenv, smartserve, smartjson, smartrx, smartsocket, smartstring, smarturl).
|
||||
- Update README and readme.hints with SmartServe integration docs and examples.
|
||||
- Remove .gitlab-ci.yml (CI configuration removed).
|
||||
|
||||
## 2024-04-18 - 3.0.1 - patch
|
||||
Small patch release.
|
||||
|
||||
- Version bump to 3.0.1.
|
||||
- No additional details provided in commits.
|
||||
|
||||
## 2024-04-18 - 3.0.0 - core
|
||||
Major 3.0.0 release with core updates and documentation improvements.
|
||||
|
||||
- Core fixes and updates applied.
|
||||
- Documentation updated (commit dated 2024-04-14).
|
||||
- General maintenance and polishing for the 3.x line.
|
||||
|
||||
## 2023-08-06 - 2.0.28 - core (BREAKING CHANGE)
|
||||
Breaking change in core introduced in 2.0.28; important compatibility considerations.
|
||||
|
||||
- BREAKING CHANGE(core): update — review integration points before upgrading.
|
||||
- This capstone release follows a series of patch releases addressing stability and core behavior.
|
||||
|
||||
## 2022-03-24 - 2.0.0 - core
|
||||
Introduction of the 2.x stable line and subsequent patch series.
|
||||
|
||||
- 2.0.0 initial release of the 2.x series.
|
||||
- Follow-up patch releases (2.0.1 through 2.0.27) contain numerous "fix(core): update" changes — ongoing bug fixes, stability improvements, and small core adjustments across 2022–2023.
|
||||
- Users upgrading from 1.x should review 2.x changes and the 2.0.28 breaking change above.
|
||||
|
||||
## 2020-12-26 - 1.0.2 - core
|
||||
Initial implemented functionality and the start of 1.x maintenance.
|
||||
|
||||
- fix(core): implement basic functionality — initial usable feature set implemented in 1.0.2.
|
||||
- Subsequent 1.0.3 through 1.0.27 releases (2020–2022) included ongoing fixes and minor updates to stabilize the 1.x line.
|
||||
39
package.json
39
package.json
@@ -14,23 +14,32 @@
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.66",
|
||||
"@git.zone/tsbundle": "^2.0.8",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^1.0.77",
|
||||
"@push.rocks/smartenv": "^5.0.12",
|
||||
"@push.rocks/tapbundle": "^5.0.23",
|
||||
"@types/node": "^20.12.7"
|
||||
"@git.zone/tsbuild": "^3.1.2",
|
||||
"@git.zone/tsbundle": "^2.6.2",
|
||||
"@git.zone/tsrun": "^2.0.0",
|
||||
"@git.zone/tstest": "^3.1.3",
|
||||
"@push.rocks/smartenv": "^6.0.0",
|
||||
"@push.rocks/smartserve": "^1.1.0",
|
||||
"@push.rocks/tapbundle": "^6.0.3",
|
||||
"@types/node": "^24.10.1"
|
||||
},
|
||||
"dependencies": {
|
||||
"@api.global/typedrequest": "^3.0.21",
|
||||
"@api.global/typedrequest-interfaces": "^3.0.18",
|
||||
"@push.rocks/isohash": "^2.0.0",
|
||||
"@push.rocks/smartjson": "^5.0.19",
|
||||
"@push.rocks/smartrx": "^3.0.7",
|
||||
"@push.rocks/smartsocket": "^2.0.25",
|
||||
"@push.rocks/smartstring": "^4.0.15",
|
||||
"@push.rocks/smarturl": "^3.0.5"
|
||||
"@api.global/typedrequest": "^3.1.10",
|
||||
"@api.global/typedrequest-interfaces": "^3.0.19",
|
||||
"@push.rocks/isohash": "^2.0.1",
|
||||
"@push.rocks/smartjson": "^5.2.0",
|
||||
"@push.rocks/smartrx": "^3.0.10",
|
||||
"@push.rocks/smartsocket": "^2.1.0",
|
||||
"@push.rocks/smartstring": "^4.1.0",
|
||||
"@push.rocks/smarturl": "^3.1.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@push.rocks/smartserve": ">=1.0.0"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@push.rocks/smartserve": {
|
||||
"optional": true
|
||||
}
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
|
||||
13658
pnpm-lock.yaml
generated
13658
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1 +1,21 @@
|
||||
|
||||
# TypedSocket Hints
|
||||
|
||||
## SmartServe Integration (Added v3.1.0)
|
||||
|
||||
TypedSocket now supports SmartServe as an alternative WebSocket backend via `TypedSocket.fromSmartServe()`.
|
||||
|
||||
### Key Differences from Smartsocket Mode
|
||||
|
||||
1. **Tag System**: SmartServe uses `Set<string>` for tags, while Smartsocket uses `{id, payload}`. The wrapper stores payloads in `peer.data` with `__typedsocket_tag__` prefix.
|
||||
|
||||
2. **Request/Response**: Uses TypedRouter's `fireEventInterestMap` for async correlation when sending server-initiated requests.
|
||||
|
||||
3. **Lifecycle**: SmartServe manages WebSocket lifecycle. `typedSocket.stop()` only clears internal state.
|
||||
|
||||
4. **eventSubject**: Not fully supported in SmartServe mode - use SmartServe's `onConnectionOpen`/`onConnectionClose` hooks instead.
|
||||
|
||||
### Files Modified for SmartServe Support
|
||||
|
||||
- `ts/typedsocket.classes.typedsocket.ts` - Main implementation
|
||||
- `ts/typedsocket.plugins.ts` - Type imports
|
||||
- `package.json` - Optional peer dependency
|
||||
|
||||
349
readme.md
349
readme.md
@@ -1,159 +1,312 @@
|
||||
# @api.global/typedsocket
|
||||
a typedrequest extension supporting websockets
|
||||
|
||||
A TypeScript library for creating typed WebSocket connections with bi-directional communication support. Extends `@api.global/typedrequest` to bring type-safe request/response patterns to WebSocket connections.
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
## Features
|
||||
|
||||
- 🔒 **Full Type Safety** - Leverages TypeScript for compile-time checking of all request/response payloads
|
||||
- 🔄 **Bi-directional Communication** - Both server and client can initiate requests
|
||||
- 🔌 **Auto-reconnect** - Client automatically reconnects on connection loss
|
||||
- 🏷️ **Connection Tagging** - Tag and filter connections for targeted messaging
|
||||
- 🌐 **Browser Compatible** - Works in both Node.js and browser environments
|
||||
- 🔗 **SmartExpress Integration** - Optional integration with existing SmartExpress servers
|
||||
- 🚀 **SmartServe Integration** - Native support for SmartServe's WebSocket handling
|
||||
|
||||
## Install
|
||||
To install `@api.global/typedsocket` in your project, run the following command using npm:
|
||||
|
||||
```bash
|
||||
npm install @api.global/typedsocket --save
|
||||
npm install @api.global/typedsocket
|
||||
```
|
||||
|
||||
For Yarn users:
|
||||
Or with pnpm:
|
||||
|
||||
```bash
|
||||
yarn add @api.global/typedsocket
|
||||
pnpm add @api.global/typedsocket
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
To utilize `@api.global/typedsocket` effectively, let's explore how to integrate it into a project with TypeScript. This guide provides comprehensive usage scenarios, highlighting all features of the module. `@api.global/typedsocket` extends the capabilities of `typedrequest` by integrating websocket support, allowing for real-time, bidirectional communication between a client and server.
|
||||
### Prerequisites
|
||||
|
||||
### Getting Started
|
||||
- TypeScript project setup
|
||||
- Basic understanding of async/await patterns
|
||||
- Familiarity with `@api.global/typedrequest` concepts
|
||||
|
||||
#### Prerequisites
|
||||
### Define Your Request Interface
|
||||
|
||||
Before diving into examples, ensure you have the following:
|
||||
First, define the typed request interface that both client and server will use:
|
||||
|
||||
- A basic understanding of TypeScript and Node.js.
|
||||
- An existing project set up with TypeScript.
|
||||
- `@api.global/typedrequest` and its dependencies installed in your project.
|
||||
```typescript
|
||||
import * as typedrequestInterfaces from '@api.global/typedrequest-interfaces';
|
||||
|
||||
#### Initialization
|
||||
interface IGreetingRequest extends typedrequestInterfaces.implementsTR<
|
||||
typedrequestInterfaces.ITypedRequest,
|
||||
IGreetingRequest
|
||||
> {
|
||||
method: 'greet';
|
||||
request: {
|
||||
name: string;
|
||||
};
|
||||
response: {
|
||||
message: string;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
First, let's import the required modules and initialize our server and client instances.
|
||||
### Server Setup
|
||||
|
||||
**Server Side:**
|
||||
|
||||
Within your server-side code, import and set up `TypedSocket` to create a websocket server.
|
||||
Create a WebSocket server that handles typed requests:
|
||||
|
||||
```typescript
|
||||
import { TypedSocket } from '@api.global/typedsocket';
|
||||
import * as typedrequest from '@api.global/typedrequest';
|
||||
|
||||
// Initialize your TypedRouter
|
||||
// Create the router and add handlers
|
||||
const typedRouter = new typedrequest.TypedRouter();
|
||||
|
||||
// Create the TypedSocket server
|
||||
const server = await TypedSocket.createServer(typedRouter);
|
||||
|
||||
// Optionally, you can provide a smartexpressServerArg if you have an existing SmartExpress server
|
||||
```
|
||||
|
||||
**Client Side:**
|
||||
|
||||
On the client side, initialize `TypedSocket` to connect to the websocket server.
|
||||
|
||||
```typescript
|
||||
import { TypedSocket } from '@api.global/typedsocket';
|
||||
|
||||
// Assuming server is at http://localhost:3000
|
||||
const client = await TypedSocket.createClient(typedRouter, 'http://localhost:3000');
|
||||
```
|
||||
|
||||
### Defining Typed Requests
|
||||
|
||||
`@api.global/typedsocket` leverages `typedrequest` for type-safe requests and responses. Here's how you can define and handle typed requests:
|
||||
|
||||
**Defining a Typed Request Interface:**
|
||||
|
||||
Define an interface for the request and its corresponding response.
|
||||
|
||||
```typescript
|
||||
interface ExampleRequest extends typedrequestInterfaces.ITypedRequest {
|
||||
method: 'exampleMethod';
|
||||
request: {
|
||||
message: string;
|
||||
};
|
||||
response: {
|
||||
reply: string;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
**Handling Requests on the Server:**
|
||||
|
||||
Add a typed handler for the request in your `TypedRouter`.
|
||||
|
||||
```typescript
|
||||
typedRouter.addTypedHandler<ExampleRequest>(
|
||||
new typedrequest.TypedHandler('exampleMethod', async (requestData) => {
|
||||
typedRouter.addTypedHandler<IGreetingRequest>(
|
||||
new typedrequest.TypedHandler('greet', async (requestData) => {
|
||||
return {
|
||||
reply: `Server received: ${requestData.message}`,
|
||||
message: `Hello, ${requestData.name}! 👋`,
|
||||
};
|
||||
})
|
||||
);
|
||||
|
||||
// Start the TypedSocket server (defaults to port 3000)
|
||||
const server = await TypedSocket.createServer(typedRouter);
|
||||
```
|
||||
|
||||
### Sending Requests from the Client
|
||||
#### Integration with SmartExpress
|
||||
|
||||
Use the client instance to send a request to the server and await a response.
|
||||
If you have an existing SmartExpress server, you can attach TypedSocket to it:
|
||||
|
||||
```typescript
|
||||
const exampleRequest = client.createTypedRequest<ExampleRequest>('exampleMethod');
|
||||
const response = await exampleRequest.fire({
|
||||
message: 'Hello from client!',
|
||||
import { TypedSocket } from '@api.global/typedsocket';
|
||||
import * as smartexpress from '@push.rocks/smartexpress';
|
||||
|
||||
const smartExpressServer = new smartexpress.Server({ port: 8080 });
|
||||
await smartExpressServer.start();
|
||||
|
||||
const server = await TypedSocket.createServer(typedRouter, smartExpressServer);
|
||||
```
|
||||
|
||||
#### Integration with SmartServe
|
||||
|
||||
For SmartServe-based applications, use `fromSmartServe()` for native integration:
|
||||
|
||||
```typescript
|
||||
import { TypedSocket } from '@api.global/typedsocket';
|
||||
import { SmartServe } from '@push.rocks/smartserve';
|
||||
import * as typedrequest from '@api.global/typedrequest';
|
||||
|
||||
const typedRouter = new typedrequest.TypedRouter();
|
||||
|
||||
// Add handlers for client-to-server requests
|
||||
typedRouter.addTypedHandler<IGreetingRequest>(
|
||||
new typedrequest.TypedHandler('greet', async (requestData) => {
|
||||
return { message: `Hello, ${requestData.name}!` };
|
||||
})
|
||||
);
|
||||
|
||||
// Create SmartServe with typedRouter in websocket options
|
||||
const smartServe = new SmartServe({
|
||||
port: 3000,
|
||||
websocket: {
|
||||
typedRouter,
|
||||
onConnectionOpen: (peer) => {
|
||||
// Tag connections for later filtering
|
||||
peer.tags.add('client');
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
console.log(response.reply); // "Server received: Hello from client!"
|
||||
```
|
||||
await smartServe.start();
|
||||
|
||||
### Advanced Usage
|
||||
// Create TypedSocket bound to SmartServe
|
||||
const typedSocket = TypedSocket.fromSmartServe(smartServe, typedRouter);
|
||||
|
||||
#### Tagging Connections
|
||||
|
||||
For more refined control, especially in scenarios with multiple clients, you can tag connections for targeted communication.
|
||||
|
||||
```typescript
|
||||
// Add a tag to a client
|
||||
client.addTag('role', 'admin');
|
||||
|
||||
// On the server, find connections with the tag
|
||||
const adminConnections = await server.findAllTargetConnectionsByTag('role', 'admin');
|
||||
|
||||
// Send a message to all admin connections
|
||||
for (const adminConnection of adminConnections) {
|
||||
const request = server.createTypedRequest<ExampleRequest>('exampleMethod', adminConnection);
|
||||
await request.fire({
|
||||
message: 'Message to admins',
|
||||
});
|
||||
// Push notifications to tagged clients
|
||||
const clients = await typedSocket.findAllTargetConnectionsByTag('client');
|
||||
for (const client of clients) {
|
||||
const request = typedSocket.createTypedRequest<INotifyRequest>('notify', client);
|
||||
await request.fire({ message: 'Hello from server!' });
|
||||
}
|
||||
```
|
||||
|
||||
#### Handling Reconnections
|
||||
> **Note:** When using SmartServe, the WebSocket transport is managed by SmartServe. TypedSocket acts as a convenience layer for finding connections and sending server-initiated requests.
|
||||
|
||||
`TypedSocket` automatically attempts to reconnect in the event of connection loss. Ensure your server and client logic accounts for reconnection, especially for maintaining state or re-subscribing to necessary events.
|
||||
### Client Setup
|
||||
|
||||
### Conclusion
|
||||
Connect to the WebSocket server from a client:
|
||||
|
||||
Implementing `@api.global/typedsocket` provides a type-safe, real-time communication layer for your TypeScript applications, extending the functionality of `typedrequest` into the realm of websockets. This guide covered initialization, defining typed requests, sending requests, and advanced usage patterns like tagging connections and handling reconnections.
|
||||
```typescript
|
||||
import { TypedSocket } from '@api.global/typedsocket';
|
||||
import * as typedrequest from '@api.global/typedrequest';
|
||||
|
||||
Integrating `@api.global/typedsocket` into your project harnesses the power of websockets with the benefits of type safety and structured request/response patterns, enabling more reliable and maintainable real-time applications.
|
||||
// Create a router for handling server-initiated requests (if needed)
|
||||
const clientRouter = new typedrequest.TypedRouter();
|
||||
|
||||
// Connect to the server
|
||||
const client = await TypedSocket.createClient(
|
||||
clientRouter,
|
||||
'http://localhost:3000'
|
||||
);
|
||||
```
|
||||
|
||||
#### Using Window Location (Browser)
|
||||
|
||||
In browser environments, you can automatically use the current page's origin:
|
||||
|
||||
```typescript
|
||||
const client = await TypedSocket.createClient(
|
||||
clientRouter,
|
||||
TypedSocket.useWindowLocationOriginUrl()
|
||||
);
|
||||
```
|
||||
|
||||
### Sending Requests
|
||||
|
||||
#### Client to Server
|
||||
|
||||
```typescript
|
||||
const request = client.createTypedRequest<IGreetingRequest>('greet');
|
||||
const response = await request.fire({
|
||||
name: 'World',
|
||||
});
|
||||
|
||||
console.log(response.message); // "Hello, World! 👋"
|
||||
```
|
||||
|
||||
#### Server to Client
|
||||
|
||||
The server can also initiate requests to connected clients:
|
||||
|
||||
```typescript
|
||||
// When only one client is connected, it's automatically selected
|
||||
const request = server.createTypedRequest<IGreetingRequest>('greet');
|
||||
const response = await request.fire({
|
||||
name: 'Client',
|
||||
});
|
||||
|
||||
// For multiple clients, specify the target connection
|
||||
const connection = await server.findTargetConnection(async (conn) => {
|
||||
// Your filter logic here
|
||||
return true;
|
||||
});
|
||||
const targetedRequest = server.createTypedRequest<IGreetingRequest>('greet', connection);
|
||||
```
|
||||
|
||||
### Connection Tagging
|
||||
|
||||
Tag connections for organized, targeted communication:
|
||||
|
||||
```typescript
|
||||
// Client side: add a tag
|
||||
interface IUserTag extends typedrequestInterfaces.ITag {
|
||||
name: 'userRole';
|
||||
payload: 'admin' | 'user' | 'guest';
|
||||
}
|
||||
|
||||
client.addTag<IUserTag>('userRole', 'admin');
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Server side: find connections by tag
|
||||
const adminConnections = await server.findAllTargetConnectionsByTag<IUserTag>(
|
||||
'userRole',
|
||||
'admin'
|
||||
);
|
||||
|
||||
// Send to all admins
|
||||
for (const conn of adminConnections) {
|
||||
const request = server.createTypedRequest<INotificationRequest>('notify', conn);
|
||||
await request.fire({ message: 'Admin notification' });
|
||||
}
|
||||
|
||||
// Find a single connection
|
||||
const firstAdmin = await server.findTargetConnectionByTag<IUserTag>('userRole', 'admin');
|
||||
```
|
||||
|
||||
### Event Handling
|
||||
|
||||
Subscribe to connection status events:
|
||||
|
||||
```typescript
|
||||
client.eventSubject.subscribe((status) => {
|
||||
console.log('Connection status:', status);
|
||||
});
|
||||
|
||||
server.eventSubject.subscribe((status) => {
|
||||
console.log('Server connection event:', status);
|
||||
});
|
||||
```
|
||||
|
||||
### Cleanup
|
||||
|
||||
Properly close connections when done:
|
||||
|
||||
```typescript
|
||||
// Client
|
||||
await client.stop();
|
||||
|
||||
// Server
|
||||
await server.stop();
|
||||
```
|
||||
|
||||
## API Reference
|
||||
|
||||
### TypedSocket
|
||||
|
||||
#### Static Methods
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| `createServer(router, smartExpressServer?)` | Creates a WebSocket server. Optionally attach to an existing SmartExpress server. |
|
||||
| `createClient(router, serverUrl, alias?)` | Creates a WebSocket client that connects to the specified server URL. |
|
||||
| `fromSmartServe(smartServe, router)` | Creates a TypedSocket bound to an existing SmartServe instance. |
|
||||
| `useWindowLocationOriginUrl()` | Returns the current window location origin (browser only). |
|
||||
|
||||
#### Instance Properties
|
||||
|
||||
| Property | Description |
|
||||
|----------|-------------|
|
||||
| `side` | Whether this instance is a `'server'` or `'client'`. |
|
||||
| `typedrouter` | The TypedRouter instance handling requests. |
|
||||
| `eventSubject` | RxJS Subject for connection status events. |
|
||||
|
||||
#### Instance Methods
|
||||
|
||||
| Method | Description |
|
||||
|--------|-------------|
|
||||
| `createTypedRequest(method, targetConnection?)` | Creates a typed request for the specified method. |
|
||||
| `addTag(name, payload)` | Adds a tag to the client connection (client-side only). |
|
||||
| `findAllTargetConnections(filterFn)` | Finds all connections matching the filter (server-side only). |
|
||||
| `findTargetConnection(filterFn)` | Finds the first connection matching the filter (server-side only). |
|
||||
| `findAllTargetConnectionsByTag(key, payload?)` | Finds all connections with the specified tag. |
|
||||
| `findTargetConnectionByTag(key, payload?)` | Finds the first connection with the specified tag. |
|
||||
| `stop()` | Closes the WebSocket connection. |
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.
|
||||
|
||||
Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
Task Venture Capital GmbH
|
||||
Registered at District Court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
For any legal inquiries or further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@api.global/typedsocket',
|
||||
version: '3.0.1',
|
||||
version: '3.1.0',
|
||||
description: 'A library for creating typed WebSocket connections, supporting bi-directional communication with type safety.'
|
||||
}
|
||||
|
||||
@@ -5,6 +5,32 @@ const publicRolePass = 'publicRolePass';
|
||||
|
||||
export type TTypedSocketSide = 'server' | 'client';
|
||||
|
||||
/**
|
||||
* Wrapper for SmartServe's IWebSocketPeer to provide tag compatibility
|
||||
* SmartServe uses Set<string> for tags, while TypedSocket uses {id, payload} format
|
||||
*/
|
||||
export interface ISmartServeConnectionWrapper {
|
||||
peer: plugins.IWebSocketPeer;
|
||||
getTagById(tagId: string): Promise<{ id: string; payload: any } | undefined>;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a wrapper around IWebSocketPeer for tag compatibility
|
||||
*/
|
||||
function wrapSmartServePeer(peer: plugins.IWebSocketPeer): ISmartServeConnectionWrapper {
|
||||
const TAG_PREFIX = '__typedsocket_tag__';
|
||||
return {
|
||||
peer,
|
||||
async getTagById(tagId: string): Promise<{ id: string; payload: any } | undefined> {
|
||||
if (!peer.tags.has(tagId)) {
|
||||
return undefined;
|
||||
}
|
||||
const payload = peer.data.get(`${TAG_PREFIX}${tagId}`);
|
||||
return { id: tagId, payload };
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export class TypedSocket {
|
||||
// STATIC
|
||||
/**
|
||||
@@ -110,16 +136,108 @@ export class TypedSocket {
|
||||
return windowLocationResult;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a TypedSocket server from an existing SmartServe instance.
|
||||
* Use this when you want TypedSocket to work with SmartServe's WebSocket handling.
|
||||
*
|
||||
* @param smartServeArg - SmartServe instance with typedRouter configured in websocket options
|
||||
* @param typedRouterArg - TypedRouter for handling requests (must match SmartServe's typedRouter)
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* const typedRouter = new TypedRouter();
|
||||
* const smartServe = new SmartServe({
|
||||
* port: 3000,
|
||||
* websocket: {
|
||||
* typedRouter,
|
||||
* onConnectionOpen: (peer) => peer.tags.add('client')
|
||||
* }
|
||||
* });
|
||||
* await smartServe.start();
|
||||
* const typedSocket = TypedSocket.fromSmartServe(smartServe, typedRouter);
|
||||
* ```
|
||||
*/
|
||||
public static fromSmartServe(
|
||||
smartServeArg: plugins.SmartServe,
|
||||
typedRouterArg: plugins.typedrequest.TypedRouter
|
||||
): TypedSocket {
|
||||
const connectionWrappers = new Map<string, ISmartServeConnectionWrapper>();
|
||||
|
||||
// Create the postMethod for server-initiated requests
|
||||
const postMethod = async <T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||
dataArg: T,
|
||||
targetConnectionArg?: ISmartServeConnectionWrapper
|
||||
): Promise<T> => {
|
||||
if (!targetConnectionArg) {
|
||||
const allConnections = smartServeArg.getWebSocketConnections();
|
||||
if (allConnections.length === 1) {
|
||||
console.log(
|
||||
'Since no targetConnection was supplied and there is only one active one present, choosing that one automatically'
|
||||
);
|
||||
const peer = allConnections[0];
|
||||
let wrapper = connectionWrappers.get(peer.id);
|
||||
if (!wrapper) {
|
||||
wrapper = wrapSmartServePeer(peer);
|
||||
connectionWrappers.set(peer.id, wrapper);
|
||||
}
|
||||
targetConnectionArg = wrapper;
|
||||
} else if (allConnections.length === 0) {
|
||||
throw new Error('No WebSocket connections available');
|
||||
} else {
|
||||
throw new Error(
|
||||
'you need to specify the wanted targetConnection. Currently no target is selectable automatically.'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Register interest for the response using correlation ID
|
||||
const interest = await typedRouterArg.fireEventInterestMap.addInterest(
|
||||
dataArg.correlation.id,
|
||||
dataArg
|
||||
);
|
||||
|
||||
// Send the request to the client
|
||||
targetConnectionArg.peer.send(plugins.smartjson.stringify(dataArg));
|
||||
|
||||
// Wait for the response (TypedRouter will fulfill via routeAndAddResponse when response arrives)
|
||||
const response = await interest.interestFullfilled as T;
|
||||
return response;
|
||||
};
|
||||
|
||||
const typedSocket = new TypedSocket(
|
||||
'server',
|
||||
typedRouterArg,
|
||||
postMethod as any,
|
||||
null as any // No smartsocket server/client when using SmartServe
|
||||
);
|
||||
|
||||
typedSocket.smartServeRef = smartServeArg;
|
||||
typedSocket.smartServeConnectionWrappers = connectionWrappers;
|
||||
|
||||
return typedSocket;
|
||||
}
|
||||
|
||||
// INSTANCE
|
||||
public side: TTypedSocketSide;
|
||||
public typedrouter: plugins.typedrequest.TypedRouter;
|
||||
|
||||
// SmartServe mode properties
|
||||
private smartServeRef?: plugins.SmartServe;
|
||||
private smartServeConnectionWrappers: Map<string, ISmartServeConnectionWrapper> = new Map();
|
||||
|
||||
public get eventSubject(): plugins.smartrx.rxjs.Subject<plugins.smartsocket.TConnectionStatus> {
|
||||
if (this.smartServeRef) {
|
||||
// SmartServe doesn't provide an eventSubject, return a new Subject
|
||||
// In SmartServe mode, connection events are handled via onConnectionOpen/onConnectionClose hooks
|
||||
console.warn('eventSubject is not fully supported in SmartServe mode. Use SmartServe hooks instead.');
|
||||
return new plugins.smartrx.rxjs.Subject();
|
||||
}
|
||||
return this.socketServerOrClient.eventSubject;
|
||||
}
|
||||
private postMethod: plugins.typedrequest.IPostMethod &
|
||||
((
|
||||
typedRequestPostObject: plugins.typedrequestInterfaces.ITypedRequest,
|
||||
socketConnectionArg?: plugins.smartsocket.SocketConnection
|
||||
socketConnectionArg?: plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper
|
||||
) => Promise<plugins.typedrequestInterfaces.ITypedRequest>);
|
||||
private socketServerOrClient:
|
||||
| plugins.smartsocket.Smartsocket
|
||||
@@ -155,12 +273,12 @@ export class TypedSocket {
|
||||
|
||||
public createTypedRequest<T extends plugins.typedrequestInterfaces.ITypedRequest>(
|
||||
methodName: T['method'],
|
||||
targetConnection?: plugins.smartsocket.SocketConnection
|
||||
targetConnection?: plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper
|
||||
): plugins.typedrequest.TypedRequest<T> {
|
||||
const typedrequest = new plugins.typedrequest.TypedRequest<T>(
|
||||
new plugins.typedrequest.TypedTarget({
|
||||
postMethod: async (requestDataArg) => {
|
||||
const result = await this.postMethod(requestDataArg, targetConnection);
|
||||
const result = await this.postMethod(requestDataArg, targetConnection as any);
|
||||
return result;
|
||||
},
|
||||
}),
|
||||
@@ -170,13 +288,31 @@ export class TypedSocket {
|
||||
}
|
||||
|
||||
/**
|
||||
* returns all matching target connection
|
||||
* @param asyncFindFuncArg
|
||||
* @returns
|
||||
* returns all matching target connections
|
||||
* Works with both Smartsocket and SmartServe backends
|
||||
* @param asyncFindFuncArg - async filter function
|
||||
* @returns array of matching connections
|
||||
*/
|
||||
public async findAllTargetConnections(
|
||||
asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
|
||||
) {
|
||||
asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper) => Promise<boolean>
|
||||
): Promise<(plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper)[]> {
|
||||
// SmartServe mode
|
||||
if (this.smartServeRef) {
|
||||
const matchingConnections: ISmartServeConnectionWrapper[] = [];
|
||||
for (const peer of this.smartServeRef.getWebSocketConnections()) {
|
||||
let wrapper = this.smartServeConnectionWrappers.get(peer.id);
|
||||
if (!wrapper) {
|
||||
wrapper = wrapSmartServePeer(peer);
|
||||
this.smartServeConnectionWrappers.set(peer.id, wrapper);
|
||||
}
|
||||
if (await asyncFindFuncArg(wrapper)) {
|
||||
matchingConnections.push(wrapper);
|
||||
}
|
||||
}
|
||||
return matchingConnections;
|
||||
}
|
||||
|
||||
// Smartsocket mode
|
||||
if (this.socketServerOrClient instanceof plugins.smartsocket.Smartsocket) {
|
||||
const matchingSockets: plugins.smartsocket.SocketConnection[] = [];
|
||||
for (const socketConnection of this.socketServerOrClient.socketConnections.getArray()) {
|
||||
@@ -185,9 +321,9 @@ export class TypedSocket {
|
||||
}
|
||||
}
|
||||
return matchingSockets;
|
||||
} else {
|
||||
throw new Error('this method >>findTargetConnection<< is only available from the server');
|
||||
}
|
||||
|
||||
throw new Error('this method >>findTargetConnection<< is only available from the server');
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -196,22 +332,51 @@ export class TypedSocket {
|
||||
* @returns
|
||||
*/
|
||||
public async findTargetConnection(
|
||||
asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection) => Promise<boolean>
|
||||
) {
|
||||
asyncFindFuncArg: (connectionArg: plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper) => Promise<boolean>
|
||||
): Promise<plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper | undefined> {
|
||||
const allMatching = await this.findAllTargetConnections(asyncFindFuncArg);
|
||||
return allMatching[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Find all connections that have a specific tag
|
||||
* Works with both Smartsocket and SmartServe backends
|
||||
*/
|
||||
public async findAllTargetConnectionsByTag<
|
||||
TTag extends plugins.typedrequestInterfaces.ITag = any
|
||||
>(keyArg: TTag['name'], payloadArg?: TTag['payload']) {
|
||||
>(keyArg: TTag['name'], payloadArg?: TTag['payload']): Promise<(plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper)[]> {
|
||||
// SmartServe mode - use native filtering for better performance
|
||||
if (this.smartServeRef) {
|
||||
const peers = this.smartServeRef.getWebSocketConnectionsByTag(keyArg);
|
||||
const results: ISmartServeConnectionWrapper[] = [];
|
||||
|
||||
for (const peer of peers) {
|
||||
let wrapper = this.smartServeConnectionWrappers.get(peer.id);
|
||||
if (!wrapper) {
|
||||
wrapper = wrapSmartServePeer(peer);
|
||||
this.smartServeConnectionWrappers.set(peer.id, wrapper);
|
||||
}
|
||||
|
||||
// If payload specified, also filter by payload stored in peer.data
|
||||
if (payloadArg !== undefined) {
|
||||
const tag = await wrapper.getTagById(keyArg);
|
||||
if (plugins.smartjson.stringify(tag?.payload) !== plugins.smartjson.stringify(payloadArg)) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
results.push(wrapper);
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
// Smartsocket mode - use existing logic
|
||||
return this.findAllTargetConnections(async (socketConnectionArg) => {
|
||||
let result: boolean;
|
||||
if (!payloadArg) {
|
||||
result = !!(await socketConnectionArg.getTagById(keyArg));
|
||||
result = !!(await (socketConnectionArg as plugins.smartsocket.SocketConnection).getTagById(keyArg));
|
||||
} else {
|
||||
result = !!(
|
||||
plugins.smartjson.stringify((await socketConnectionArg.getTagById(keyArg))?.payload) ===
|
||||
plugins.smartjson.stringify((await (socketConnectionArg as plugins.smartsocket.SocketConnection).getTagById(keyArg))?.payload) ===
|
||||
plugins.smartjson.stringify(payloadArg)
|
||||
);
|
||||
}
|
||||
@@ -219,15 +384,28 @@ export class TypedSocket {
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Find a single connection by tag
|
||||
*/
|
||||
public async findTargetConnectionByTag<TTag extends plugins.typedrequestInterfaces.ITag = any>(
|
||||
keyArg: TTag['name'],
|
||||
payloadArg?: TTag['payload']
|
||||
) {
|
||||
): Promise<plugins.smartsocket.SocketConnection | ISmartServeConnectionWrapper | undefined> {
|
||||
const allResults = await this.findAllTargetConnectionsByTag(keyArg, payloadArg);
|
||||
return allResults[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop the TypedSocket server/client
|
||||
* Note: In SmartServe mode, SmartServe manages its own lifecycle
|
||||
*/
|
||||
public async stop() {
|
||||
if (this.smartServeRef) {
|
||||
// SmartServe manages its own lifecycle
|
||||
// Clear our connection wrappers
|
||||
this.smartServeConnectionWrappers.clear();
|
||||
return;
|
||||
}
|
||||
await this.socketServerOrClient.stop();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -13,3 +13,6 @@ import * as smartstring from '@push.rocks/smartstring';
|
||||
import * as smarturl from '@push.rocks/smarturl';
|
||||
|
||||
export { isohash, smartjson, smartrx, smartsocket, smartstring, smarturl };
|
||||
|
||||
// Optional SmartServe support (type-only imports for optional peer dependency)
|
||||
export type { SmartServe, IWebSocketPeer } from '@push.rocks/smartserve';
|
||||
|
||||
Reference in New Issue
Block a user