@socket-mesh/core 1.0.3 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/socket.d.ts CHANGED
@@ -1,38 +1,43 @@
1
- import { CodecEngine } from "@socket-mesh/formatter";
2
- import { AnyPacket } from "./packet.js";
3
- import { AsyncStreamEmitter } from "@socket-mesh/async-stream-emitter";
4
- import { SocketEvent, AuthenticateEvent, BadAuthTokenEvent, CloseEvent, ConnectEvent, DisconnectEvent, ErrorEvent, MessageEvent, PingEvent, PongEvent, RequestEvent, ResponseEvent, AuthStateChangeEvent, RemoveAuthTokenEvent, ConnectingEvent, DeauthenticateEvent } from "./socket-event.js";
5
- import { FunctionReturnType, MethodMap, PrivateMethodMap, PublicMethodMap, ServiceMap } from "./maps/method-map.js";
6
- import { HandlerMap } from "./maps/handler-map.js";
7
- import { CallIdGenerator, InvokeMethodOptions, InvokeServiceOptions, SocketTransport } from "./socket-transport.js";
8
- import { DemuxedConsumableStream, StreamEvent } from "@socket-mesh/stream-demux";
9
- import { AuthToken, SignedAuthToken } from "@socket-mesh/auth";
10
- import { Plugin } from "./plugins/plugin.js";
11
- export type StreamCleanupMode = 'kill' | 'close' | 'none';
12
- export interface SocketOptions<TIncoming extends MethodMap, TOutgoing extends PublicMethodMap, TPrivateOutgoing extends PrivateMethodMap, TService extends ServiceMap, TState extends object, TSocket extends Socket<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState> = Socket<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>> {
1
+ import { AsyncStreamEmitter } from '@socket-mesh/async-stream-emitter';
2
+ import { AuthToken, SignedAuthToken } from '@socket-mesh/auth';
3
+ import { CodecEngine } from '@socket-mesh/formatter';
4
+ import { DemuxedConsumableStream, StreamEvent } from '@socket-mesh/stream-demux';
5
+ import { FunctionReturnType, PrivateMethodMap, PublicMethodMap, ServiceMap, ServiceMethodName, ServiceName } from './maps/method-map.js';
6
+ import { AnyPlugin } from './plugins/plugin.js';
7
+ import { LooseHandlerMap } from './request-handler.js';
8
+ import { AuthenticateEvent, AuthStateChangeEvent, BadAuthTokenEvent, CloseEvent, ConnectEvent, ConnectingEvent, DeauthenticateEvent, DisconnectEvent, ErrorEvent, MessageEvent, PingEvent, PongEvent, RemoveAuthTokenEvent, RequestEvent, ResponseEvent, SocketEvent, TypedRequestEvent, TypedResponseEvent } from './socket-event.js';
9
+ import { BaseSocketTransport, CallIdGenerator, InvokeMethodOptions, InvokeServiceOptions } from './socket-transport.js';
10
+ export interface BaseSocketOptions<TState extends object = {}> {
13
11
  ackTimeoutMs?: number;
14
12
  callIdGenerator?: CallIdGenerator;
15
13
  codecEngine?: CodecEngine;
16
- handlers?: HandlerMap<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>;
14
+ handlers?: LooseHandlerMap;
17
15
  isPingTimeoutDisabled?: boolean;
18
- plugins?: Plugin<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>[];
19
- onUnhandledRequest?: (socket: TSocket, packet: AnyPacket<TIncoming, TService>) => boolean;
16
+ plugins?: AnyPlugin[];
20
17
  state?: Partial<TState>;
21
18
  streamCleanupMode?: StreamCleanupMode;
22
19
  }
23
- export type SocketStatus = 'connecting' | 'ready' | 'closing' | 'closed';
24
- export declare class Socket<TIncoming extends MethodMap, TOutgoing extends PublicMethodMap, TPrivateOutgoing extends PrivateMethodMap, TService extends ServiceMap, TState extends object> extends AsyncStreamEmitter<SocketEvent<TIncoming, TOutgoing, TPrivateOutgoing, TService>> {
20
+ export type Socket<TIncoming extends PublicMethodMap = {}, TOutgoing extends PublicMethodMap = {}, TState extends object = {}, TService extends ServiceMap = {}, TPrivateIncoming extends PrivateMethodMap = {}, TPrivateOutgoing extends PrivateMethodMap = {}> = Omit<BaseSocket<TState>, 'invoke' | 'listen' | 'transmit'> & {
21
+ invoke<TMethod extends keyof TOutgoing & string>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<FunctionReturnType<TOutgoing[TMethod]>>;
22
+ invoke<TMethod extends keyof TOutgoing & string>(options: InvokeMethodOptions<TOutgoing, TMethod>, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<FunctionReturnType<TOutgoing[TMethod]>>;
23
+ invoke<TServiceName extends ServiceName<TService>, TMethod extends ServiceMethodName<TService, TServiceName>>(options: [TServiceName, TMethod, (false | number)?], arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<FunctionReturnType<TService[TServiceName][TMethod]>>;
24
+ invoke<TServiceName extends ServiceName<TService>, TMethod extends ServiceMethodName<TService, TServiceName>>(options: InvokeServiceOptions<TService, TServiceName, TMethod>, arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<FunctionReturnType<TService[TServiceName][TMethod]>>;
25
+ invoke<TMethod extends keyof TPrivateOutgoing & string>(method: TMethod, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): Promise<FunctionReturnType<TPrivateOutgoing[TMethod]>>;
26
+ listen(event: 'request'): DemuxedConsumableStream<TypedRequestEvent<TIncoming & TPrivateIncoming, TService>>;
27
+ listen(event: 'response'): DemuxedConsumableStream<TypedResponseEvent<TOutgoing, TPrivateOutgoing, TService>>;
28
+ transmit<TMethod extends keyof TOutgoing & string>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<void>;
29
+ transmit<TServiceName extends ServiceName<TService>, TMethod extends ServiceMethodName<TService, TServiceName>>(options: [TServiceName, TMethod], arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<void>;
30
+ transmit<TMethod extends keyof TPrivateOutgoing & string>(method: TMethod, arg?: Parameters<TPrivateOutgoing[TMethod]>[0]): Promise<void>;
31
+ };
32
+ export type SocketStatus = 'closed' | 'closing' | 'connecting' | 'ready';
33
+ export type StreamCleanupMode = 'close' | 'kill' | 'none';
34
+ export declare class BaseSocket<TState extends object = {}> extends AsyncStreamEmitter<SocketEvent | undefined> {
25
35
  private readonly _transport;
26
36
  readonly state: Partial<TState>;
27
- protected constructor(transport: SocketTransport<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>, options?: SocketOptions<TIncoming, TOutgoing, TPrivateOutgoing, TService, TState>);
28
- get id(): string;
29
- get authToken(): AuthToken;
30
- get signedAuthToken(): SignedAuthToken;
37
+ protected constructor(transport: BaseSocketTransport<TState>, options?: BaseSocketOptions<TState>);
38
+ get authToken(): AuthToken | null;
31
39
  deauthenticate(): Promise<boolean>;
32
40
  disconnect(code?: number, reason?: string): void;
33
- getBackpressure(): number;
34
- getInboundBackpressure(): number;
35
- getOutboundBackpressure(): number;
36
41
  emit(event: 'authStateChange', data: AuthStateChangeEvent): void;
37
42
  emit(event: 'authenticate', data: AuthenticateEvent): void;
38
43
  emit(event: 'badAuthToken', data: BadAuthTokenEvent): void;
@@ -48,9 +53,14 @@ export declare class Socket<TIncoming extends MethodMap, TOutgoing extends Publi
48
53
  emit(event: 'ping', data: PingEvent): void;
49
54
  emit(event: 'pong', data: PongEvent): void;
50
55
  emit(event: 'removeAuthToken', data: RemoveAuthTokenEvent): void;
51
- emit(event: 'request', data: RequestEvent<TIncoming, TService>): void;
52
- emit(event: 'response', data: ResponseEvent<TOutgoing, TPrivateOutgoing, TService>): void;
53
- listen(): DemuxedConsumableStream<StreamEvent<SocketEvent<TIncoming, TOutgoing, TPrivateOutgoing, TService>>>;
56
+ emit(event: 'request', data: RequestEvent): void;
57
+ emit(event: 'response', data: ResponseEvent): void;
58
+ getBackpressure(): number;
59
+ getInboundBackpressure(): number;
60
+ getOutboundBackpressure(): number;
61
+ get id(): null | string;
62
+ invoke(methodOptions: [string, string, (false | number)?] | InvokeMethodOptions | InvokeServiceOptions | string, arg?: unknown): Promise<unknown>;
63
+ listen(): DemuxedConsumableStream<StreamEvent<SocketEvent>>;
54
64
  listen(event: 'authStateChange'): DemuxedConsumableStream<AuthStateChangeEvent>;
55
65
  listen(event: 'authenticate'): DemuxedConsumableStream<AuthenticateEvent>;
56
66
  listen(event: 'badAuthToken'): DemuxedConsumableStream<BadAuthTokenEvent>;
@@ -58,7 +68,7 @@ export declare class Socket<TIncoming extends MethodMap, TOutgoing extends Publi
58
68
  listen(event: 'connect'): DemuxedConsumableStream<ConnectEvent>;
59
69
  listen(event: 'connectAbort'): DemuxedConsumableStream<DisconnectEvent>;
60
70
  listen(event: 'connecting'): DemuxedConsumableStream<ConnectingEvent>;
61
- listen(event: 'deauthenticate'): DemuxedConsumableStream<AuthenticateEvent>;
71
+ listen(event: 'deauthenticate'): DemuxedConsumableStream<DeauthenticateEvent>;
62
72
  listen(event: 'disconnect'): DemuxedConsumableStream<DisconnectEvent>;
63
73
  listen(event: 'end'): DemuxedConsumableStream<void>;
64
74
  listen(event: 'error'): DemuxedConsumableStream<ErrorEvent>;
@@ -66,15 +76,11 @@ export declare class Socket<TIncoming extends MethodMap, TOutgoing extends Publi
66
76
  listen(event: 'ping'): DemuxedConsumableStream<PingEvent>;
67
77
  listen(event: 'pong'): DemuxedConsumableStream<PongEvent>;
68
78
  listen(event: 'removeAuthToken'): DemuxedConsumableStream<RemoveAuthTokenEvent>;
69
- listen(event: 'request'): DemuxedConsumableStream<RequestEvent<TIncoming, TService>>;
70
- listen(event: 'response'): DemuxedConsumableStream<ResponseEvent<TOutgoing, TPrivateOutgoing, TService>>;
71
- listen<U extends SocketEvent<TIncoming, TOutgoing, TPrivateOutgoing, TService>, V = U>(event: string): DemuxedConsumableStream<V>;
79
+ listen(event: 'request'): DemuxedConsumableStream<RequestEvent>;
80
+ listen(event: 'response'): DemuxedConsumableStream<ResponseEvent>;
81
+ listen<U extends SocketEvent, V = U>(event: string): DemuxedConsumableStream<V>;
82
+ get signedAuthToken(): null | SignedAuthToken;
72
83
  get status(): SocketStatus;
84
+ transmit(serviceAndMethod: [string, string] | string, arg?: unknown): Promise<void>;
73
85
  get url(): string;
74
- transmit<TMethod extends keyof TOutgoing>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<void>;
75
- transmit<TServiceName extends keyof TService, TMethod extends keyof TService[TServiceName]>(options: [TServiceName, TMethod], arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<void>;
76
- invoke<TMethod extends keyof TOutgoing>(method: TMethod, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<FunctionReturnType<TOutgoing[TMethod]>>;
77
- invoke<TServiceName extends keyof TService, TMethod extends keyof TService[TServiceName]>(options: [TServiceName, TMethod, (number | false)?], arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<FunctionReturnType<TService[TServiceName][TMethod]>>;
78
- invoke<TServiceName extends keyof TService, TMethod extends keyof TService[TServiceName]>(options: InvokeServiceOptions<TService, TServiceName, TMethod>, arg?: Parameters<TService[TServiceName][TMethod]>[0]): Promise<FunctionReturnType<TService[TServiceName][TMethod]>>;
79
- invoke<TMethod extends keyof TOutgoing>(options: InvokeMethodOptions<TOutgoing, TMethod>, arg?: Parameters<TOutgoing[TMethod]>[0]): Promise<FunctionReturnType<TOutgoing[TMethod]>>;
80
86
  }
package/dist/socket.js CHANGED
@@ -1,28 +1,30 @@
1
- import { AsyncStreamEmitter } from "@socket-mesh/async-stream-emitter";
2
- export class Socket extends AsyncStreamEmitter {
1
+ import { AsyncStreamEmitter } from '@socket-mesh/async-stream-emitter';
2
+ export class BaseSocket extends AsyncStreamEmitter {
3
+ _transport;
4
+ state;
3
5
  constructor(transport, options) {
4
6
  super();
5
7
  this.state = options?.state || {};
6
8
  transport.socket = this;
7
9
  this._transport = transport;
8
10
  }
9
- get id() {
10
- return this._transport.id;
11
- }
12
11
  get authToken() {
13
12
  return this._transport.authToken;
14
13
  }
15
- get signedAuthToken() {
16
- return this._transport.signedAuthToken;
17
- }
18
14
  deauthenticate() {
19
15
  return this._transport.changeToUnauthenticatedState();
20
16
  }
21
17
  disconnect(code = 1000, reason) {
22
18
  this._transport.disconnect(code, reason);
23
19
  }
20
+ emit(event, data) {
21
+ super.emit(event, data);
22
+ }
24
23
  getBackpressure() {
25
- return Math.max(this._transport.getBackpressure(), this.getListenerBackpressure());
24
+ return Math.max(this._transport.getBackpressure(), this.getListenerBackpressure()
25
+ // this.receiver.getBackpressure(),
26
+ // this.procedure.getBackpressure()
27
+ );
26
28
  }
27
29
  getInboundBackpressure() {
28
30
  return this._transport.getInboundBackpressure();
@@ -30,22 +32,25 @@ export class Socket extends AsyncStreamEmitter {
30
32
  getOutboundBackpressure() {
31
33
  return this._transport.getOutboundBackpressure();
32
34
  }
33
- emit(event, data) {
34
- super.emit(event, data);
35
+ get id() {
36
+ return this._transport.id;
37
+ }
38
+ invoke(methodOptions, arg) {
39
+ return this._transport.invoke(methodOptions, arg)[0];
35
40
  }
36
41
  listen(event) {
37
- return super.listen(event);
42
+ return super.listen(event ?? '');
43
+ }
44
+ get signedAuthToken() {
45
+ return this._transport.signedAuthToken;
38
46
  }
39
47
  get status() {
40
48
  return this._transport.status;
41
49
  }
42
- get url() {
43
- return this._transport.url;
44
- }
45
50
  transmit(serviceAndMethod, arg) {
46
51
  return this._transport.transmit(serviceAndMethod, arg);
47
52
  }
48
- invoke(methodOptions, arg) {
49
- return this._transport.invoke(methodOptions, arg)[0];
53
+ get url() {
54
+ return this._transport.url;
50
55
  }
51
56
  }
package/dist/utils.d.ts CHANGED
@@ -1,2 +1,3 @@
1
- export declare function wait(duration: number): Promise<void>;
2
1
  export declare function toArray<T>(arr: T | T[]): T[];
2
+ export declare function toError(err: unknown): Error;
3
+ export declare function wait(duration: number): Promise<void>;
package/dist/utils.js CHANGED
@@ -1,3 +1,9 @@
1
+ export function toArray(arr) {
2
+ return Array.isArray(arr) ? arr : [arr];
3
+ }
4
+ export function toError(err) {
5
+ return err instanceof Error ? err : new Error(String(err));
6
+ }
1
7
  export function wait(duration) {
2
8
  return new Promise((resolve) => {
3
9
  setTimeout(() => {
@@ -5,6 +11,3 @@ export function wait(duration) {
5
11
  }, duration);
6
12
  });
7
13
  }
8
- export function toArray(arr) {
9
- return Array.isArray(arr) ? arr : [arr];
10
- }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@socket-mesh/core",
3
- "version": "1.0.3",
3
+ "version": "2.0.0",
4
4
  "description": "Core module for SocketMesh Server",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -8,8 +8,10 @@
8
8
  "files": ["./dist"],
9
9
  "scripts": {
10
10
  "build": "node ../../scripts/build.mjs && tsc --project tsconfig.build.json",
11
- "deploy": "npm run build && node ../../scripts/publish.mjs",
12
- "test": "cross-env node --test --loader ts-node/esm test/index.spec.ts"
11
+ "deploy": "node ../../scripts/publish.mjs",
12
+ "lint": "eslint . --c ../../eslint.config.mjs",
13
+ "lint:fix": "eslint . --c ../../eslint.config.mjs --fix",
14
+ "test": "tsx --tsconfig ./tsconfig.build.json --test ./src/**/*.{spec,test}.ts ./test/**/*.{spec,test}.ts"
13
15
  },
14
16
  "keywords": [
15
17
  "auth",
@@ -27,16 +29,17 @@
27
29
  "url": "https://github.com/socket-mesh/client-server/labels/core"
28
30
  },
29
31
  "devDependencies": {
30
- "@types/base64id": "^2.0.2",
31
- "@types/ws": "^8.5.11"
32
+ "@socket-mesh/typescript-config": "workspace:^",
33
+ "@types/base64id": "catalog:base64id",
34
+ "@types/ws": "catalog:ws"
32
35
  },
33
36
  "dependencies": {
34
- "@socket-mesh/async-stream-emitter": "^7.1.2",
35
- "@socket-mesh/auth": "^2.2.0",
36
- "@socket-mesh/errors": "^3.2.0",
37
- "@socket-mesh/formatter": "^4.1.0",
38
- "@socket-mesh/stream-demux": "^10.1.5",
39
- "isomorphic-ws": "^5.0.0",
40
- "ws": "^8.18.0"
37
+ "@socket-mesh/async-stream-emitter": "workspace:^",
38
+ "@socket-mesh/auth": "workspace:^",
39
+ "@socket-mesh/errors": "workspace:^",
40
+ "@socket-mesh/formatter": "workspace:^",
41
+ "@socket-mesh/stream-demux": "workspace:^",
42
+ "isomorphic-ws": "catalog:ws",
43
+ "ws": "catalog:ws"
41
44
  }
42
45
  }