@mml-io/3d-web-experience-server 0.16.0 → 0.18.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,16 +2,17 @@ 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
  };
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;
@@ -38,6 +39,7 @@ export declare class Networked3dWebExperienceServer {
38
39
  private chatNetworkingServer?;
39
40
  private mmlDocumentsServer?;
40
41
  constructor(config: Networked3dWebExperienceServerConfig);
42
+ updateUserCharacter(clientId: number, userData: UserData): void;
41
43
  registerExpressRoutes(app: enableWs.Application): void;
42
44
  }
43
45
  export {};
package/build/index.js CHANGED
@@ -109,6 +109,7 @@ var Networked3dWebExperienceServer = class {
109
109
  });
110
110
  }
111
111
  this.userNetworkingServer = new UserNetworkingServer({
112
+ connectionLimit: config.connectionLimit,
112
113
  onClientConnect: (clientId, sessionToken, userIdentityPresentedOnConnection) => {
113
114
  return this.config.userAuthenticator.onClientConnect(
114
115
  clientId,
@@ -127,6 +128,10 @@ var Networked3dWebExperienceServer = class {
127
128
  }
128
129
  });
129
130
  }
131
+ updateUserCharacter(clientId, userData) {
132
+ console.log(`Initiate server-side update of client ${clientId}`);
133
+ this.userNetworkingServer.updateUserCharacter(clientId, userData);
134
+ }
130
135
  registerExpressRoutes(app) {
131
136
  app.ws(this.config.networkPath, (ws) => {
132
137
  this.userNetworkingServer.connectClient(ws);
@@ -139,8 +144,8 @@ var Networked3dWebExperienceServer = class {
139
144
  }
140
145
  const webClientServing = this.config.webClientServing;
141
146
  if (webClientServing) {
142
- app.get(webClientServing.indexUrl, (req, res) => {
143
- const token = this.config.userAuthenticator.generateAuthorizedSessionToken(req);
147
+ app.get(webClientServing.indexUrl, async (req, res) => {
148
+ const token = await this.config.userAuthenticator.generateAuthorizedSessionToken(req);
144
149
  if (!token) {
145
150
  res.send("Error: Could not generate token");
146
151
  return;
@@ -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): 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 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 ): 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;;;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,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;",
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 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 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 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 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;AA0BvC,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,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,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.16.0",
3
+ "version": "0.18.0",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -18,15 +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.16.0",
22
- "@mml-io/3d-web-text-chat": "^0.16.0",
23
- "@mml-io/3d-web-user-networking": "^0.16.0",
24
- "@mml-io/3d-web-voice-chat": "^0.16.0",
25
- "three": "0.163.0"
21
+ "@mml-io/3d-web-client-core": "^0.18.0",
22
+ "@mml-io/3d-web-text-chat": "^0.18.0",
23
+ "@mml-io/3d-web-user-networking": "^0.18.0",
24
+ "@mml-io/3d-web-voice-chat": "^0.18.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.16.1",
30
+ "three": "0.163.0",
31
+ "ws": "^8.18.0"
26
32
  },
27
33
  "devDependencies": {
28
- "@types/node": "^20.12.7",
34
+ "@types/cors": "2.8.17",
35
+ "@types/express": "^4.17.21",
36
+ "@types/express-ws": "^3.0.4",
37
+ "@types/node": "^20.14.10",
29
38
  "@types/three": "0.163.0"
30
39
  },
31
- "gitHead": "c4ef44ae56497ed3cb9abaeee56be11dbc133460"
40
+ "gitHead": "8eb8acbdc767b15eacf3e8d62c5a0c92d2690f37"
32
41
  }