@pluv/platform-node 5.0.1 → 5.0.3
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/index.d.mts +126 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.mjs +233 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +10 -10
- package/CHANGELOG.md +0 -1893
- package/eslint.config.mjs +0 -4
- package/src/NodePlatform.ts +0 -151
- package/src/NodeWebSocket.ts +0 -144
- package/src/index.ts +0 -9
- package/src/infer.ts +0 -9
- package/src/platformNode.ts +0 -61
- package/src/types.ts +0 -5
- package/src/utils/identity.ts +0 -1
- package/src/utils/index.ts +0 -3
- package/src/utils/toRequest.ts +0 -69
- package/tsconfig.json +0 -8
- package/tsdown.config.ts +0 -14
package/eslint.config.mjs
DELETED
package/src/NodePlatform.ts
DELETED
|
@@ -1,151 +0,0 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
AbstractPersistence,
|
|
3
|
-
AbstractPlatformConfig,
|
|
4
|
-
AbstractPubSub,
|
|
5
|
-
ConvertWebSocketConfig,
|
|
6
|
-
WebSocketRegistrationMode,
|
|
7
|
-
WebSocketSerializedState,
|
|
8
|
-
} from "@pluv/io";
|
|
9
|
-
import { AbstractPlatform } from "@pluv/io";
|
|
10
|
-
import type { IOAuthorize, Json } from "@pluv/types";
|
|
11
|
-
import crypto from "node:crypto";
|
|
12
|
-
import { TextDecoder } from "node:util";
|
|
13
|
-
import type { WebSocket } from "ws";
|
|
14
|
-
import { NodeWebSocket } from "./NodeWebSocket";
|
|
15
|
-
import type { NodeRegisterInput } from "./types";
|
|
16
|
-
|
|
17
|
-
export type NodePlatformRoomContext<TMeta extends Record<string, Json>> = keyof TMeta extends never
|
|
18
|
-
? { meta?: undefined }
|
|
19
|
-
: { meta: TMeta };
|
|
20
|
-
|
|
21
|
-
export type NodePlatformConfig<TMeta extends Record<string, Json>> = {
|
|
22
|
-
mode?: WebSocketRegistrationMode;
|
|
23
|
-
origin?: string;
|
|
24
|
-
} & (
|
|
25
|
-
| { persistence?: undefined; pubSub?: undefined }
|
|
26
|
-
| { persistence: AbstractPersistence; pubSub: AbstractPubSub }
|
|
27
|
-
) & { roomContext?: NodePlatformRoomContext<TMeta> };
|
|
28
|
-
|
|
29
|
-
export class NodePlatform<
|
|
30
|
-
TAuthorize extends IOAuthorize<any, any> | null = null,
|
|
31
|
-
TMeta extends Record<string, Json> = {},
|
|
32
|
-
> extends AbstractPlatform<
|
|
33
|
-
NodeWebSocket<TAuthorize>,
|
|
34
|
-
NodeRegisterInput,
|
|
35
|
-
NodePlatformRoomContext<TMeta>,
|
|
36
|
-
{
|
|
37
|
-
authorize: {
|
|
38
|
-
secret: true;
|
|
39
|
-
};
|
|
40
|
-
handleMode: "io";
|
|
41
|
-
requireAuth: false;
|
|
42
|
-
registrationMode: WebSocketRegistrationMode;
|
|
43
|
-
listeners: {
|
|
44
|
-
onRoomDestroyed: true;
|
|
45
|
-
onRoomMessage: true;
|
|
46
|
-
onStorageDestroyed: true;
|
|
47
|
-
onStorageUpdated: true;
|
|
48
|
-
onUserConnected: true;
|
|
49
|
-
onUserDisconnected: true;
|
|
50
|
-
};
|
|
51
|
-
router: true;
|
|
52
|
-
}
|
|
53
|
-
> {
|
|
54
|
-
public readonly id = crypto.randomUUID();
|
|
55
|
-
public readonly _config;
|
|
56
|
-
public readonly _name = "platformNode";
|
|
57
|
-
public readonly origin: string | undefined;
|
|
58
|
-
|
|
59
|
-
constructor(config: NodePlatformConfig<TMeta> = {}) {
|
|
60
|
-
const { origin, roomContext, mode = "attached", persistence, pubSub } = config;
|
|
61
|
-
|
|
62
|
-
super({
|
|
63
|
-
roomContext,
|
|
64
|
-
...(persistence && pubSub ? { persistence, pubSub } : {}),
|
|
65
|
-
});
|
|
66
|
-
|
|
67
|
-
this.origin = origin;
|
|
68
|
-
|
|
69
|
-
this._config = {
|
|
70
|
-
authorize: {
|
|
71
|
-
secret: true as const,
|
|
72
|
-
},
|
|
73
|
-
handleMode: "io" as const,
|
|
74
|
-
registrationMode: mode,
|
|
75
|
-
requireAuth: false as const,
|
|
76
|
-
listeners: {
|
|
77
|
-
onRoomDestroyed: true as const,
|
|
78
|
-
onRoomMessage: true as const,
|
|
79
|
-
onStorageDestroyed: true as const,
|
|
80
|
-
onStorageUpdated: true as const,
|
|
81
|
-
onUserConnected: true as const,
|
|
82
|
-
onUserDisconnected: true as const,
|
|
83
|
-
},
|
|
84
|
-
router: true as const,
|
|
85
|
-
};
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
public acceptWebSocket(webSocket: NodeWebSocket<TAuthorize>): Promise<void> {
|
|
89
|
-
return Promise.resolve(undefined);
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
public convertWebSocket(
|
|
93
|
-
webSocket: WebSocket,
|
|
94
|
-
config: ConvertWebSocketConfig,
|
|
95
|
-
): NodeWebSocket<TAuthorize> {
|
|
96
|
-
const { room } = config;
|
|
97
|
-
|
|
98
|
-
return new NodeWebSocket<TAuthorize>(webSocket, {
|
|
99
|
-
persistence: this.persistence,
|
|
100
|
-
platform: this,
|
|
101
|
-
room,
|
|
102
|
-
});
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
public getLastPing(webSocket: NodeWebSocket<TAuthorize>): number | null {
|
|
106
|
-
return null;
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
public getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null {
|
|
110
|
-
return null;
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
public getSessionId(webSocket: WebSocket): string | null {
|
|
114
|
-
return null;
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
public getWebSockets(): readonly WebSocket[] {
|
|
118
|
-
return [];
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
public initialize(config: AbstractPlatformConfig<NodePlatformRoomContext<TMeta>>): this {
|
|
122
|
-
return new NodePlatform({
|
|
123
|
-
mode: this._config.registrationMode,
|
|
124
|
-
origin: this.origin,
|
|
125
|
-
persistence: this.persistence.initialize(config.roomContext),
|
|
126
|
-
pubSub: this.pubSub,
|
|
127
|
-
roomContext: config.roomContext,
|
|
128
|
-
} as NodePlatformConfig<TMeta>)._initialize() as this;
|
|
129
|
-
}
|
|
130
|
-
|
|
131
|
-
public parseData(data: string | ArrayBuffer): Record<string, any> {
|
|
132
|
-
if (typeof data === "string") return JSON.parse(data);
|
|
133
|
-
|
|
134
|
-
const decoder = new TextDecoder("utf8");
|
|
135
|
-
|
|
136
|
-
return JSON.parse(decoder.decode(data));
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
public randomUUID(): string {
|
|
140
|
-
return crypto.randomUUID();
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
public setSerializedState(
|
|
144
|
-
webSocket: NodeWebSocket<TAuthorize>,
|
|
145
|
-
state: WebSocketSerializedState,
|
|
146
|
-
): WebSocketSerializedState {
|
|
147
|
-
webSocket.state = state;
|
|
148
|
-
|
|
149
|
-
return webSocket.state;
|
|
150
|
-
}
|
|
151
|
-
}
|
package/src/NodeWebSocket.ts
DELETED
|
@@ -1,144 +0,0 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
AbstractCloseEvent,
|
|
3
|
-
AbstractErrorEvent,
|
|
4
|
-
AbstractEventMap,
|
|
5
|
-
AbstractListener,
|
|
6
|
-
AbstractMessageEvent,
|
|
7
|
-
AbstractWebSocketConfig,
|
|
8
|
-
WebSocketSerializedState,
|
|
9
|
-
WebSocketSession,
|
|
10
|
-
} from "@pluv/io";
|
|
11
|
-
import { AbstractWebSocket } from "@pluv/io";
|
|
12
|
-
import type { InferIOAuthorizeUser, IOAuthorize, JsonObject } from "@pluv/types";
|
|
13
|
-
import crypto from "node:crypto";
|
|
14
|
-
import type { WebSocket } from "ws";
|
|
15
|
-
|
|
16
|
-
export interface NodeWebSocketEventMap {
|
|
17
|
-
close: AbstractCloseEvent;
|
|
18
|
-
message: AbstractMessageEvent;
|
|
19
|
-
error: AbstractErrorEvent;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
export type NodeWebSocketConfig = AbstractWebSocketConfig;
|
|
23
|
-
|
|
24
|
-
export class NodeWebSocket<
|
|
25
|
-
TAuthorize extends IOAuthorize<any, any> | null = null,
|
|
26
|
-
> extends AbstractWebSocket<WebSocket> {
|
|
27
|
-
private _sessionId: string | null = null;
|
|
28
|
-
private _state: WebSocketSerializedState;
|
|
29
|
-
private _user: InferIOAuthorizeUser<TAuthorize> = null as InferIOAuthorizeUser<TAuthorize>;
|
|
30
|
-
|
|
31
|
-
public set presence(presence: JsonObject | null) {
|
|
32
|
-
this._state.presence = presence;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
public get readyState(): 0 | 1 | 2 | 3 {
|
|
36
|
-
return this.webSocket.readyState;
|
|
37
|
-
}
|
|
38
|
-
|
|
39
|
-
public get session(): WebSocketSession<TAuthorize> {
|
|
40
|
-
const sessionId = this.sessionId;
|
|
41
|
-
const state = this._state;
|
|
42
|
-
const user = this._user;
|
|
43
|
-
|
|
44
|
-
return {
|
|
45
|
-
...state,
|
|
46
|
-
id: sessionId,
|
|
47
|
-
user,
|
|
48
|
-
webSocket: this,
|
|
49
|
-
};
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
public get sessionId(): string {
|
|
53
|
-
if (this._sessionId) return this._sessionId;
|
|
54
|
-
|
|
55
|
-
const sessionId = this._sessionId ?? `p_${crypto.randomUUID()}`;
|
|
56
|
-
|
|
57
|
-
this._sessionId = sessionId;
|
|
58
|
-
|
|
59
|
-
return sessionId;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
public get state(): WebSocketSerializedState {
|
|
63
|
-
return this._state;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
public set state(state: WebSocketSerializedState) {
|
|
67
|
-
this._state = state;
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
public set user(user: InferIOAuthorizeUser<TAuthorize>) {
|
|
71
|
-
this._user = user;
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
constructor(webSocket: WebSocket, config: NodeWebSocketConfig) {
|
|
75
|
-
const { room } = config;
|
|
76
|
-
|
|
77
|
-
super(webSocket, config);
|
|
78
|
-
|
|
79
|
-
this._state = {
|
|
80
|
-
presence: null,
|
|
81
|
-
quit: false,
|
|
82
|
-
room,
|
|
83
|
-
timers: {
|
|
84
|
-
ping: new Date().getTime(),
|
|
85
|
-
presence: null,
|
|
86
|
-
},
|
|
87
|
-
};
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
public addEventListener<TType extends keyof AbstractEventMap>(
|
|
91
|
-
type: TType,
|
|
92
|
-
handler: AbstractListener<TType>,
|
|
93
|
-
): void {
|
|
94
|
-
switch (type) {
|
|
95
|
-
case "close":
|
|
96
|
-
this.webSocket.on("close", async (code, buffer) => {
|
|
97
|
-
const reason = buffer.toString("utf-8");
|
|
98
|
-
|
|
99
|
-
await Promise.resolve((handler as AbstractListener<"close">)({ code, reason }));
|
|
100
|
-
});
|
|
101
|
-
|
|
102
|
-
return;
|
|
103
|
-
case "error":
|
|
104
|
-
this.webSocket.on("error", async (error) => {
|
|
105
|
-
const message = error.message;
|
|
106
|
-
|
|
107
|
-
await Promise.resolve(
|
|
108
|
-
(handler as AbstractListener<"error">)({ error, message }),
|
|
109
|
-
);
|
|
110
|
-
});
|
|
111
|
-
|
|
112
|
-
return;
|
|
113
|
-
case "message":
|
|
114
|
-
this.webSocket.on("message", async (data) => {
|
|
115
|
-
await Promise.resolve((handler as AbstractListener<"message">)({ data }));
|
|
116
|
-
});
|
|
117
|
-
|
|
118
|
-
return;
|
|
119
|
-
default:
|
|
120
|
-
}
|
|
121
|
-
}
|
|
122
|
-
|
|
123
|
-
public close(code?: number | undefined, reason?: string | undefined): void {
|
|
124
|
-
const canClose = [this.CONNECTING, this.OPEN].some(
|
|
125
|
-
(readyState) => readyState === this.readyState,
|
|
126
|
-
);
|
|
127
|
-
|
|
128
|
-
if (!canClose) return;
|
|
129
|
-
|
|
130
|
-
this.webSocket.close(code, reason);
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
public send(message: string | ArrayBuffer | ArrayBufferView): void {
|
|
134
|
-
if (this.readyState !== this.OPEN) return;
|
|
135
|
-
|
|
136
|
-
this.webSocket.send(message, (error) => {
|
|
137
|
-
if (error) throw error;
|
|
138
|
-
});
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
public terminate(): void {
|
|
142
|
-
this.webSocket.terminate();
|
|
143
|
-
}
|
|
144
|
-
}
|
package/src/index.ts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
export type { WebSocket } from "ws";
|
|
2
|
-
export { infer } from "./infer";
|
|
3
|
-
export type { InferCallback } from "./infer";
|
|
4
|
-
export type { NodePlatform, NodePlatformConfig } from "./NodePlatform";
|
|
5
|
-
export { platformNode } from "./platformNode";
|
|
6
|
-
export type { PlatformNodeCreateIOParams } from "./platformNode";
|
|
7
|
-
export type { NodeAuthorizeContext, NodeRegisterInput } from "./types";
|
|
8
|
-
export { toRequest } from "./utils/toRequest";
|
|
9
|
-
export type { ToRequestOptions } from "./utils/toRequest";
|
package/src/infer.ts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import type { Json } from "@pluv/types";
|
|
2
|
-
import type { identity } from "./utils";
|
|
3
|
-
|
|
4
|
-
export type InferCallback<TMeta extends Record<string, Json> = {}> = (i: typeof identity) => {
|
|
5
|
-
meta?: (io: TMeta) => TMeta;
|
|
6
|
-
};
|
|
7
|
-
|
|
8
|
-
export const infer = <TMeta extends Record<string, Json> = {}>(callback: InferCallback<TMeta>) =>
|
|
9
|
-
callback;
|
package/src/platformNode.ts
DELETED
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
import type { CrdtLibraryType, NoopCrdtDocFactory } from "@pluv/crdt";
|
|
2
|
-
import type { CreateIOParams, PluvContext, PluvIOAuthorize } from "@pluv/io";
|
|
3
|
-
import type { BaseUser, Id, IOAuthorize, Json } from "@pluv/types";
|
|
4
|
-
import type { IncomingMessage } from "node:http";
|
|
5
|
-
import type { NodePlatformConfig } from "./NodePlatform";
|
|
6
|
-
import { NodePlatform } from "./NodePlatform";
|
|
7
|
-
import type { InferCallback } from "./infer";
|
|
8
|
-
import type { NodeAuthorizeContext } from "./types";
|
|
9
|
-
import { toRequest } from "./utils/toRequest";
|
|
10
|
-
|
|
11
|
-
export type PlatformNodeCreateIOParams<
|
|
12
|
-
TMeta extends Record<string, Json> = {},
|
|
13
|
-
TContext extends Record<string, any> = {},
|
|
14
|
-
TUser extends BaseUser | null = null,
|
|
15
|
-
TCrdt extends CrdtLibraryType<any> = CrdtLibraryType<NoopCrdtDocFactory>,
|
|
16
|
-
> = Id<
|
|
17
|
-
NodePlatformConfig<TMeta> &
|
|
18
|
-
Omit<
|
|
19
|
-
CreateIOParams<
|
|
20
|
-
NodePlatform<IOAuthorize<TUser, TContext>, TMeta>,
|
|
21
|
-
TContext,
|
|
22
|
-
TUser,
|
|
23
|
-
TCrdt
|
|
24
|
-
>,
|
|
25
|
-
"authorize" | "context" | "platform"
|
|
26
|
-
> & {
|
|
27
|
-
authorize?: PluvIOAuthorize<
|
|
28
|
-
NodePlatform<IOAuthorize<TUser, TContext>, TMeta>,
|
|
29
|
-
TUser,
|
|
30
|
-
NodeAuthorizeContext
|
|
31
|
-
>;
|
|
32
|
-
context?: PluvContext<NodePlatform<IOAuthorize<TUser, any>, TMeta>, TContext>;
|
|
33
|
-
types?: InferCallback<TMeta>;
|
|
34
|
-
}
|
|
35
|
-
>;
|
|
36
|
-
|
|
37
|
-
export const platformNode = <
|
|
38
|
-
TMeta extends Record<string, Json> = {},
|
|
39
|
-
TContext extends Record<string, any> = {},
|
|
40
|
-
TUser extends BaseUser | null = null,
|
|
41
|
-
TCrdt extends CrdtLibraryType<any> = CrdtLibraryType<NoopCrdtDocFactory>,
|
|
42
|
-
>(
|
|
43
|
-
config: PlatformNodeCreateIOParams<TMeta, TContext, TUser, TCrdt> = {},
|
|
44
|
-
): CreateIOParams<NodePlatform<IOAuthorize<TUser, TContext>, TMeta>, TContext, TUser, TCrdt> => {
|
|
45
|
-
const { authorize, context, crdt, debug, limits, origin } = config;
|
|
46
|
-
|
|
47
|
-
const resolvedAuthorize =
|
|
48
|
-
typeof authorize === "function"
|
|
49
|
-
? (input: { request: Request | IncomingMessage }) =>
|
|
50
|
-
authorize({ request: toRequest(input.request, { origin }) })
|
|
51
|
-
: authorize;
|
|
52
|
-
|
|
53
|
-
return {
|
|
54
|
-
authorize: resolvedAuthorize,
|
|
55
|
-
context,
|
|
56
|
-
crdt,
|
|
57
|
-
debug,
|
|
58
|
-
limits,
|
|
59
|
-
platform: () => new NodePlatform<IOAuthorize<TUser, TContext>, TMeta>(config),
|
|
60
|
-
};
|
|
61
|
-
};
|
package/src/types.ts
DELETED
package/src/utils/identity.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export const identity = <T extends unknown>(x: T): T => x;
|
package/src/utils/index.ts
DELETED
package/src/utils/toRequest.ts
DELETED
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
import type { IncomingMessage } from "node:http";
|
|
2
|
-
import { Readable } from "node:stream";
|
|
3
|
-
|
|
4
|
-
const getHeader = (incoming: IncomingMessage, name: string): string | undefined => {
|
|
5
|
-
const value = incoming.headers[name];
|
|
6
|
-
|
|
7
|
-
if (Array.isArray(value)) return value[0];
|
|
8
|
-
|
|
9
|
-
return value;
|
|
10
|
-
};
|
|
11
|
-
|
|
12
|
-
const inferOrigin = (incoming: IncomingMessage): string => {
|
|
13
|
-
const host =
|
|
14
|
-
getHeader(incoming, "x-forwarded-host") ?? getHeader(incoming, "host") ?? "localhost";
|
|
15
|
-
const forwardedProto = getHeader(incoming, "x-forwarded-proto");
|
|
16
|
-
const protocol =
|
|
17
|
-
forwardedProto ??
|
|
18
|
-
((incoming.socket as { encrypted?: boolean }).encrypted ? "https" : "http");
|
|
19
|
-
|
|
20
|
-
return `${protocol}://${host}`;
|
|
21
|
-
};
|
|
22
|
-
|
|
23
|
-
const toHeaders = (incoming: IncomingMessage): Headers => {
|
|
24
|
-
const headers = new Headers();
|
|
25
|
-
|
|
26
|
-
for (const [key, value] of Object.entries(incoming.headers)) {
|
|
27
|
-
if (value == null) continue;
|
|
28
|
-
|
|
29
|
-
if (Array.isArray(value)) {
|
|
30
|
-
for (const item of value) headers.append(key, item);
|
|
31
|
-
|
|
32
|
-
continue;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
headers.append(key, value);
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
return headers;
|
|
39
|
-
};
|
|
40
|
-
|
|
41
|
-
export type ToRequestOptions = {
|
|
42
|
-
origin?: string;
|
|
43
|
-
};
|
|
44
|
-
|
|
45
|
-
export const toRequest = (
|
|
46
|
-
request: Request | IncomingMessage,
|
|
47
|
-
options: ToRequestOptions = {},
|
|
48
|
-
): Request => {
|
|
49
|
-
if (request instanceof Request) return request;
|
|
50
|
-
|
|
51
|
-
const origin = options.origin ?? inferOrigin(request);
|
|
52
|
-
const url = new URL(request.url ?? "/", origin);
|
|
53
|
-
const method = request.method ?? "GET";
|
|
54
|
-
const headers = toHeaders(request);
|
|
55
|
-
|
|
56
|
-
if (method === "GET" || method === "HEAD") {
|
|
57
|
-
return new Request(url, {
|
|
58
|
-
headers,
|
|
59
|
-
method,
|
|
60
|
-
});
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
return new Request(url, {
|
|
64
|
-
body: Readable.toWeb(request) as ReadableStream,
|
|
65
|
-
duplex: "half",
|
|
66
|
-
headers,
|
|
67
|
-
method,
|
|
68
|
-
});
|
|
69
|
-
};
|
package/tsconfig.json
DELETED
package/tsdown.config.ts
DELETED