@mml-io/3d-web-experience-server 0.15.0 → 0.17.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/LICENSE ADDED
@@ -0,0 +1,19 @@
1
+ Copyright (c) 2023 Improbable MV Limited
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy
4
+ of this software and associated documentation files (the "Software"), to deal
5
+ in the Software without restriction, including without limitation the rights
6
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7
+ copies of the Software, and to permit persons to whom the Software is
8
+ furnished to do so, subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
+ SOFTWARE.
@@ -2,11 +2,11 @@ import { UserData, UserIdentity } from "@mml-io/3d-web-user-networking";
2
2
  import express from "express";
3
3
  import enableWs from "express-ws";
4
4
  type UserAuthenticator = {
5
- generateAuthorizedSessionToken(req: express.Request): string | null;
5
+ generateAuthorizedSessionToken(req: express.Request): Promise<string | null>;
6
6
  getClientIdForSessionToken: (sessionToken: string) => {
7
7
  id: number;
8
8
  } | null;
9
- onClientConnect(clientId: number, sessionToken: string, userIdentityPresentedOnConnection?: UserIdentity): UserData | null;
9
+ onClientConnect(clientId: number, sessionToken: string, userIdentityPresentedOnConnection?: UserIdentity): Promise<UserData | null> | UserData | null;
10
10
  onClientUserIdentityUpdate(clientId: number, userIdentity: UserIdentity): UserData | null;
11
11
  onClientDisconnect(clientId: number): void;
12
12
  };
@@ -38,6 +38,7 @@ export declare class Networked3dWebExperienceServer {
38
38
  private chatNetworkingServer?;
39
39
  private mmlDocumentsServer?;
40
40
  constructor(config: Networked3dWebExperienceServerConfig);
41
+ updateUserCharacter(clientId: number, userData: UserData): void;
41
42
  registerExpressRoutes(app: enableWs.Application): void;
42
43
  }
43
44
  export {};
@@ -1,2 +1,3 @@
1
1
  export * from "./MMLDocumentsServer";
2
2
  export * from "./Networked3dWebExperienceServer";
3
+ export * from "./websocketDirectoryChangeListener";
package/build/index.js CHANGED
@@ -76,7 +76,7 @@ import { UserNetworkingServer } from "@mml-io/3d-web-user-networking";
76
76
  import cors from "cors";
77
77
  import express from "express";
78
78
 
79
- // ../../utils/websocketDirectoryChangeListener.ts
79
+ // src/websocketDirectoryChangeListener.ts
80
80
  import chokidar2 from "chokidar";
81
81
  function websocketDirectoryChangeListener(app, options) {
82
82
  const listeningClients = /* @__PURE__ */ new Set();
@@ -101,11 +101,13 @@ var Networked3dWebExperienceServer = class {
101
101
  if (this.config.mmlServing) {
102
102
  this.mmlDocumentsServer = new MMLDocumentsServer(this.config.mmlServing.documentsWatchPath);
103
103
  }
104
- this.chatNetworkingServer = new ChatNetworkingServer({
105
- getChatUserIdentity: (sessionToken) => {
106
- return this.config.userAuthenticator.getClientIdForSessionToken(sessionToken);
107
- }
108
- });
104
+ if (this.config.chatNetworkPath) {
105
+ this.chatNetworkingServer = new ChatNetworkingServer({
106
+ getChatUserIdentity: (sessionToken) => {
107
+ return this.config.userAuthenticator.getClientIdForSessionToken(sessionToken);
108
+ }
109
+ });
110
+ }
109
111
  this.userNetworkingServer = new UserNetworkingServer({
110
112
  onClientConnect: (clientId, sessionToken, userIdentityPresentedOnConnection) => {
111
113
  return this.config.userAuthenticator.onClientConnect(
@@ -125,6 +127,10 @@ var Networked3dWebExperienceServer = class {
125
127
  }
126
128
  });
127
129
  }
130
+ updateUserCharacter(clientId, userData) {
131
+ console.log(`Initiate server-side update of client ${clientId}`);
132
+ this.userNetworkingServer.updateUserCharacter(clientId, userData);
133
+ }
128
134
  registerExpressRoutes(app) {
129
135
  app.ws(this.config.networkPath, (ws) => {
130
136
  this.userNetworkingServer.connectClient(ws);
@@ -137,8 +143,8 @@ var Networked3dWebExperienceServer = class {
137
143
  }
138
144
  const webClientServing = this.config.webClientServing;
139
145
  if (webClientServing) {
140
- app.get(webClientServing.indexUrl, (req, res) => {
141
- const token = this.config.userAuthenticator.generateAuthorizedSessionToken(req);
146
+ app.get(webClientServing.indexUrl, async (req, res) => {
147
+ const token = await this.config.userAuthenticator.generateAuthorizedSessionToken(req);
142
148
  if (!token) {
143
149
  res.send("Error: Could not generate token");
144
150
  return;
@@ -177,6 +183,7 @@ var Networked3dWebExperienceServer = class {
177
183
  export {
178
184
  MMLDocumentsServer,
179
185
  Networked3dWebExperienceServer,
180
- defaultSessionTokenPlaceholder
186
+ defaultSessionTokenPlaceholder,
187
+ websocketDirectoryChangeListener
181
188
  };
182
189
  //# sourceMappingURL=index.js.map
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../src/MMLDocumentsServer.ts", "../src/Networked3dWebExperienceServer.ts", "../../../utils/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 { websocketDirectoryChangeListener } from \"../../../utils/websocketDirectoryChangeListener\";\n\nimport { MMLDocumentsServer } from \"./MMLDocumentsServer\";\n\ntype UserAuthenticator = {\n generateAuthorizedSessionToken(req: express.Request): string | null;\n getClientIdForSessionToken: (sessionToken: string) => {\n id: number;\n } | null;\n onClientConnect(\n clientId: number,\n sessionToken: string,\n userIdentityPresentedOnConnection?: UserIdentity,\n ): 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 this.chatNetworkingServer = new ChatNetworkingServer({\n getChatUserIdentity: (sessionToken: string) => {\n return this.config.userAuthenticator.getClientIdForSessionToken(sessionToken);\n },\n });\n\n this.userNetworkingServer = new UserNetworkingServer({\n onClientConnect: (\n clientId: number,\n sessionToken: string,\n userIdentityPresentedOnConnection?: UserIdentity,\n ): 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 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, (req: express.Request, res: express.Response) => {\n const token = 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,cAAc;AACrB,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,EAS9B,YAAoB,WAAmB;AAAnB;AARpB,SAAQ,YAAY,oBAAI,IAMtB;AAGA,SAAK,MAAM;AAAA,EACb;AAAA,EAEO,OAAO,UAAkB,IAAe;AAzBjD;AA0BI,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,UAAM,UAAU,SAAS,MAAM,KAAK,WAAW;AAAA,MAC7C,SAAS;AAAA,MACT,YAAY;AAAA,IACd,CAAC;AACD,YACG,GAAG,OAAO,CAAC,qBAAqB;AAC/B,YAAM,WAAW,KAAK,SAAS,gBAAgB;AAC/C,cAAQ,IAAI,qBAAqB,QAAQ,kBAAkB;AAC3D,YAAM,WAAW,sBAAsB,gBAAgB;AACvD,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,UAAU,WAAW;AAAA,IAC1C,CAAC,EACA,GAAG,UAAU,CAAC,qBAAqB;AAClC,YAAM,WAAW,KAAK,SAAS,gBAAgB;AAC/C,cAAQ,IAAI,qBAAqB,QAAQ,oBAAoB;AAC7D,YAAM,WAAW,sBAAsB,gBAAgB;AACvD,YAAM,gBAAgB,KAAK,UAAU,IAAI,QAAQ;AACjD,UAAI,CAAC,eAAe;AAClB,gBAAQ,MAAM,qBAAqB,QAAQ,aAAa;AACxD;AAAA,MACF;AACA,oBAAc,SAAS,KAAK,QAAQ;AAAA,IACtC,CAAC,EACA,GAAG,UAAU,CAAC,qBAAqB;AAClC,YAAM,WAAW,KAAK,SAAS,gBAAgB;AAC/C,cAAQ,IAAI,qBAAqB,QAAQ,oBAAoB;AAC7D,YAAM,gBAAgB,KAAK,UAAU,IAAI,QAAQ;AACjD,UAAI,CAAC,eAAe;AAClB,gBAAQ,MAAM,qBAAqB,QAAQ,aAAa;AACxD;AAAA,MACF;AACA,oBAAc,SAAS,QAAQ;AAC/B,WAAK,UAAU,OAAO,QAAQ;AAAA,IAChC,CAAC,EACA,GAAG,SAAS,CAAC,UAAU;AACtB,cAAQ,MAAM,mCAAmC,KAAK;AAAA,IACxD,CAAC;AAAA,EACL;AACF;;;ACtFA,SAAS,4BAA4B;AACrC,SAAiC,4BAA4B;AAC7D,OAAO,UAAU;AACjB,OAAO,aAAa;;;ACHpB,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;;;ADCO,IAAM,iCAAiC;AAyBvC,IAAM,iCAAN,MAAqC;AAAA,EAO1C,YAAoB,QAA8C;AAA9C;AAClB,QAAI,KAAK,OAAO,YAAY;AAC1B,WAAK,qBAAqB,IAAI,mBAAmB,KAAK,OAAO,WAAW,kBAAkB;AAAA,IAC5F;AAEA,SAAK,uBAAuB,IAAI,qBAAqB;AAAA,MACnD,qBAAqB,CAAC,iBAAyB;AAC7C,eAAO,KAAK,OAAO,kBAAkB,2BAA2B,YAAY;AAAA,MAC9E;AAAA,IACF,CAAC;AAED,SAAK,uBAAuB,IAAI,qBAAqB;AAAA,MACnD,iBAAiB,CACf,UACA,cACA,sCACoB;AACpB,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,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,CAAC,KAAsB,QAA0B;AAClF,cAAM,QAAQ,KAAK,OAAO,kBAAkB,+BAA+B,GAAG;AAC9E,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,aAAa,CAAC,IAAe,QAAyB;AACrF,cAAM,EAAE,SAAS,IAAI,IAAI;AACzB,2BAAmB,OAAO,UAAU,EAAE;AAAA,MACxC,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;",
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,cAAc;AACrB,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,EAS9B,YAAoB,WAAmB;AAAnB;AARpB,SAAQ,YAAY,oBAAI,IAMtB;AAGA,SAAK,MAAM;AAAA,EACb;AAAA,EAEO,OAAO,UAAkB,IAAe;AAzBjD;AA0BI,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,UAAM,UAAU,SAAS,MAAM,KAAK,WAAW;AAAA,MAC7C,SAAS;AAAA,MACT,YAAY;AAAA,IACd,CAAC;AACD,YACG,GAAG,OAAO,CAAC,qBAAqB;AAC/B,YAAM,WAAW,KAAK,SAAS,gBAAgB;AAC/C,cAAQ,IAAI,qBAAqB,QAAQ,kBAAkB;AAC3D,YAAM,WAAW,sBAAsB,gBAAgB;AACvD,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,UAAU,WAAW;AAAA,IAC1C,CAAC,EACA,GAAG,UAAU,CAAC,qBAAqB;AAClC,YAAM,WAAW,KAAK,SAAS,gBAAgB;AAC/C,cAAQ,IAAI,qBAAqB,QAAQ,oBAAoB;AAC7D,YAAM,WAAW,sBAAsB,gBAAgB;AACvD,YAAM,gBAAgB,KAAK,UAAU,IAAI,QAAQ;AACjD,UAAI,CAAC,eAAe;AAClB,gBAAQ,MAAM,qBAAqB,QAAQ,aAAa;AACxD;AAAA,MACF;AACA,oBAAc,SAAS,KAAK,QAAQ;AAAA,IACtC,CAAC,EACA,GAAG,UAAU,CAAC,qBAAqB;AAClC,YAAM,WAAW,KAAK,SAAS,gBAAgB;AAC/C,cAAQ,IAAI,qBAAqB,QAAQ,oBAAoB;AAC7D,YAAM,gBAAgB,KAAK,UAAU,IAAI,QAAQ;AACjD,UAAI,CAAC,eAAe;AAClB,gBAAQ,MAAM,qBAAqB,QAAQ,aAAa;AACxD;AAAA,MACF;AACA,oBAAc,SAAS,QAAQ;AAC/B,WAAK,UAAU,OAAO,QAAQ;AAAA,IAChC,CAAC,EACA,GAAG,SAAS,CAAC,UAAU;AACtB,cAAQ,MAAM,mCAAmC,KAAK;AAAA,IACxD,CAAC;AAAA,EACL;AACF;;;ACtFA,SAAS,4BAA4B;AACrC,SAAiC,4BAA4B;AAC7D,OAAO,UAAU;AACjB,OAAO,aAAa;;;ACHpB,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;;;ADAO,IAAM,iCAAiC;AAyBvC,IAAM,iCAAN,MAAqC;AAAA,EAO1C,YAAoB,QAA8C;AAA9C;AAClB,QAAI,KAAK,OAAO,YAAY;AAC1B,WAAK,qBAAqB,IAAI,mBAAmB,KAAK,OAAO,WAAW,kBAAkB;AAAA,IAC5F;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,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,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,aAAa,CAAC,IAAe,QAAyB;AACrF,cAAM,EAAE,SAAS,IAAI,IAAI;AACzB,2BAAmB,OAAO,UAAU,EAAE;AAAA,MACxC,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
6
  "names": ["chokidar"]
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mml-io/3d-web-experience-server",
3
- "version": "0.15.0",
3
+ "version": "0.17.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -18,14 +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.15.0",
22
- "@mml-io/3d-web-text-chat": "^0.15.0",
23
- "@mml-io/3d-web-user-networking": "^0.15.0",
24
- "@mml-io/3d-web-voice-chat": "^0.15.0",
25
- "three": "0.163.0"
21
+ "@mml-io/3d-web-client-core": "^0.17.0",
22
+ "@mml-io/3d-web-text-chat": "^0.17.0",
23
+ "@mml-io/3d-web-user-networking": "^0.17.0",
24
+ "@mml-io/3d-web-voice-chat": "^0.17.0",
25
+ "chokidar": "^3.6.0",
26
+ "cors": "^2.8.5",
27
+ "express": "^4.19.2",
28
+ "express-ws": "^5.0.2",
29
+ "networked-dom-server": "0.15.0",
30
+ "three": "0.163.0",
31
+ "ws": "^8.16.0"
26
32
  },
27
33
  "devDependencies": {
34
+ "@types/cors": "2.8.17",
35
+ "@types/express": "^4.17.21",
36
+ "@types/express-ws": "^3.0.4",
28
37
  "@types/node": "^20.12.7",
29
38
  "@types/three": "0.163.0"
30
- }
39
+ },
40
+ "gitHead": "bc97b49ea69d920e0824a6885f7e8fca440e2e12"
31
41
  }