@mml-io/3d-web-experience-server 0.17.0 → 0.19.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.
|
@@ -2,7 +2,10 @@ import WebSocket from "ws";
|
|
|
2
2
|
export declare class MMLDocumentsServer {
|
|
3
3
|
private directory;
|
|
4
4
|
private documents;
|
|
5
|
-
|
|
5
|
+
private watcher;
|
|
6
|
+
private watchPattern;
|
|
7
|
+
constructor(directory: string, watchPattern: string);
|
|
8
|
+
dispose(): void;
|
|
6
9
|
handle(filename: string, ws: WebSocket): void;
|
|
7
10
|
private watch;
|
|
8
11
|
}
|
|
@@ -12,6 +12,7 @@ type UserAuthenticator = {
|
|
|
12
12
|
};
|
|
13
13
|
export declare const defaultSessionTokenPlaceholder = "SESSION.TOKEN.PLACEHOLDER";
|
|
14
14
|
export type Networked3dWebExperienceServerConfig = {
|
|
15
|
+
connectionLimit?: number;
|
|
15
16
|
networkPath: string;
|
|
16
17
|
webClientServing: {
|
|
17
18
|
indexUrl: string;
|
|
@@ -28,6 +29,7 @@ export type Networked3dWebExperienceServerConfig = {
|
|
|
28
29
|
};
|
|
29
30
|
mmlServing?: {
|
|
30
31
|
documentsWatchPath: string;
|
|
32
|
+
documentsDirectoryRoot: string;
|
|
31
33
|
documentsUrl: string;
|
|
32
34
|
};
|
|
33
35
|
userAuthenticator: UserAuthenticator;
|
|
@@ -39,6 +41,7 @@ export declare class Networked3dWebExperienceServer {
|
|
|
39
41
|
private mmlDocumentsServer?;
|
|
40
42
|
constructor(config: Networked3dWebExperienceServerConfig);
|
|
41
43
|
updateUserCharacter(clientId: number, userData: UserData): void;
|
|
44
|
+
dispose(errorMessage?: string): void;
|
|
42
45
|
registerExpressRoutes(app: enableWs.Application): void;
|
|
43
46
|
}
|
|
44
47
|
export {};
|
package/build/index.js
CHANGED
|
@@ -8,11 +8,19 @@ var getMmlDocumentContent = (documentPath) => {
|
|
|
8
8
|
return fs.readFileSync(documentPath, { encoding: "utf8", flag: "r" });
|
|
9
9
|
};
|
|
10
10
|
var MMLDocumentsServer = class {
|
|
11
|
-
constructor(directory) {
|
|
11
|
+
constructor(directory, watchPattern) {
|
|
12
12
|
this.directory = directory;
|
|
13
13
|
this.documents = /* @__PURE__ */ new Map();
|
|
14
|
+
this.watchPattern = path.resolve(directory, watchPattern);
|
|
14
15
|
this.watch();
|
|
15
16
|
}
|
|
17
|
+
dispose() {
|
|
18
|
+
for (const { document } of this.documents.values()) {
|
|
19
|
+
document.dispose();
|
|
20
|
+
}
|
|
21
|
+
this.documents.clear();
|
|
22
|
+
this.watcher.close();
|
|
23
|
+
}
|
|
16
24
|
handle(filename, ws) {
|
|
17
25
|
var _a;
|
|
18
26
|
const document = (_a = this.documents.get(filename)) == null ? void 0 : _a.document;
|
|
@@ -26,44 +34,44 @@ var MMLDocumentsServer = class {
|
|
|
26
34
|
});
|
|
27
35
|
}
|
|
28
36
|
watch() {
|
|
29
|
-
|
|
37
|
+
this.watcher = chokidar.watch(this.watchPattern, {
|
|
30
38
|
ignored: /^\./,
|
|
31
39
|
persistent: true
|
|
32
40
|
});
|
|
33
|
-
watcher.on("add", (
|
|
34
|
-
const
|
|
35
|
-
console.log(`
|
|
36
|
-
const contents = getMmlDocumentContent(
|
|
41
|
+
this.watcher.on("add", (fullPath) => {
|
|
42
|
+
const relativePath = path.relative(this.directory, fullPath);
|
|
43
|
+
console.log(`MML Document '${relativePath}' has been added`);
|
|
44
|
+
const contents = getMmlDocumentContent(fullPath);
|
|
37
45
|
const document = new EditableNetworkedDOM(
|
|
38
|
-
url.pathToFileURL(
|
|
46
|
+
url.pathToFileURL(fullPath).toString(),
|
|
39
47
|
LocalObservableDOMFactory
|
|
40
48
|
);
|
|
41
49
|
document.load(contents);
|
|
42
50
|
const currentData = {
|
|
43
|
-
documentPath:
|
|
51
|
+
documentPath: fullPath,
|
|
44
52
|
document
|
|
45
53
|
};
|
|
46
|
-
this.documents.set(
|
|
47
|
-
}).on("change", (
|
|
48
|
-
const
|
|
49
|
-
console.log(`
|
|
50
|
-
const contents = getMmlDocumentContent(
|
|
51
|
-
const documentState = this.documents.get(
|
|
54
|
+
this.documents.set(relativePath, currentData);
|
|
55
|
+
}).on("change", (fullPath) => {
|
|
56
|
+
const relativePath = path.relative(this.directory, fullPath);
|
|
57
|
+
console.log(`MML Document '${relativePath}' has been changed`);
|
|
58
|
+
const contents = getMmlDocumentContent(fullPath);
|
|
59
|
+
const documentState = this.documents.get(relativePath);
|
|
52
60
|
if (!documentState) {
|
|
53
|
-
console.error(`
|
|
61
|
+
console.error(`MML Document '${relativePath}' not found`);
|
|
54
62
|
return;
|
|
55
63
|
}
|
|
56
64
|
documentState.document.load(contents);
|
|
57
|
-
}).on("unlink", (
|
|
58
|
-
const
|
|
59
|
-
console.log(`
|
|
60
|
-
const documentState = this.documents.get(
|
|
65
|
+
}).on("unlink", (fullPath) => {
|
|
66
|
+
const relativePath = path.relative(this.directory, fullPath);
|
|
67
|
+
console.log(`MML Document '${relativePath}' has been removed`);
|
|
68
|
+
const documentState = this.documents.get(relativePath);
|
|
61
69
|
if (!documentState) {
|
|
62
|
-
console.error(`
|
|
70
|
+
console.error(`MML Document '${relativePath}' not found`);
|
|
63
71
|
return;
|
|
64
72
|
}
|
|
65
73
|
documentState.document.dispose();
|
|
66
|
-
this.documents.delete(
|
|
74
|
+
this.documents.delete(relativePath);
|
|
67
75
|
}).on("error", (error) => {
|
|
68
76
|
console.error("Error whilst watching directory", error);
|
|
69
77
|
});
|
|
@@ -71,8 +79,16 @@ var MMLDocumentsServer = class {
|
|
|
71
79
|
};
|
|
72
80
|
|
|
73
81
|
// src/Networked3dWebExperienceServer.ts
|
|
74
|
-
import {
|
|
75
|
-
|
|
82
|
+
import {
|
|
83
|
+
CHAT_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,
|
|
84
|
+
CHAT_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,
|
|
85
|
+
ChatNetworkingServer
|
|
86
|
+
} from "@mml-io/3d-web-text-chat";
|
|
87
|
+
import {
|
|
88
|
+
USER_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,
|
|
89
|
+
USER_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,
|
|
90
|
+
UserNetworkingServer
|
|
91
|
+
} from "@mml-io/3d-web-user-networking";
|
|
76
92
|
import cors from "cors";
|
|
77
93
|
import express from "express";
|
|
78
94
|
|
|
@@ -99,7 +115,8 @@ var Networked3dWebExperienceServer = class {
|
|
|
99
115
|
constructor(config) {
|
|
100
116
|
this.config = config;
|
|
101
117
|
if (this.config.mmlServing) {
|
|
102
|
-
|
|
118
|
+
const { documentsWatchPath, documentsDirectoryRoot } = this.config.mmlServing;
|
|
119
|
+
this.mmlDocumentsServer = new MMLDocumentsServer(documentsDirectoryRoot, documentsWatchPath);
|
|
103
120
|
}
|
|
104
121
|
if (this.config.chatNetworkPath) {
|
|
105
122
|
this.chatNetworkingServer = new ChatNetworkingServer({
|
|
@@ -109,6 +126,7 @@ var Networked3dWebExperienceServer = class {
|
|
|
109
126
|
});
|
|
110
127
|
}
|
|
111
128
|
this.userNetworkingServer = new UserNetworkingServer({
|
|
129
|
+
connectionLimit: config.connectionLimit,
|
|
112
130
|
onClientConnect: (clientId, sessionToken, userIdentityPresentedOnConnection) => {
|
|
113
131
|
return this.config.userAuthenticator.onClientConnect(
|
|
114
132
|
clientId,
|
|
@@ -131,6 +149,27 @@ var Networked3dWebExperienceServer = class {
|
|
|
131
149
|
console.log(`Initiate server-side update of client ${clientId}`);
|
|
132
150
|
this.userNetworkingServer.updateUserCharacter(clientId, userData);
|
|
133
151
|
}
|
|
152
|
+
dispose(errorMessage) {
|
|
153
|
+
this.userNetworkingServer.dispose(
|
|
154
|
+
errorMessage ? {
|
|
155
|
+
type: USER_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,
|
|
156
|
+
errorType: USER_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,
|
|
157
|
+
message: errorMessage
|
|
158
|
+
} : void 0
|
|
159
|
+
);
|
|
160
|
+
if (this.chatNetworkingServer) {
|
|
161
|
+
this.chatNetworkingServer.dispose(
|
|
162
|
+
errorMessage ? {
|
|
163
|
+
type: CHAT_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,
|
|
164
|
+
errorType: CHAT_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,
|
|
165
|
+
message: errorMessage
|
|
166
|
+
} : void 0
|
|
167
|
+
);
|
|
168
|
+
}
|
|
169
|
+
if (this.mmlDocumentsServer) {
|
|
170
|
+
this.mmlDocumentsServer.dispose();
|
|
171
|
+
}
|
|
172
|
+
}
|
|
134
173
|
registerExpressRoutes(app) {
|
|
135
174
|
app.ws(this.config.networkPath, (ws) => {
|
|
136
175
|
this.userNetworkingServer.connectClient(ws);
|
|
@@ -166,9 +205,10 @@ var Networked3dWebExperienceServer = class {
|
|
|
166
205
|
const mmlDocumentsServer = this.mmlDocumentsServer;
|
|
167
206
|
const mmlServing = this.config.mmlServing;
|
|
168
207
|
if (mmlServing && mmlDocumentsServer) {
|
|
169
|
-
app.ws(`${mmlServing.documentsUrl}
|
|
170
|
-
const
|
|
171
|
-
|
|
208
|
+
app.ws(`${mmlServing.documentsUrl}*`, (ws, req) => {
|
|
209
|
+
const path2 = req.params[0];
|
|
210
|
+
console.log("document requested", { path: path2 });
|
|
211
|
+
mmlDocumentsServer.handle(path2, ws);
|
|
172
212
|
});
|
|
173
213
|
}
|
|
174
214
|
if (this.config.assetServing) {
|
package/build/index.js.map
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"version": 3,
|
|
3
3
|
"sources": ["../src/MMLDocumentsServer.ts", "../src/Networked3dWebExperienceServer.ts", "../src/websocketDirectoryChangeListener.ts"],
|
|
4
|
-
"sourcesContent": ["import fs from \"fs\";\nimport path from \"path\";\nimport url from \"url\";\n\nimport chokidar from \"chokidar\";\nimport { EditableNetworkedDOM, LocalObservableDOMFactory } from \"networked-dom-server\";\nimport WebSocket from \"ws\";\n\nconst getMmlDocumentContent = (documentPath: string) => {\n return fs.readFileSync(documentPath, { encoding: \"utf8\", flag: \"r\" });\n};\n\nexport class MMLDocumentsServer {\n private documents = new Map<\n string,\n {\n documentPath: string;\n document: EditableNetworkedDOM;\n }\n >();\n\n constructor(private directory: string) {\n this.watch();\n }\n\n public handle(filename: string, ws: WebSocket) {\n const document = this.documents.get(filename)?.document;\n if (!document) {\n ws.close();\n return;\n }\n\n document.addWebSocket(ws as any);\n ws.on(\"close\", () => {\n document.removeWebSocket(ws as any);\n });\n }\n\n private watch() {\n const watcher = chokidar.watch(this.directory, {\n ignored: /^\\./,\n persistent: true,\n });\n watcher\n .on(\"add\", (relativeFilePath) => {\n const filename = path.basename(relativeFilePath);\n console.log(`Example document '${filename}' has been added`);\n const contents = getMmlDocumentContent(relativeFilePath);\n const document = new EditableNetworkedDOM(\n url.pathToFileURL(filename).toString(),\n LocalObservableDOMFactory,\n );\n document.load(contents);\n\n const currentData = {\n documentPath: filename,\n document,\n };\n this.documents.set(filename, currentData);\n })\n .on(\"change\", (relativeFilePath) => {\n const filename = path.basename(relativeFilePath);\n console.log(`Example document '${filename}' has been changed`);\n const contents = getMmlDocumentContent(relativeFilePath);\n const documentState = this.documents.get(filename);\n if (!documentState) {\n console.error(`Example document '${filename}' not found`);\n return;\n }\n documentState.document.load(contents);\n })\n .on(\"unlink\", (relativeFilePath) => {\n const filename = path.basename(relativeFilePath);\n console.log(`Example document '${filename}' has been removed`);\n const documentState = this.documents.get(filename);\n if (!documentState) {\n console.error(`Example document '${filename}' not found`);\n return;\n }\n documentState.document.dispose();\n this.documents.delete(filename);\n })\n .on(\"error\", (error) => {\n console.error(\"Error whilst watching directory\", error);\n });\n }\n}\n", "import { ChatNetworkingServer } from \"@mml-io/3d-web-text-chat\";\nimport { UserData, UserIdentity, UserNetworkingServer } from \"@mml-io/3d-web-user-networking\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport enableWs from \"express-ws\";\nimport WebSocket from \"ws\";\n\nimport { MMLDocumentsServer } from \"./MMLDocumentsServer\";\nimport { websocketDirectoryChangeListener } from \"./websocketDirectoryChangeListener\";\n\ntype UserAuthenticator = {\n generateAuthorizedSessionToken(req: express.Request): Promise<string | null>;\n getClientIdForSessionToken: (sessionToken: string) => {\n id: number;\n } | null;\n onClientConnect(\n clientId: number,\n sessionToken: string,\n userIdentityPresentedOnConnection?: UserIdentity,\n ): Promise<UserData | null> | UserData | null;\n onClientUserIdentityUpdate(clientId: number, userIdentity: UserIdentity): UserData | null;\n onClientDisconnect(clientId: number): void;\n};\n\nexport const defaultSessionTokenPlaceholder = \"SESSION.TOKEN.PLACEHOLDER\";\n\nexport type Networked3dWebExperienceServerConfig = {\n networkPath: string;\n webClientServing: {\n indexUrl: string;\n indexContent: string;\n sessionTokenPlaceholder?: string;\n\n clientBuildDir: string;\n clientUrl: string;\n clientWatchWebsocketPath?: string;\n };\n chatNetworkPath?: string;\n assetServing?: {\n assetsDir: string;\n assetsUrl: string;\n };\n mmlServing?: {\n documentsWatchPath: string;\n documentsUrl: string;\n };\n userAuthenticator: UserAuthenticator;\n};\n\nexport class Networked3dWebExperienceServer {\n private userNetworkingServer: UserNetworkingServer;\n\n private chatNetworkingServer?: ChatNetworkingServer;\n\n private mmlDocumentsServer?: MMLDocumentsServer;\n\n constructor(private config: Networked3dWebExperienceServerConfig) {\n if (this.config.mmlServing) {\n this.mmlDocumentsServer = new MMLDocumentsServer(this.config.mmlServing.documentsWatchPath);\n }\n\n if (this.config.chatNetworkPath) {\n this.chatNetworkingServer = new ChatNetworkingServer({\n getChatUserIdentity: (sessionToken: string) => {\n return this.config.userAuthenticator.getClientIdForSessionToken(sessionToken);\n },\n });\n }\n\n this.userNetworkingServer = new UserNetworkingServer({\n onClientConnect: (\n clientId: number,\n sessionToken: string,\n userIdentityPresentedOnConnection?: UserIdentity,\n ): Promise<UserData | null> | UserData | null => {\n return this.config.userAuthenticator.onClientConnect(\n clientId,\n sessionToken,\n userIdentityPresentedOnConnection,\n );\n },\n onClientUserIdentityUpdate: (\n clientId: number,\n userIdentity: UserIdentity,\n ): UserData | null => {\n // Called whenever a user connects or updates their character/identity\n return this.config.userAuthenticator.onClientUserIdentityUpdate(clientId, userIdentity);\n },\n onClientDisconnect: (clientId: number): void => {\n this.config.userAuthenticator.onClientDisconnect(clientId);\n // Disconnect the corresponding chat client to avoid later conflicts of client ids\n if (this.chatNetworkingServer) {\n this.chatNetworkingServer.disconnectClientId(clientId);\n }\n },\n });\n }\n\n public updateUserCharacter(clientId: number, userData: UserData) {\n console.log(`Initiate server-side update of client ${clientId}`);\n this.userNetworkingServer.updateUserCharacter(clientId, userData);\n }\n\n registerExpressRoutes(app: enableWs.Application) {\n app.ws(this.config.networkPath, (ws) => {\n this.userNetworkingServer.connectClient(ws);\n });\n\n if (this.config.chatNetworkPath && this.chatNetworkingServer) {\n const chatServer = this.chatNetworkingServer;\n app.ws(this.config.chatNetworkPath, (ws) => {\n chatServer.connectClient(ws);\n });\n }\n\n const webClientServing = this.config.webClientServing;\n if (webClientServing) {\n app.get(webClientServing.indexUrl, async (req: express.Request, res: express.Response) => {\n const token = await this.config.userAuthenticator.generateAuthorizedSessionToken(req);\n if (!token) {\n res.send(\"Error: Could not generate token\");\n return;\n }\n const authorizedDemoIndexContent = webClientServing.indexContent.replace(\n webClientServing.sessionTokenPlaceholder || defaultSessionTokenPlaceholder,\n token,\n );\n res.send(authorizedDemoIndexContent);\n });\n\n app.use(webClientServing.clientUrl, express.static(webClientServing.clientBuildDir));\n if (webClientServing.clientWatchWebsocketPath) {\n websocketDirectoryChangeListener(app, {\n directory: webClientServing.clientBuildDir,\n websocketPath: webClientServing.clientWatchWebsocketPath,\n });\n }\n }\n\n const mmlDocumentsServer = this.mmlDocumentsServer;\n const mmlServing = this.config.mmlServing;\n // Handle example document sockets\n if (mmlServing && mmlDocumentsServer) {\n app.ws(`${mmlServing.documentsUrl}:filename`, (ws: WebSocket, req: express.Request) => {\n const { filename } = req.params;\n mmlDocumentsServer.handle(filename, ws);\n });\n }\n\n if (this.config.assetServing) {\n // Serve assets with CORS allowing all origins\n app.use(\n this.config.assetServing.assetsUrl,\n cors(),\n express.static(this.config.assetServing.assetsDir),\n );\n }\n }\n}\n", "import chokidar from \"chokidar\";\nimport enableWs from \"express-ws\";\nimport WebSocket from \"ws\";\n\nexport function websocketDirectoryChangeListener(\n app: enableWs.Application,\n options: {\n directory: string;\n websocketPath: string;\n },\n) {\n const listeningClients = new Set<WebSocket>();\n chokidar.watch(options.directory).on(\"all\", () => {\n for (const client of listeningClients) {\n client.send(\"change\");\n }\n });\n // Create an event-source that updates whenever the build folder gets modified\n app.ws(options.websocketPath, (ws: WebSocket) => {\n listeningClients.add(ws);\n ws.on(\"close\", () => {\n listeningClients.delete(ws);\n });\n });\n}\n"],
|
|
5
|
-
"mappings": ";AAAA,OAAO,QAAQ;AACf,OAAO,UAAU;AACjB,OAAO,SAAS;AAEhB,OAAO,
|
|
6
|
-
"names": ["chokidar"]
|
|
4
|
+
"sourcesContent": ["import fs from \"node:fs\";\nimport path from \"node:path\";\nimport url from \"node:url\";\n\nimport chokidar, { FSWatcher } from \"chokidar\";\nimport { EditableNetworkedDOM, LocalObservableDOMFactory } from \"networked-dom-server\";\nimport WebSocket from \"ws\";\n\nconst getMmlDocumentContent = (documentPath: string) => {\n return fs.readFileSync(documentPath, { encoding: \"utf8\", flag: \"r\" });\n};\n\nexport class MMLDocumentsServer {\n private documents = new Map<\n string,\n {\n documentPath: string;\n document: EditableNetworkedDOM;\n }\n >();\n private watcher: FSWatcher;\n private watchPattern: string;\n\n constructor(\n private directory: string,\n watchPattern: string,\n ) {\n this.watchPattern = path.resolve(directory, watchPattern);\n this.watch();\n }\n\n public dispose() {\n for (const { document } of this.documents.values()) {\n document.dispose();\n }\n this.documents.clear();\n this.watcher.close();\n }\n\n public handle(filename: string, ws: WebSocket) {\n const document = this.documents.get(filename)?.document;\n if (!document) {\n ws.close();\n return;\n }\n\n document.addWebSocket(ws as any);\n ws.on(\"close\", () => {\n document.removeWebSocket(ws as any);\n });\n }\n\n private watch() {\n this.watcher = chokidar.watch(this.watchPattern, {\n ignored: /^\\./,\n persistent: true,\n });\n this.watcher\n .on(\"add\", (fullPath) => {\n const relativePath = path.relative(this.directory, fullPath);\n console.log(`MML Document '${relativePath}' has been added`);\n const contents = getMmlDocumentContent(fullPath);\n const document = new EditableNetworkedDOM(\n url.pathToFileURL(fullPath).toString(),\n LocalObservableDOMFactory,\n );\n document.load(contents);\n\n const currentData = {\n documentPath: fullPath,\n document,\n };\n this.documents.set(relativePath, currentData);\n })\n .on(\"change\", (fullPath) => {\n const relativePath = path.relative(this.directory, fullPath);\n console.log(`MML Document '${relativePath}' has been changed`);\n const contents = getMmlDocumentContent(fullPath);\n const documentState = this.documents.get(relativePath);\n if (!documentState) {\n console.error(`MML Document '${relativePath}' not found`);\n return;\n }\n documentState.document.load(contents);\n })\n .on(\"unlink\", (fullPath) => {\n const relativePath = path.relative(this.directory, fullPath);\n console.log(`MML Document '${relativePath}' has been removed`);\n const documentState = this.documents.get(relativePath);\n if (!documentState) {\n console.error(`MML Document '${relativePath}' not found`);\n return;\n }\n documentState.document.dispose();\n this.documents.delete(relativePath);\n })\n .on(\"error\", (error) => {\n console.error(\"Error whilst watching directory\", error);\n });\n }\n}\n", "import {\n CHAT_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,\n CHAT_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,\n ChatNetworkingServer,\n} from \"@mml-io/3d-web-text-chat\";\nimport {\n USER_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,\n USER_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,\n UserData,\n UserIdentity,\n UserNetworkingServer,\n} from \"@mml-io/3d-web-user-networking\";\nimport cors from \"cors\";\nimport express from \"express\";\nimport enableWs from \"express-ws\";\nimport WebSocket from \"ws\";\n\nimport { MMLDocumentsServer } from \"./MMLDocumentsServer\";\nimport { websocketDirectoryChangeListener } from \"./websocketDirectoryChangeListener\";\n\ntype UserAuthenticator = {\n generateAuthorizedSessionToken(req: express.Request): Promise<string | null>;\n getClientIdForSessionToken: (sessionToken: string) => {\n id: number;\n } | null;\n onClientConnect(\n clientId: number,\n sessionToken: string,\n userIdentityPresentedOnConnection?: UserIdentity,\n ): Promise<UserData | null> | UserData | null;\n onClientUserIdentityUpdate(clientId: number, userIdentity: UserIdentity): UserData | null;\n onClientDisconnect(clientId: number): void;\n};\n\nexport const defaultSessionTokenPlaceholder = \"SESSION.TOKEN.PLACEHOLDER\";\n\nexport type Networked3dWebExperienceServerConfig = {\n connectionLimit?: number;\n networkPath: string;\n webClientServing: {\n indexUrl: string;\n indexContent: string;\n sessionTokenPlaceholder?: string;\n\n clientBuildDir: string;\n clientUrl: string;\n clientWatchWebsocketPath?: string;\n };\n chatNetworkPath?: string;\n assetServing?: {\n assetsDir: string;\n assetsUrl: string;\n };\n mmlServing?: {\n documentsWatchPath: string;\n documentsDirectoryRoot: string;\n documentsUrl: string;\n };\n userAuthenticator: UserAuthenticator;\n};\n\nexport class Networked3dWebExperienceServer {\n private userNetworkingServer: UserNetworkingServer;\n\n private chatNetworkingServer?: ChatNetworkingServer;\n\n private mmlDocumentsServer?: MMLDocumentsServer;\n\n constructor(private config: Networked3dWebExperienceServerConfig) {\n if (this.config.mmlServing) {\n const { documentsWatchPath, documentsDirectoryRoot } = this.config.mmlServing;\n this.mmlDocumentsServer = new MMLDocumentsServer(documentsDirectoryRoot, documentsWatchPath);\n }\n\n if (this.config.chatNetworkPath) {\n this.chatNetworkingServer = new ChatNetworkingServer({\n getChatUserIdentity: (sessionToken: string) => {\n return this.config.userAuthenticator.getClientIdForSessionToken(sessionToken);\n },\n });\n }\n\n this.userNetworkingServer = new UserNetworkingServer({\n connectionLimit: config.connectionLimit,\n onClientConnect: (\n clientId: number,\n sessionToken: string,\n userIdentityPresentedOnConnection?: UserIdentity,\n ): Promise<UserData | null> | UserData | null => {\n return this.config.userAuthenticator.onClientConnect(\n clientId,\n sessionToken,\n userIdentityPresentedOnConnection,\n );\n },\n onClientUserIdentityUpdate: (\n clientId: number,\n userIdentity: UserIdentity,\n ): UserData | null => {\n // Called whenever a user connects or updates their character/identity\n return this.config.userAuthenticator.onClientUserIdentityUpdate(clientId, userIdentity);\n },\n onClientDisconnect: (clientId: number): void => {\n this.config.userAuthenticator.onClientDisconnect(clientId);\n // Disconnect the corresponding chat client to avoid later conflicts of client ids\n if (this.chatNetworkingServer) {\n this.chatNetworkingServer.disconnectClientId(clientId);\n }\n },\n });\n }\n\n public updateUserCharacter(clientId: number, userData: UserData) {\n console.log(`Initiate server-side update of client ${clientId}`);\n this.userNetworkingServer.updateUserCharacter(clientId, userData);\n }\n\n public dispose(errorMessage?: string) {\n this.userNetworkingServer.dispose(\n errorMessage\n ? {\n type: USER_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,\n errorType: USER_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,\n message: errorMessage,\n }\n : undefined,\n );\n if (this.chatNetworkingServer) {\n this.chatNetworkingServer.dispose(\n errorMessage\n ? {\n type: CHAT_NETWORKING_SERVER_ERROR_MESSAGE_TYPE,\n errorType: CHAT_NETWORKING_SERVER_SHUTDOWN_ERROR_TYPE,\n message: errorMessage,\n }\n : undefined,\n );\n }\n if (this.mmlDocumentsServer) {\n this.mmlDocumentsServer.dispose();\n }\n }\n\n registerExpressRoutes(app: enableWs.Application) {\n app.ws(this.config.networkPath, (ws) => {\n this.userNetworkingServer.connectClient(ws);\n });\n\n if (this.config.chatNetworkPath && this.chatNetworkingServer) {\n const chatServer = this.chatNetworkingServer;\n app.ws(this.config.chatNetworkPath, (ws) => {\n chatServer.connectClient(ws);\n });\n }\n\n const webClientServing = this.config.webClientServing;\n if (webClientServing) {\n app.get(webClientServing.indexUrl, async (req: express.Request, res: express.Response) => {\n const token = await this.config.userAuthenticator.generateAuthorizedSessionToken(req);\n if (!token) {\n res.send(\"Error: Could not generate token\");\n return;\n }\n const authorizedDemoIndexContent = webClientServing.indexContent.replace(\n webClientServing.sessionTokenPlaceholder || defaultSessionTokenPlaceholder,\n token,\n );\n res.send(authorizedDemoIndexContent);\n });\n\n app.use(webClientServing.clientUrl, express.static(webClientServing.clientBuildDir));\n if (webClientServing.clientWatchWebsocketPath) {\n websocketDirectoryChangeListener(app, {\n directory: webClientServing.clientBuildDir,\n websocketPath: webClientServing.clientWatchWebsocketPath,\n });\n }\n }\n\n const mmlDocumentsServer = this.mmlDocumentsServer;\n const mmlServing = this.config.mmlServing;\n // Handle example document sockets\n if (mmlServing && mmlDocumentsServer) {\n app.ws(`${mmlServing.documentsUrl}*`, (ws: WebSocket, req: express.Request) => {\n const path = req.params[0];\n console.log(\"document requested\", { path });\n mmlDocumentsServer.handle(path, ws);\n });\n }\n\n if (this.config.assetServing) {\n // Serve assets with CORS allowing all origins\n app.use(\n this.config.assetServing.assetsUrl,\n cors(),\n express.static(this.config.assetServing.assetsDir),\n );\n }\n }\n}\n", "import chokidar from \"chokidar\";\nimport enableWs from \"express-ws\";\nimport WebSocket from \"ws\";\n\nexport function websocketDirectoryChangeListener(\n app: enableWs.Application,\n options: {\n directory: string;\n websocketPath: string;\n },\n) {\n const listeningClients = new Set<WebSocket>();\n chokidar.watch(options.directory).on(\"all\", () => {\n for (const client of listeningClients) {\n client.send(\"change\");\n }\n });\n // Create an event-source that updates whenever the build folder gets modified\n app.ws(options.websocketPath, (ws: WebSocket) => {\n listeningClients.add(ws);\n ws.on(\"close\", () => {\n listeningClients.delete(ws);\n });\n });\n}\n"],
|
|
5
|
+
"mappings": ";AAAA,OAAO,QAAQ;AACf,OAAO,UAAU;AACjB,OAAO,SAAS;AAEhB,OAAO,cAA6B;AACpC,SAAS,sBAAsB,iCAAiC;AAGhE,IAAM,wBAAwB,CAAC,iBAAyB;AACtD,SAAO,GAAG,aAAa,cAAc,EAAE,UAAU,QAAQ,MAAM,IAAI,CAAC;AACtE;AAEO,IAAM,qBAAN,MAAyB;AAAA,EAW9B,YACU,WACR,cACA;AAFQ;AAXV,SAAQ,YAAY,oBAAI,IAMtB;AAQA,SAAK,eAAe,KAAK,QAAQ,WAAW,YAAY;AACxD,SAAK,MAAM;AAAA,EACb;AAAA,EAEO,UAAU;AACf,eAAW,EAAE,SAAS,KAAK,KAAK,UAAU,OAAO,GAAG;AAClD,eAAS,QAAQ;AAAA,IACnB;AACA,SAAK,UAAU,MAAM;AACrB,SAAK,QAAQ,MAAM;AAAA,EACrB;AAAA,EAEO,OAAO,UAAkB,IAAe;AAvCjD;AAwCI,UAAM,YAAW,UAAK,UAAU,IAAI,QAAQ,MAA3B,mBAA8B;AAC/C,QAAI,CAAC,UAAU;AACb,SAAG,MAAM;AACT;AAAA,IACF;AAEA,aAAS,aAAa,EAAS;AAC/B,OAAG,GAAG,SAAS,MAAM;AACnB,eAAS,gBAAgB,EAAS;AAAA,IACpC,CAAC;AAAA,EACH;AAAA,EAEQ,QAAQ;AACd,SAAK,UAAU,SAAS,MAAM,KAAK,cAAc;AAAA,MAC/C,SAAS;AAAA,MACT,YAAY;AAAA,IACd,CAAC;AACD,SAAK,QACF,GAAG,OAAO,CAAC,aAAa;AACvB,YAAM,eAAe,KAAK,SAAS,KAAK,WAAW,QAAQ;AAC3D,cAAQ,IAAI,iBAAiB,YAAY,kBAAkB;AAC3D,YAAM,WAAW,sBAAsB,QAAQ;AAC/C,YAAM,WAAW,IAAI;AAAA,QACnB,IAAI,cAAc,QAAQ,EAAE,SAAS;AAAA,QACrC;AAAA,MACF;AACA,eAAS,KAAK,QAAQ;AAEtB,YAAM,cAAc;AAAA,QAClB,cAAc;AAAA,QACd;AAAA,MACF;AACA,WAAK,UAAU,IAAI,cAAc,WAAW;AAAA,IAC9C,CAAC,EACA,GAAG,UAAU,CAAC,aAAa;AAC1B,YAAM,eAAe,KAAK,SAAS,KAAK,WAAW,QAAQ;AAC3D,cAAQ,IAAI,iBAAiB,YAAY,oBAAoB;AAC7D,YAAM,WAAW,sBAAsB,QAAQ;AAC/C,YAAM,gBAAgB,KAAK,UAAU,IAAI,YAAY;AACrD,UAAI,CAAC,eAAe;AAClB,gBAAQ,MAAM,iBAAiB,YAAY,aAAa;AACxD;AAAA,MACF;AACA,oBAAc,SAAS,KAAK,QAAQ;AAAA,IACtC,CAAC,EACA,GAAG,UAAU,CAAC,aAAa;AAC1B,YAAM,eAAe,KAAK,SAAS,KAAK,WAAW,QAAQ;AAC3D,cAAQ,IAAI,iBAAiB,YAAY,oBAAoB;AAC7D,YAAM,gBAAgB,KAAK,UAAU,IAAI,YAAY;AACrD,UAAI,CAAC,eAAe;AAClB,gBAAQ,MAAM,iBAAiB,YAAY,aAAa;AACxD;AAAA,MACF;AACA,oBAAc,SAAS,QAAQ;AAC/B,WAAK,UAAU,OAAO,YAAY;AAAA,IACpC,CAAC,EACA,GAAG,SAAS,CAAC,UAAU;AACtB,cAAQ,MAAM,mCAAmC,KAAK;AAAA,IACxD,CAAC;AAAA,EACL;AACF;;;ACpGA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP;AAAA,EACE;AAAA,EACA;AAAA,EAGA;AAAA,OACK;AACP,OAAO,UAAU;AACjB,OAAO,aAAa;;;ACbpB,OAAOA,eAAc;AAId,SAAS,iCACd,KACA,SAIA;AACA,QAAM,mBAAmB,oBAAI,IAAe;AAC5C,EAAAA,UAAS,MAAM,QAAQ,SAAS,EAAE,GAAG,OAAO,MAAM;AAChD,eAAW,UAAU,kBAAkB;AACrC,aAAO,KAAK,QAAQ;AAAA,IACtB;AAAA,EACF,CAAC;AAED,MAAI,GAAG,QAAQ,eAAe,CAAC,OAAkB;AAC/C,qBAAiB,IAAI,EAAE;AACvB,OAAG,GAAG,SAAS,MAAM;AACnB,uBAAiB,OAAO,EAAE;AAAA,IAC5B,CAAC;AAAA,EACH,CAAC;AACH;;;ADUO,IAAM,iCAAiC;AA2BvC,IAAM,iCAAN,MAAqC;AAAA,EAO1C,YAAoB,QAA8C;AAA9C;AAClB,QAAI,KAAK,OAAO,YAAY;AAC1B,YAAM,EAAE,oBAAoB,uBAAuB,IAAI,KAAK,OAAO;AACnE,WAAK,qBAAqB,IAAI,mBAAmB,wBAAwB,kBAAkB;AAAA,IAC7F;AAEA,QAAI,KAAK,OAAO,iBAAiB;AAC/B,WAAK,uBAAuB,IAAI,qBAAqB;AAAA,QACnD,qBAAqB,CAAC,iBAAyB;AAC7C,iBAAO,KAAK,OAAO,kBAAkB,2BAA2B,YAAY;AAAA,QAC9E;AAAA,MACF,CAAC;AAAA,IACH;AAEA,SAAK,uBAAuB,IAAI,qBAAqB;AAAA,MACnD,iBAAiB,OAAO;AAAA,MACxB,iBAAiB,CACf,UACA,cACA,sCAC+C;AAC/C,eAAO,KAAK,OAAO,kBAAkB;AAAA,UACnC;AAAA,UACA;AAAA,UACA;AAAA,QACF;AAAA,MACF;AAAA,MACA,4BAA4B,CAC1B,UACA,iBACoB;AAEpB,eAAO,KAAK,OAAO,kBAAkB,2BAA2B,UAAU,YAAY;AAAA,MACxF;AAAA,MACA,oBAAoB,CAAC,aAA2B;AAC9C,aAAK,OAAO,kBAAkB,mBAAmB,QAAQ;AAEzD,YAAI,KAAK,sBAAsB;AAC7B,eAAK,qBAAqB,mBAAmB,QAAQ;AAAA,QACvD;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEO,oBAAoB,UAAkB,UAAoB;AAC/D,YAAQ,IAAI,yCAAyC,QAAQ,EAAE;AAC/D,SAAK,qBAAqB,oBAAoB,UAAU,QAAQ;AAAA,EAClE;AAAA,EAEO,QAAQ,cAAuB;AACpC,SAAK,qBAAqB;AAAA,MACxB,eACI;AAAA,QACE,MAAM;AAAA,QACN,WAAW;AAAA,QACX,SAAS;AAAA,MACX,IACA;AAAA,IACN;AACA,QAAI,KAAK,sBAAsB;AAC7B,WAAK,qBAAqB;AAAA,QACxB,eACI;AAAA,UACE,MAAM;AAAA,UACN,WAAW;AAAA,UACX,SAAS;AAAA,QACX,IACA;AAAA,MACN;AAAA,IACF;AACA,QAAI,KAAK,oBAAoB;AAC3B,WAAK,mBAAmB,QAAQ;AAAA,IAClC;AAAA,EACF;AAAA,EAEA,sBAAsB,KAA2B;AAC/C,QAAI,GAAG,KAAK,OAAO,aAAa,CAAC,OAAO;AACtC,WAAK,qBAAqB,cAAc,EAAE;AAAA,IAC5C,CAAC;AAED,QAAI,KAAK,OAAO,mBAAmB,KAAK,sBAAsB;AAC5D,YAAM,aAAa,KAAK;AACxB,UAAI,GAAG,KAAK,OAAO,iBAAiB,CAAC,OAAO;AAC1C,mBAAW,cAAc,EAAE;AAAA,MAC7B,CAAC;AAAA,IACH;AAEA,UAAM,mBAAmB,KAAK,OAAO;AACrC,QAAI,kBAAkB;AACpB,UAAI,IAAI,iBAAiB,UAAU,OAAO,KAAsB,QAA0B;AACxF,cAAM,QAAQ,MAAM,KAAK,OAAO,kBAAkB,+BAA+B,GAAG;AACpF,YAAI,CAAC,OAAO;AACV,cAAI,KAAK,iCAAiC;AAC1C;AAAA,QACF;AACA,cAAM,6BAA6B,iBAAiB,aAAa;AAAA,UAC/D,iBAAiB,2BAA2B;AAAA,UAC5C;AAAA,QACF;AACA,YAAI,KAAK,0BAA0B;AAAA,MACrC,CAAC;AAED,UAAI,IAAI,iBAAiB,WAAW,QAAQ,OAAO,iBAAiB,cAAc,CAAC;AACnF,UAAI,iBAAiB,0BAA0B;AAC7C,yCAAiC,KAAK;AAAA,UACpC,WAAW,iBAAiB;AAAA,UAC5B,eAAe,iBAAiB;AAAA,QAClC,CAAC;AAAA,MACH;AAAA,IACF;AAEA,UAAM,qBAAqB,KAAK;AAChC,UAAM,aAAa,KAAK,OAAO;AAE/B,QAAI,cAAc,oBAAoB;AACpC,UAAI,GAAG,GAAG,WAAW,YAAY,KAAK,CAAC,IAAe,QAAyB;AAC7E,cAAMC,QAAO,IAAI,OAAO,CAAC;AACzB,gBAAQ,IAAI,sBAAsB,EAAE,MAAAA,MAAK,CAAC;AAC1C,2BAAmB,OAAOA,OAAM,EAAE;AAAA,MACpC,CAAC;AAAA,IACH;AAEA,QAAI,KAAK,OAAO,cAAc;AAE5B,UAAI;AAAA,QACF,KAAK,OAAO,aAAa;AAAA,QACzB,KAAK;AAAA,QACL,QAAQ,OAAO,KAAK,OAAO,aAAa,SAAS;AAAA,MACnD;AAAA,IACF;AAAA,EACF;AACF;",
|
|
6
|
+
"names": ["chokidar", "path"]
|
|
7
7
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mml-io/3d-web-experience-server",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.19.0",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -18,24 +18,24 @@
|
|
|
18
18
|
"lint-fix": "eslint \"./{src,test}/**/*.{js,jsx,ts,tsx}\" --fix"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@mml-io/3d-web-client-core": "^0.
|
|
22
|
-
"@mml-io/3d-web-text-chat": "^0.
|
|
23
|
-
"@mml-io/3d-web-user-networking": "^0.
|
|
24
|
-
"@mml-io/3d-web-voice-chat": "^0.
|
|
21
|
+
"@mml-io/3d-web-client-core": "^0.19.0",
|
|
22
|
+
"@mml-io/3d-web-text-chat": "^0.19.0",
|
|
23
|
+
"@mml-io/3d-web-user-networking": "^0.19.0",
|
|
24
|
+
"@mml-io/3d-web-voice-chat": "^0.19.0",
|
|
25
25
|
"chokidar": "^3.6.0",
|
|
26
26
|
"cors": "^2.8.5",
|
|
27
27
|
"express": "^4.19.2",
|
|
28
28
|
"express-ws": "^5.0.2",
|
|
29
|
-
"networked-dom-server": "0.
|
|
29
|
+
"networked-dom-server": "0.17.1",
|
|
30
30
|
"three": "0.163.0",
|
|
31
|
-
"ws": "^8.
|
|
31
|
+
"ws": "^8.18.0"
|
|
32
32
|
},
|
|
33
33
|
"devDependencies": {
|
|
34
34
|
"@types/cors": "2.8.17",
|
|
35
35
|
"@types/express": "^4.17.21",
|
|
36
36
|
"@types/express-ws": "^3.0.4",
|
|
37
|
-
"@types/node": "^20.
|
|
37
|
+
"@types/node": "^20.14.10",
|
|
38
38
|
"@types/three": "0.163.0"
|
|
39
39
|
},
|
|
40
|
-
"gitHead": "
|
|
40
|
+
"gitHead": "1d785e68643dd46c63b49d9fcb0fc1d73097a414"
|
|
41
41
|
}
|