├── .babelrc ├── .gitignore ├── LICENSE ├── README.md ├── hubs.config.js ├── package-lock.json ├── package.json ├── pages ├── index.css └── index.js └── scripts ├── HubsSDKDevServer.js ├── HubsSDKWebpackPlugin.js ├── hubs-sdk-webpack-config.js └── hubs-sdk.js /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | "@babel/react", 4 | "@babel/env" 5 | ], 6 | "plugins": [ 7 | "@babel/plugin-syntax-dynamic-import", 8 | "@babel/proposal-class-properties" 9 | ] 10 | } 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | .hubs/ 3 | .DS_Store 4 | dist/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Mozilla Public License Version 2.0 2 | ================================== 3 | 4 | 1. Definitions 5 | -------------- 6 | 7 | 1.1. "Contributor" 8 | means each individual or legal entity that creates, contributes to 9 | the creation of, or owns Covered Software. 10 | 11 | 1.2. "Contributor Version" 12 | means the combination of the Contributions of others (if any) used 13 | by a Contributor and that particular Contributor's Contribution. 14 | 15 | 1.3. "Contribution" 16 | means Covered Software of a particular Contributor. 17 | 18 | 1.4. "Covered Software" 19 | means Source Code Form to which the initial Contributor has attached 20 | the notice in Exhibit A, the Executable Form of such Source Code 21 | Form, and Modifications of such Source Code Form, in each case 22 | including portions thereof. 23 | 24 | 1.5. "Incompatible With Secondary Licenses" 25 | means 26 | 27 | (a) that the initial Contributor has attached the notice described 28 | in Exhibit B to the Covered Software; or 29 | 30 | (b) that the Covered Software was made available under the terms of 31 | version 1.1 or earlier of the License, but not also under the 32 | terms of a Secondary License. 33 | 34 | 1.6. "Executable Form" 35 | means any form of the work other than Source Code Form. 36 | 37 | 1.7. "Larger Work" 38 | means a work that combines Covered Software with other material, in 39 | a separate file or files, that is not Covered Software. 40 | 41 | 1.8. "License" 42 | means this document. 43 | 44 | 1.9. "Licensable" 45 | means having the right to grant, to the maximum extent possible, 46 | whether at the time of the initial grant or subsequently, any and 47 | all of the rights conveyed by this License. 48 | 49 | 1.10. "Modifications" 50 | means any of the following: 51 | 52 | (a) any file in Source Code Form that results from an addition to, 53 | deletion from, or modification of the contents of Covered 54 | Software; or 55 | 56 | (b) any new file in Source Code Form that contains any Covered 57 | Software. 58 | 59 | 1.11. "Patent Claims" of a Contributor 60 | means any patent claim(s), including without limitation, method, 61 | process, and apparatus claims, in any patent Licensable by such 62 | Contributor that would be infringed, but for the grant of the 63 | License, by the making, using, selling, offering for sale, having 64 | made, import, or transfer of either its Contributions or its 65 | Contributor Version. 66 | 67 | 1.12. "Secondary License" 68 | means either the GNU General Public License, Version 2.0, the GNU 69 | Lesser General Public License, Version 2.1, the GNU Affero General 70 | Public License, Version 3.0, or any later versions of those 71 | licenses. 72 | 73 | 1.13. "Source Code Form" 74 | means the form of the work preferred for making modifications. 75 | 76 | 1.14. "You" (or "Your") 77 | means an individual or a legal entity exercising rights under this 78 | License. For legal entities, "You" includes any entity that 79 | controls, is controlled by, or is under common control with You. For 80 | purposes of this definition, "control" means (a) the power, direct 81 | or indirect, to cause the direction or management of such entity, 82 | whether by contract or otherwise, or (b) ownership of more than 83 | fifty percent (50%) of the outstanding shares or beneficial 84 | ownership of such entity. 85 | 86 | 2. License Grants and Conditions 87 | -------------------------------- 88 | 89 | 2.1. Grants 90 | 91 | Each Contributor hereby grants You a world-wide, royalty-free, 92 | non-exclusive license: 93 | 94 | (a) under intellectual property rights (other than patent or trademark) 95 | Licensable by such Contributor to use, reproduce, make available, 96 | modify, display, perform, distribute, and otherwise exploit its 97 | Contributions, either on an unmodified basis, with Modifications, or 98 | as part of a Larger Work; and 99 | 100 | (b) under Patent Claims of such Contributor to make, use, sell, offer 101 | for sale, have made, import, and otherwise transfer either its 102 | Contributions or its Contributor Version. 103 | 104 | 2.2. Effective Date 105 | 106 | The licenses granted in Section 2.1 with respect to any Contribution 107 | become effective for each Contribution on the date the Contributor first 108 | distributes such Contribution. 109 | 110 | 2.3. Limitations on Grant Scope 111 | 112 | The licenses granted in this Section 2 are the only rights granted under 113 | this License. No additional rights or licenses will be implied from the 114 | distribution or licensing of Covered Software under this License. 115 | Notwithstanding Section 2.1(b) above, no patent license is granted by a 116 | Contributor: 117 | 118 | (a) for any code that a Contributor has removed from Covered Software; 119 | or 120 | 121 | (b) for infringements caused by: (i) Your and any other third party's 122 | modifications of Covered Software, or (ii) the combination of its 123 | Contributions with other software (except as part of its Contributor 124 | Version); or 125 | 126 | (c) under Patent Claims infringed by Covered Software in the absence of 127 | its Contributions. 128 | 129 | This License does not grant any rights in the trademarks, service marks, 130 | or logos of any Contributor (except as may be necessary to comply with 131 | the notice requirements in Section 3.4). 132 | 133 | 2.4. Subsequent Licenses 134 | 135 | No Contributor makes additional grants as a result of Your choice to 136 | distribute the Covered Software under a subsequent version of this 137 | License (see Section 10.2) or under the terms of a Secondary License (if 138 | permitted under the terms of Section 3.3). 139 | 140 | 2.5. Representation 141 | 142 | Each Contributor represents that the Contributor believes its 143 | Contributions are its original creation(s) or it has sufficient rights 144 | to grant the rights to its Contributions conveyed by this License. 145 | 146 | 2.6. Fair Use 147 | 148 | This License is not intended to limit any rights You have under 149 | applicable copyright doctrines of fair use, fair dealing, or other 150 | equivalents. 151 | 152 | 2.7. Conditions 153 | 154 | Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted 155 | in Section 2.1. 156 | 157 | 3. Responsibilities 158 | ------------------- 159 | 160 | 3.1. Distribution of Source Form 161 | 162 | All distribution of Covered Software in Source Code Form, including any 163 | Modifications that You create or to which You contribute, must be under 164 | the terms of this License. You must inform recipients that the Source 165 | Code Form of the Covered Software is governed by the terms of this 166 | License, and how they can obtain a copy of this License. You may not 167 | attempt to alter or restrict the recipients' rights in the Source Code 168 | Form. 169 | 170 | 3.2. Distribution of Executable Form 171 | 172 | If You distribute Covered Software in Executable Form then: 173 | 174 | (a) such Covered Software must also be made available in Source Code 175 | Form, as described in Section 3.1, and You must inform recipients of 176 | the Executable Form how they can obtain a copy of such Source Code 177 | Form by reasonable means in a timely manner, at a charge no more 178 | than the cost of distribution to the recipient; and 179 | 180 | (b) You may distribute such Executable Form under the terms of this 181 | License, or sublicense it under different terms, provided that the 182 | license for the Executable Form does not attempt to limit or alter 183 | the recipients' rights in the Source Code Form under this License. 184 | 185 | 3.3. Distribution of a Larger Work 186 | 187 | You may create and distribute a Larger Work under terms of Your choice, 188 | provided that You also comply with the requirements of this License for 189 | the Covered Software. If the Larger Work is a combination of Covered 190 | Software with a work governed by one or more Secondary Licenses, and the 191 | Covered Software is not Incompatible With Secondary Licenses, this 192 | License permits You to additionally distribute such Covered Software 193 | under the terms of such Secondary License(s), so that the recipient of 194 | the Larger Work may, at their option, further distribute the Covered 195 | Software under the terms of either this License or such Secondary 196 | License(s). 197 | 198 | 3.4. Notices 199 | 200 | You may not remove or alter the substance of any license notices 201 | (including copyright notices, patent notices, disclaimers of warranty, 202 | or limitations of liability) contained within the Source Code Form of 203 | the Covered Software, except that You may alter any license notices to 204 | the extent required to remedy known factual inaccuracies. 205 | 206 | 3.5. Application of Additional Terms 207 | 208 | You may choose to offer, and to charge a fee for, warranty, support, 209 | indemnity or liability obligations to one or more recipients of Covered 210 | Software. However, You may do so only on Your own behalf, and not on 211 | behalf of any Contributor. You must make it absolutely clear that any 212 | such warranty, support, indemnity, or liability obligation is offered by 213 | You alone, and You hereby agree to indemnify every Contributor for any 214 | liability incurred by such Contributor as a result of warranty, support, 215 | indemnity or liability terms You offer. You may include additional 216 | disclaimers of warranty and limitations of liability specific to any 217 | jurisdiction. 218 | 219 | 4. Inability to Comply Due to Statute or Regulation 220 | --------------------------------------------------- 221 | 222 | If it is impossible for You to comply with any of the terms of this 223 | License with respect to some or all of the Covered Software due to 224 | statute, judicial order, or regulation then You must: (a) comply with 225 | the terms of this License to the maximum extent possible; and (b) 226 | describe the limitations and the code they affect. Such description must 227 | be placed in a text file included with all distributions of the Covered 228 | Software under this License. Except to the extent prohibited by statute 229 | or regulation, such description must be sufficiently detailed for a 230 | recipient of ordinary skill to be able to understand it. 231 | 232 | 5. Termination 233 | -------------- 234 | 235 | 5.1. The rights granted under this License will terminate automatically 236 | if You fail to comply with any of its terms. However, if You become 237 | compliant, then the rights granted under this License from a particular 238 | Contributor are reinstated (a) provisionally, unless and until such 239 | Contributor explicitly and finally terminates Your grants, and (b) on an 240 | ongoing basis, if such Contributor fails to notify You of the 241 | non-compliance by some reasonable means prior to 60 days after You have 242 | come back into compliance. Moreover, Your grants from a particular 243 | Contributor are reinstated on an ongoing basis if such Contributor 244 | notifies You of the non-compliance by some reasonable means, this is the 245 | first time You have received notice of non-compliance with this License 246 | from such Contributor, and You become compliant prior to 30 days after 247 | Your receipt of the notice. 248 | 249 | 5.2. If You initiate litigation against any entity by asserting a patent 250 | infringement claim (excluding declaratory judgment actions, 251 | counter-claims, and cross-claims) alleging that a Contributor Version 252 | directly or indirectly infringes any patent, then the rights granted to 253 | You by any and all Contributors for the Covered Software under Section 254 | 2.1 of this License shall terminate. 255 | 256 | 5.3. In the event of termination under Sections 5.1 or 5.2 above, all 257 | end user license agreements (excluding distributors and resellers) which 258 | have been validly granted by You or Your distributors under this License 259 | prior to termination shall survive termination. 260 | 261 | ************************************************************************ 262 | * * 263 | * 6. Disclaimer of Warranty * 264 | * ------------------------- * 265 | * * 266 | * Covered Software is provided under this License on an "as is" * 267 | * basis, without warranty of any kind, either expressed, implied, or * 268 | * statutory, including, without limitation, warranties that the * 269 | * Covered Software is free of defects, merchantable, fit for a * 270 | * particular purpose or non-infringing. The entire risk as to the * 271 | * quality and performance of the Covered Software is with You. * 272 | * Should any Covered Software prove defective in any respect, You * 273 | * (not any Contributor) assume the cost of any necessary servicing, * 274 | * repair, or correction. This disclaimer of warranty constitutes an * 275 | * essential part of this License. No use of any Covered Software is * 276 | * authorized under this License except under this disclaimer. * 277 | * * 278 | ************************************************************************ 279 | 280 | ************************************************************************ 281 | * * 282 | * 7. Limitation of Liability * 283 | * -------------------------- * 284 | * * 285 | * Under no circumstances and under no legal theory, whether tort * 286 | * (including negligence), contract, or otherwise, shall any * 287 | * Contributor, or anyone who distributes Covered Software as * 288 | * permitted above, be liable to You for any direct, indirect, * 289 | * special, incidental, or consequential damages of any character * 290 | * including, without limitation, damages for lost profits, loss of * 291 | * goodwill, work stoppage, computer failure or malfunction, or any * 292 | * and all other commercial damages or losses, even if such party * 293 | * shall have been informed of the possibility of such damages. This * 294 | * limitation of liability shall not apply to liability for death or * 295 | * personal injury resulting from such party's negligence to the * 296 | * extent applicable law prohibits such limitation. Some * 297 | * jurisdictions do not allow the exclusion or limitation of * 298 | * incidental or consequential damages, so this exclusion and * 299 | * limitation may not apply to You. * 300 | * * 301 | ************************************************************************ 302 | 303 | 8. Litigation 304 | ------------- 305 | 306 | Any litigation relating to this License may be brought only in the 307 | courts of a jurisdiction where the defendant maintains its principal 308 | place of business and such litigation shall be governed by laws of that 309 | jurisdiction, without reference to its conflict-of-law provisions. 310 | Nothing in this Section shall prevent a party's ability to bring 311 | cross-claims or counter-claims. 312 | 313 | 9. Miscellaneous 314 | ---------------- 315 | 316 | This License represents the complete agreement concerning the subject 317 | matter hereof. If any provision of this License is held to be 318 | unenforceable, such provision shall be reformed only to the extent 319 | necessary to make it enforceable. Any law or regulation which provides 320 | that the language of a contract shall be construed against the drafter 321 | shall not be used to construe this License against a Contributor. 322 | 323 | 10. Versions of the License 324 | --------------------------- 325 | 326 | 10.1. New Versions 327 | 328 | Mozilla Foundation is the license steward. Except as provided in Section 329 | 10.3, no one other than the license steward has the right to modify or 330 | publish new versions of this License. Each version will be given a 331 | distinguishing version number. 332 | 333 | 10.2. Effect of New Versions 334 | 335 | You may distribute the Covered Software under the terms of the version 336 | of the License under which You originally received the Covered Software, 337 | or under the terms of any subsequent version published by the license 338 | steward. 339 | 340 | 10.3. Modified Versions 341 | 342 | If you create software not governed by this License, and you want to 343 | create a new license for such software, you may create and use a 344 | modified version of this License if you rename the license and remove 345 | any references to the name of the license steward (except to note that 346 | such modified license differs from this License). 347 | 348 | 10.4. Distributing Source Code Form that is Incompatible With Secondary 349 | Licenses 350 | 351 | If You choose to distribute Source Code Form that is Incompatible With 352 | Secondary Licenses under the terms of this version of the License, the 353 | notice described in Exhibit B of this License must be attached. 354 | 355 | Exhibit A - Source Code Form License Notice 356 | ------------------------------------------- 357 | 358 | This Source Code Form is subject to the terms of the Mozilla Public 359 | License, v. 2.0. If a copy of the MPL was not distributed with this 360 | file, You can obtain one at http://mozilla.org/MPL/2.0/. 361 | 362 | If it is not possible or desirable to put the notice in a particular 363 | file, then You may include the notice in a location (such as a LICENSE 364 | file in a relevant directory) where a recipient would be likely to look 365 | for such a notice. 366 | 367 | You may add additional accurate notices of copyright ownership. 368 | 369 | Exhibit B - "Incompatible With Secondary Licenses" Notice 370 | --------------------------------------------------------- 371 | 372 | This Source Code Form is "Incompatible With Secondary Licenses", as 373 | defined by the Mozilla Public License, v. 2.0. 374 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # hubs-plugin-api 2 | 3 | Example project to showcase Hubs plugin development with Webpack and evaluate the plugin API. 4 | 5 | **This API is experimental and will change** 6 | 7 | Please give us feedback on the API in the #extensibility channel on our [Discord server](https://discord.gg/vgxfMpr). 8 | 9 | ## Getting Started 10 | 11 | Run the following commands: 12 | 13 | ```bash 14 | git clone https://github.com/MozillaReality/hubs-plugin-api.git 15 | cd hubs-plugin-api 16 | npm install 17 | npm start 18 | ``` 19 | 20 | Open https://localhost:8080 21 | 22 | Modify `pages/index.js` to modify the landing page. 23 | 24 | You can also run `npm run build` to see what a production build of your plugin would look like. 25 | 26 | At this time there is no way to use the plugin with your Hubs Cloud instance, this project is only intended for evaluation of the API. 27 | 28 | ## Hubs Plugin System 29 | 30 | When you run your own Hubs Cloud instance the Hubs client and the rest of the stack will receive automatic updates with the latest features of Hubs. In order to maintain the ability to automatically update your Hubs client we have designed a plugin system which loads plugin scripts at runtime. The APIs exposed to you will be versioned and maintained in a way that will avoid breakage when your Hubs Cloud packages are updated. 31 | 32 | Plugins are exposed as ES2015 javascript modules that are dynamically loaded at predefined places in the Hubs client. Modules are broken up based on the page/feature they are intended to be used with. This keeps the amount of javascript loaded to a minimum and improves page load time. You may use the `registerPlugin` function to expose React Components and more to the Hubs client. 33 | 34 | ```jsx 35 | import Hubs from "@hubs/core"; 36 | import React from "react"; 37 | 38 | function HomePage() { 39 | return
Hello World!
; 40 | } 41 | 42 | Hubs.registerPlugin("home-page", HomePage); 43 | ``` 44 | 45 | Plugins are defined in the Hubs `APP_CONFIG` global object that is included in the `` tag of each page. 46 | 47 | ```js 48 | window.APP_CONFIG = { 49 | plugins: { 50 | "home-page": [ 51 | { 52 | type: "js", 53 | url: "/index.plugin.js", 54 | dependencies: ["react", "prop-types", "@hubs/core", "@hubs/home-page"] 55 | } 56 | ] 57 | } 58 | }; 59 | ``` 60 | 61 | Currently this configuration is injected into each page by the `HubsDevServer`, in production the Hubs backend server (Reticulum) injects the `APP_CONFIG` into the page. 62 | 63 | You register plugins in the `hubs.config.js` file. This is consumed in the `HubsDevServer` to generate the `APP_CONFIG` and in webpack to generate the entry points. 64 | 65 | ```js 66 | module.exports = { 67 | name: "my-plugin", 68 | version: "0.0.1", 69 | hooks: { 70 | "home-page": ["./pages/index.js"] 71 | } 72 | }; 73 | ``` 74 | 75 | ## Hubs SDK 76 | 77 | The current Hubs SDK is focused on extending the home page so it is extremely limited in scope. At this point we are looking to hear from developers on what components they need from us to build their home page experience. 78 | 79 | The Hubs SDK is exposed as a global variable when your plugin is loaded into the page. 80 | 81 | ```js 82 | window.Hubs.core 83 | ``` 84 | 85 | Our webpack config also lets you use ES2015 imports, these will be swapped out with references to global variables at build time. 86 | 87 | ```js 88 | import Hubs from "@hubs/core"; 89 | ``` 90 | 91 | ## Hubs SDK Packages 92 | 93 | The Hubs SDK is broken into packages that 94 | 95 | - Hubs.core / @hubs/core - Core API methods 96 | - Hubs.react / @hubs/react - Common React components and styles. 97 | - Hubs.homePage / @hubs/home-page - Components and Hooks used on the home page. 98 | - Hubs.mediaBrowser / @hubs/media-browser - Components and styles for the media browser. 99 | 100 | ### Hubs.core / @Hubs/core 101 | 102 | #### .isAuthenticated(): boolean 103 | 104 | Returns true if the user has an authentication token stored in local storage. 105 | 106 | ##### Example: 107 | 108 | ```js 109 | Hub.core.isAuthenticated() === true 110 | ``` 111 | 112 | #### .getAuthToken(): string | undefined 113 | 114 | Return the authentication token for the user. Returns `undefined` if the user is not logged in. 115 | 116 | ##### Example: 117 | 118 | ```js 119 | Hubs.core.getAuthToken() === "super-secret-token" 120 | ``` 121 | 122 | #### .postJSON(path, payload, options?): Promise\ 123 | 124 | Make a POST request with a json body to Reticulum. `options` are the same options passed to the fetch API. Returns the json parsed response. 125 | 126 | ##### Example: 127 | 128 | ```js 129 | const response = await Hubs.core.postJSON("/api/v1/hubs", { 130 | hub: { 131 | name: "My Room" 132 | } 133 | }); 134 | ``` 135 | 136 | #### .postJSONAuthenticated(path, payload, options?): Promise\ 137 | 138 | Make an authenticated POST request with a json body to Reticulum. `options` are the same options passed to the fetch API. Returns the json parsed response. Throws an error if the user is not currently logged in. 139 | 140 | ##### Example: 141 | 142 | ```js 143 | const response = await Hubs.core.postJSONAuthenticated("/api/v1/hubs", { 144 | hub: { 145 | name: "My Room" 146 | } 147 | }); 148 | ``` 149 | 150 | #### .createRoom(params?): Promise\ 151 | 152 | Create a room for the current user. If the user is not logged in the room will be created anonymously. 153 | 154 | ##### Request: 155 | ```ts 156 | { 157 | name?: string 158 | description?: string 159 | scene_id?: string 160 | room_size?: number 161 | user_data?: {} 162 | } 163 | 164 | ``` 165 | 166 | ##### Response: 167 | ```ts 168 | { 169 | creator_assignment_token: string 170 | embed_token: string 171 | hub_id: string 172 | status: string 173 | url: string 174 | } 175 | ``` 176 | 177 | ##### Example: 178 | 179 | ```js 180 | const response = await Hubs.core.createRoom({ 181 | name: "My Room", 182 | scene_id: "123abc" 183 | }); 184 | ``` 185 | 186 | #### .config.feature(featureName): boolean | string | undefined 187 | 188 | Check if a feature is enabled by the current app config. Features are defined in the Hubs [schema.toml](https://github.com/mozilla/hubs/blob/master/src/schema.toml) file and correspond to configuration in the admin panel. 189 | 190 | ##### Example: 191 | 192 | ```js 193 | Hubs.core.config.feature("disable_room_creation") === false 194 | ``` 195 | 196 | #### .config.image(imageName, cssUrl?): string | undefined 197 | 198 | Get an image url from the current app config. Images are defined in the Hubs [schema.toml](https://github.com/mozilla/hubs/blob/master/src/schema.toml) file and correspond to configuration in the admin panel. 199 | 200 | ##### Example: 201 | 202 | ```js 203 | Hubs.config.image("logo") === "https://my-hubs-cloud.com/logo.png"; 204 | 205 | // cssUrl = true 206 | Hubs.config.image("logo", true) === "url(https://my-hubs-cloud.com/logo.png)"; 207 | ``` 208 | 209 | #### .config.link(linkName, defaultValue?) string | undefined 210 | 211 | Get a url from the current app config. Links are defined in the Hubs [schema.toml](https://github.com/mozilla/hubs/blob/master/src/schema.toml) file and correspond to configuration in the admin panel. 212 | 213 | ##### Example: 214 | 215 | ```js 216 | Hubs.config.link("docs", "https://hubs.mozilla.com/docs") === "https://hubs.mozilla.com/docs"; 217 | ``` 218 | 219 | ### Hubs.react / @hubs/react 220 | To Do 221 | 222 | ### Hubs.homePage / @hubs/home-page 223 | To Do 224 | 225 | ### Hubs.mediaBrowser / @hubs/media-browser 226 | To Do 227 | 228 | ## Developing Plugins Against a Local Copy of Hubs 229 | 230 | You can load a plugin in a local Hubs dev server by passing the `--env.pluginManifest=` option. 231 | 232 | ##### Example: 233 | 234 | Start the plugin dev server on a port other than 8080. 235 | 236 | ``` 237 | cd hubs-plugin-api 238 | npm start -- --port 8081 239 | ``` 240 | 241 | Start the Hubs dev server with the plugin manifest url. 242 | 243 | ``` 244 | cd hubs 245 | npm run dev -- --env.pluginManifest="https://localhost:8081/plugin-manifest.json" 246 | ``` 247 | -------------------------------------------------------------------------------- /hubs.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | name: "my-plugin", 3 | version: "0.0.1", 4 | hooks: { 5 | "home-page": ["./pages/index.js"] 6 | } 7 | }; 8 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "hubs-plugin-api", 3 | "private": true, 4 | "version": "0.0.1", 5 | "scripts": { 6 | "start": "node ./scripts/hubs-sdk.js serve", 7 | "build": "node ./scripts/hubs-sdk.js build" 8 | }, 9 | "license": "MPL-2.0", 10 | "devDependencies": { 11 | "@babel/core": "^7.10.2", 12 | "@babel/plugin-proposal-class-properties": "^7.10.1", 13 | "@babel/plugin-syntax-dynamic-import": "^7.8.3", 14 | "@babel/preset-env": "^7.10.2", 15 | "@babel/preset-react": "^7.10.1", 16 | "@iarna/toml": "^2.2.5", 17 | "babel-loader": "^8.1.0", 18 | "chalk": "^4.1.0", 19 | "commander": "^5.1.0", 20 | "cors": "^2.8.5", 21 | "css-loader": "^3.5.3", 22 | "express-http-proxy": "^1.6.0", 23 | "hubs-client": "0.0.9", 24 | "node-fetch": "^2.6.0", 25 | "request": "^2.88.2", 26 | "rimraf": "^3.0.2", 27 | "selfsigned": "^1.10.7", 28 | "spoke-client": "0.0.4", 29 | "style-loader": "^1.2.1", 30 | "webpack": "^4.43.0", 31 | "webpack-cli": "^3.3.11", 32 | "webpack-dev-server": "^3.11.0", 33 | "webpack-hot-middleware": "^2.25.0" 34 | }, 35 | "dependencies": { 36 | "webpack-dev-middleware": "^3.7.2" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /pages/index.css: -------------------------------------------------------------------------------- 1 | :local(.page) { 2 | background-color: rgb(198, 198, 198); 3 | } -------------------------------------------------------------------------------- /pages/index.js: -------------------------------------------------------------------------------- 1 | import React, { useContext } from "react"; 2 | import { FormattedMessage } from "react-intl"; 3 | import classNames from "classnames"; 4 | import Hubs from "@hubs/core"; 5 | import { Page, IfFeature, AuthContext } from "@hubs/react"; 6 | import { MediaTiles, styles as mediaBrowserStyles } from "@hubs/media-browser"; 7 | import { 8 | PWAButton, 9 | CreateRoomButton, 10 | useFeaturedRooms, 11 | useHomePageRedirect, 12 | PageStyles as styles, 13 | discordLogoSmall 14 | } from "@hubs/home-page"; 15 | import customStyles from "./index.css"; 16 | 17 | function HomePage() { 18 | useHomePageRedirect(); 19 | const featuredRooms = useFeaturedRooms(); 20 | const auth = useContext(AuthContext); 21 | 22 | const config = Hubs.config; 23 | const canCreateRooms = !config.feature("disable_room_creation") || auth.isAdmin; 24 | 25 | return ( 26 | 27 |
28 |
29 |
30 |
31 | 32 |
33 | {featuredRooms.length === 0 && ( 34 |
35 | 36 |
37 | )} 38 |
39 |
40 | {canCreateRooms && } 41 | 42 |
43 |
44 | {featuredRooms.length > 0 && ( 45 |
46 |
47 |
48 | 49 |
50 |
51 |
52 | )} 53 |
54 |
55 |
56 | 57 | 58 | 59 |
60 | 61 | 62 |
63 |
64 | 65 |
66 | 67 | 68 | 69 | 70 |
71 | 72 |
73 |
74 | 75 |
76 |
77 |
78 | 79 | ); 80 | } 81 | 82 | Hubs.registerPlugin("home-page", { HomePage }); 83 | -------------------------------------------------------------------------------- /scripts/HubsSDKDevServer.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const serveStatic = require("serve-static"); 3 | const cors = require("cors"); 4 | const request = require("request"); 5 | const selfsigned = require("selfsigned"); 6 | const fs = require("fs"); 7 | const promisify = require("util").promisify; 8 | const generateSelfsignedAsync = promisify(selfsigned.generate); 9 | const TOML = require("@iarna/toml"); 10 | const fetch = require("node-fetch"); 11 | const express = require("express"); 12 | const https = require("https"); 13 | 14 | async function createHTTPSConfig(certsPath) { 15 | const privKeyPath = path.join(certsPath, "key.pem"); 16 | const pubKeyPath = path.join(certsPath, "cert.pem"); 17 | 18 | if (fs.existsSync(certsPath)) { 19 | const key = await fs.promises.readFile(privKeyPath); 20 | const cert = await fs.promises.readFile(pubKeyPath); 21 | 22 | return { key, cert }; 23 | } 24 | 25 | const pems = await generateSelfsignedAsync( 26 | [ 27 | { 28 | name: "commonName", 29 | value: "localhost" 30 | } 31 | ], 32 | { 33 | days: 365, 34 | keySize: 2048, 35 | algorithm: "sha256", 36 | extensions: [ 37 | { 38 | name: "subjectAltName", 39 | altNames: [ 40 | { 41 | type: 2, 42 | value: "localhost" 43 | } 44 | ] 45 | } 46 | ] 47 | } 48 | ); 49 | 50 | await fs.promises.mkdir(certsPath, { recursive: true }); 51 | await fs.promises.writeFile(pubKeyPath, pems.cert); 52 | await fs.promises.writeFile(privKeyPath, pems.private); 53 | 54 | return { 55 | key: pems.private, 56 | cert: pems.cert 57 | }; 58 | } 59 | 60 | async function createDefaultConfig(hubsPath, port) { 61 | const schemaPath = path.join(hubsPath, "schema.toml"); 62 | const schemaString = (await fs.promises.readFile(schemaPath)).toString(); 63 | 64 | let appConfigSchema; 65 | 66 | try { 67 | appConfigSchema = await TOML.parse.async(schemaString); 68 | } catch (e) { 69 | console.error("Error parsing schema.toml on line " + e.line + ", column " + e.column + ": " + e.message); 70 | throw e; 71 | } 72 | 73 | const appConfig = {}; 74 | 75 | for (const [categoryName, category] of Object.entries(appConfigSchema)) { 76 | appConfig[categoryName] = {}; 77 | 78 | // Enable all features with a boolean type 79 | if (categoryName === "features") { 80 | for (const [key, schema] of Object.entries(category)) { 81 | if (key === "require_account_for_join" || key === "disable_room_creation") { 82 | appConfig[categoryName][key] = false; 83 | } else { 84 | appConfig[categoryName][key] = schema.type === "boolean" ? true : null; 85 | } 86 | } 87 | } 88 | } 89 | 90 | appConfig.translations = { 91 | en: { 92 | "app-name": "Hubs", 93 | "editor-name": "Spoke" 94 | } 95 | }; 96 | 97 | const env = { 98 | HUBS_SERVER:`localhost:${port}`, 99 | RETICULUM_SERVER: "dev.reticulum.io", 100 | SHORTLINK_DOMAIN: "hubs.link", 101 | CORS_PROXY_SERVER: `localhost:${port}/cors-proxy`, 102 | THUMBNAIL_SERVER: "nearspark-dev.reticulum.io", 103 | NON_CORS_PROXY_DOMAINS: "localhost", 104 | IS_MOZ: "false" 105 | }; 106 | 107 | return { appConfig, env }; 108 | } 109 | 110 | async function loadRemoteConfig(credentialsPath, port) { 111 | const { host, token } = JSON.parse(await fs.promises.readFile(credentialsPath)); 112 | 113 | const headers = { 114 | Authorization: `Bearer ${token}`, 115 | "Content-Type": "application/json" 116 | }; 117 | 118 | // Load the Hubs Cloud instance's app config in development 119 | const appConfigsResponse = await fetch(`https://${host}/api/v1/app_configs`, { headers }); 120 | 121 | if (!appConfigsResponse.ok) { 122 | throw new Error(`Error fetching Hubs Cloud config "${appConfigsResponse.statusText}"`); 123 | } 124 | 125 | const appConfig = await appConfigsResponse.json(); 126 | 127 | const hubsConfigsResponse = await fetch(`https://${host}/api/ita/configs/hubs`, { headers }); 128 | 129 | const hubsConfigs = await hubsConfigsResponse.json(); 130 | 131 | if (!hubsConfigsResponse.ok) { 132 | throw new Error(`Error fetching Hubs Cloud config "${hubsConfigsResponse.statusText}"`); 133 | } 134 | 135 | const { shortlink_domain, thumbnail_server } = hubsConfigs.general; 136 | 137 | const env = { 138 | HUBS_SERVER:`localhost:${port}`, 139 | IS_MOZ: "false", 140 | RETICULUM_SERVER: host, 141 | SHORTLINK_DOMAIN: shortlink_domain, 142 | CORS_PROXY_SERVER: `localhost:${port}/cors-proxy`, 143 | THUMBNAIL_SERVER: thumbnail_server, 144 | NON_CORS_PROXY_DOMAINS: "localhost" 145 | }; 146 | 147 | return { appConfig, env }; 148 | } 149 | 150 | class HubsSDKDevServer { 151 | constructor(options) { 152 | const projectPath = options.projectPath || process.cwd(); 153 | 154 | this.options = Object.assign({ 155 | port: 8081, 156 | appConfig: undefined, 157 | projectPath, 158 | hubsCacheDir: path.join(projectPath, ".hubs"), 159 | hubsPath: path.join(projectPath, "node_modules", "hubs-client", "dist"), 160 | spokePath: path.join(projectPath, "node_modules", "spoke-client", "dist"), 161 | }, options); 162 | } 163 | 164 | async init() { 165 | const credentialsPath = path.join(this.options.hubsCacheDir, ".hubs-cloud-credentials"); 166 | 167 | let config; 168 | 169 | if (fs.existsSync(credentialsPath)) { 170 | config = await loadRemoteConfig(credentialsPath, this.options.port); 171 | } else { 172 | config = await createDefaultConfig(this.options.hubsPath, this.options.port); 173 | } 174 | 175 | config.appConfig.pluginManifests = ["/plugin-manifest.json"]; 176 | 177 | const { appConfig, env } = config; 178 | 179 | const metaTags = []; 180 | 181 | for (let key in env) { 182 | metaTags.push(``); 183 | } 184 | 185 | const metaTagHeader = metaTags.join("\n"); 186 | 187 | const appConfigheader = ``; 188 | 189 | const translations = appConfig.translations.en; 190 | 191 | const spokeHeader = ` 192 | ${metaTagHeader} 193 | 194 | ${translations["editor-name"]} 195 | ${appConfigheader}`; 196 | 197 | const hubsHeader = ` 198 | ${metaTagHeader} 199 | 200 | ${translations["app-name"]} 201 | ${appConfigheader}`; 202 | 203 | const app = this.app = express(); 204 | 205 | app.use(cors()); 206 | 207 | app.use((req, res, next) => { 208 | if (req.method === "HEAD") { 209 | res.append("Date", new Date().toGMTString()); 210 | } 211 | next(); 212 | }); 213 | 214 | app.all("/cors-proxy/*", (req, res) => { 215 | res.header("Access-Control-Allow-Origin", "*"); 216 | res.header("Access-Control-Allow-Methods", "GET, HEAD, OPTIONS"); 217 | res.header("Access-Control-Allow-Headers", "Range"); 218 | res.header( 219 | "Access-Control-Expose-Headers", 220 | "Accept-Ranges, Content-Encoding, Content-Length, Content-Range, Hub-Name, Hub-Entity-Type" 221 | ); 222 | res.header("Vary", "Origin"); 223 | res.header("X-Content-Type-Options", "nosniff"); 224 | 225 | const redirectLocation = req.header("location"); 226 | 227 | if (redirectLocation) { 228 | res.header("Location", `https://localhost:${this.options.port}/cors-proxy/` + redirectLocation); 229 | } 230 | 231 | if (req.method === "OPTIONS") { 232 | res.send(); 233 | } else { 234 | const url = req.path.replace("/cors-proxy/", ""); 235 | request({ url, method: req.method }, error => { 236 | if (error) { 237 | console.error(`cors-proxy: error fetching "${url}"\n`, error); 238 | return; 239 | } 240 | }).pipe(res); 241 | } 242 | }); 243 | 244 | const pageHandler = (filePath, header) => async (req, res) => { 245 | const data = await fs.promises.readFile(filePath); 246 | let html = data.toString(); 247 | html = html.replace("", header); 248 | res.send(html); 249 | }; 250 | 251 | if (this.options.spokePath) { 252 | const spokePageHandler = pageHandler(path.join(this.options.spokePath, "index.html"), spokeHeader); 253 | app.get("/spoke/?", spokePageHandler); 254 | app.use("/spoke", serveStatic(this.options.spokePath)); 255 | app.use("/spoke/*", (req, res, next) => { 256 | if ((req.method === "GET" || req.method === "HEAD") && req.accepts("html")) { 257 | return spokePageHandler(req, res); 258 | } else { 259 | return next(); 260 | } 261 | }); 262 | } 263 | 264 | if (this.options.hubsPath) { 265 | const addHubHeaders = (type) => (req, res, next) => { 266 | res.header("hub-name", appConfig.translations.en["app-name"]); 267 | res.header("hub-entity-type", type); 268 | next(); 269 | }; 270 | 271 | app.get("/", addHubHeaders("hub"), pageHandler(path.join(this.options.hubsPath, "index.html"), hubsHeader)); 272 | app.get("/whats-new", pageHandler(path.join(this.options.hubsPath, "whats-new.html"), hubsHeader)); 273 | app.get("/signin", pageHandler(path.join(this.options.hubsPath, "signin.html"), hubsHeader)); 274 | app.get("/verify", pageHandler(path.join(this.options.hubsPath, "verify.html"), hubsHeader)); 275 | app.get("/cloud", pageHandler(path.join(this.options.hubsPath, "cloud.html"), hubsHeader)); 276 | app.get("/discord", pageHandler(path.join(this.options.hubsPath, "discord.html"), hubsHeader)); 277 | app.get("/link/?*", pageHandler(path.join(this.options.hubsPath, "link.html"), hubsHeader)); 278 | app.get("/scene/?*", addHubHeaders("scene"), pageHandler(path.join(this.options.hubsPath, "scene.html"), hubsHeader)); 279 | app.get("/avatar/?*", addHubHeaders("avatar"), pageHandler(path.join(this.options.hubsPath, "avatar.html"), hubsHeader)); 280 | app.use(serveStatic(this.options.hubsPath)); 281 | 282 | const hubPageHandler = pageHandler(path.join(this.options.hubsPath, "hub.html"), hubsHeader); 283 | app.get("/hub.html*", addHubHeaders("room"), hubPageHandler); 284 | app.get(/^\/([a-zA-Z0-9]{7})$/, addHubHeaders("room"), hubPageHandler); 285 | app.get(/^\/([a-zA-Z0-9]{7}\/.*)/, addHubHeaders("room"), hubPageHandler); 286 | } 287 | } 288 | 289 | async listen(...args) { 290 | const certsPath = path.join(this.options.hubsCacheDir, "certs"); 291 | const httpsConfig = await createHTTPSConfig(certsPath); 292 | const server = https.createServer(httpsConfig, this.app); 293 | server.listen(...args); 294 | } 295 | } 296 | 297 | module.exports = HubsSDKDevServer; -------------------------------------------------------------------------------- /scripts/HubsSDKWebpackPlugin.js: -------------------------------------------------------------------------------- 1 | const { ExternalsPlugin } = require("webpack"); 2 | const { RawSource } = require("webpack-sources"); 3 | 4 | const HUBS_NAMESPACE = "@hubs/"; 5 | 6 | function camelCaseDash(string) { 7 | return string.replace(/-([a-z])/g, (_, letter) => letter.toUpperCase()); 8 | } 9 | 10 | function defaultRequestToExternal(request) { 11 | switch (request) { 12 | case "three": 13 | return "THREE"; 14 | case "react": 15 | return "React"; 16 | case "react-dom": 17 | return "ReactDOM"; 18 | case "react-intl": 19 | return "ReactIntl"; 20 | case "prop-types": 21 | return "PropTypes"; 22 | case "classnames": 23 | return "ClassNames"; 24 | } 25 | 26 | if (request.startsWith(HUBS_NAMESPACE)) { 27 | return ["Hubs", camelCaseDash(request.substring(HUBS_NAMESPACE.length))]; 28 | } 29 | } 30 | 31 | class HubsSDKWebpackPlugin { 32 | constructor(config) { 33 | this.config = config; 34 | this.externalizedDeps = new Set(); 35 | this.externalsPlugin = new ExternalsPlugin("window", this.externalizeHubsDeps.bind(this)); 36 | } 37 | 38 | externalizeHubsDeps(_context, request, callback) { 39 | const externalRequest = defaultRequestToExternal(request); 40 | 41 | if (externalRequest) { 42 | this.externalizedDeps.add(request); 43 | return callback(null, externalRequest); 44 | } 45 | 46 | return callback(); 47 | } 48 | 49 | apply(compiler) { 50 | this.externalsPlugin.apply(compiler); 51 | 52 | const outputFilename = compiler.options.output.filename; 53 | const config = this.config; 54 | 55 | compiler.hooks.emit.tap(this.constructor.name, compilation => { 56 | const hooks = {}; 57 | 58 | for (const hookName in this.config.hooks) { 59 | hooks[hookName] = []; 60 | } 61 | 62 | for (const [entryPointName, entryPoint] of compilation.entrypoints.entries()) { 63 | for (const chunk of entryPoint.chunks) { 64 | const entryDependencies = new Set(); 65 | 66 | for (const { userRequest } of chunk.modulesIterable) { 67 | if (this.externalizedDeps.has(userRequest)) { 68 | entryDependencies.add(userRequest); 69 | } 70 | } 71 | 72 | const dependencies = Array.from(entryDependencies); 73 | 74 | const url = compilation.getPath(outputFilename, { 75 | chunk 76 | }); 77 | 78 | for (const hookName in config.hooks) { 79 | for (const hookEntryPointName of config.hooks[hookName]) { 80 | if (hookEntryPointName === entryPointName) { 81 | hooks[hookName].push({ 82 | type: "js", 83 | url, 84 | dependencies 85 | }); 86 | } 87 | } 88 | } 89 | } 90 | } 91 | 92 | const pluginManifest = { 93 | name: this.config.name, 94 | version: this.config.version, 95 | hooks 96 | }; 97 | 98 | compilation.assets["plugin-manifest.json"] = new RawSource(JSON.stringify(pluginManifest)); 99 | }); 100 | } 101 | } 102 | 103 | module.exports = HubsSDKWebpackPlugin; 104 | -------------------------------------------------------------------------------- /scripts/hubs-sdk-webpack-config.js: -------------------------------------------------------------------------------- 1 | const path = require("path"); 2 | const HubsWebpackPlugin = require("./HubsSDKWebpackPlugin"); 3 | 4 | module.exports = (hubsConfigPath, _env, args) => { 5 | const { name, version, hooks } = require(hubsConfigPath); 6 | const projectPath = path.dirname(hubsConfigPath); 7 | 8 | const hubsPluginConfig = { 9 | name, 10 | version, 11 | hooks: {} 12 | }; 13 | 14 | const entry = {}; 15 | 16 | for (const hookName in hooks) { 17 | const pluginHooks = []; 18 | 19 | for (const file of hooks[hookName]) { 20 | const { name: entryPointName } = path.parse(file); 21 | entry[entryPointName] = path.resolve(projectPath, file); 22 | pluginHooks.push(entryPointName); 23 | } 24 | 25 | hubsPluginConfig.hooks[hookName] = pluginHooks; 26 | } 27 | 28 | return { 29 | mode: args && args.mode, 30 | entry, 31 | module: { 32 | rules: [ 33 | { 34 | test: /\.(js)$/, 35 | exclude: /node_modules/, 36 | use: { 37 | loader: "babel-loader" 38 | } 39 | }, 40 | { 41 | test: /\.css$/i, 42 | use: [ 43 | "style-loader", 44 | { 45 | loader: "css-loader", 46 | options: { 47 | modules: true 48 | } 49 | } 50 | ] 51 | } 52 | ] 53 | }, 54 | output: { 55 | path: path.resolve(projectPath, "dist"), 56 | filename: "[name].plugin.js", 57 | publicPath: "/" + name 58 | }, 59 | devtool: args && args.mode === "production" ? "source-map" : "eval-source-map", 60 | plugins: [new HubsWebpackPlugin(hubsPluginConfig)] 61 | }; 62 | }; 63 | -------------------------------------------------------------------------------- /scripts/hubs-sdk.js: -------------------------------------------------------------------------------- 1 | const Commander = require("commander"); 2 | const chalk = require("chalk"); 3 | const webpack = require("webpack"); 4 | const hubsSDKWebpackConfig = require("./hubs-sdk-webpack-config"); 5 | const packageJson = require("../package.json"); 6 | const HubsSDKDevServer = require("./HubsSDKDevServer"); 7 | const path = require("path"); 8 | const webpackDevMiddleware = require("webpack-dev-middleware"); 9 | const webpackHotMiddleware = require("webpack-hot-middleware"); 10 | const promisify = require("util").promisify; 11 | const rimraf = require("rimraf"); 12 | const rimrafAsync = promisify(rimraf); 13 | 14 | const program = new Commander.Command("hubs-sdk") 15 | .version(packageJson.version); 16 | 17 | program 18 | .command("serve [project-path]") 19 | .option("-p --port ", "The port to serve on.", 8080) 20 | .description("Serve the project for plugin development.") 21 | .action(async (projectPathArg, cmd) => { 22 | console.log(`Starting dev server at https://localhost:${cmd.port}`); 23 | 24 | const projectPath = resolveProjectPath(projectPathArg); 25 | const hubsConfigPath = path.resolve(projectPath, "hubs.config.js"); 26 | const devServer = new HubsSDKDevServer({ port: cmd.port, projectPath }); 27 | await devServer.init(); 28 | const webpackConfig = hubsSDKWebpackConfig(hubsConfigPath, undefined, { mode: "development" }); 29 | 30 | for (let entryName in webpackConfig.entry) { 31 | if (Array.isArray(webpackConfig.entry[entryName])) { 32 | webpackConfig.entry[entryName].push("webpack-hot-middleware/client?reload=true"); 33 | } else { 34 | webpackConfig.entry[entryName] = [webpackConfig.entry[entryName], "webpack-hot-middleware/client?reload=true"]; 35 | } 36 | } 37 | 38 | webpackConfig.plugins.push(new webpack.HotModuleReplacementPlugin()); 39 | const compiler = webpack(webpackConfig); 40 | devServer.app.use(webpackDevMiddleware(compiler)); 41 | devServer.app.use(webpackHotMiddleware(compiler)); 42 | await devServer.listen(cmd.port); 43 | }); 44 | 45 | program 46 | .command("build [project-path]") 47 | .description("Build the plugin project.") 48 | .action(async (projectPathArg) => { 49 | const projectPath = resolveProjectPath(projectPathArg); 50 | 51 | await rimrafAsync(path.join(projectPath, "dist")); 52 | 53 | const hubsConfigPath = path.resolve(projectPath, "hubs.config.js"); 54 | const webpackConfig = hubsSDKWebpackConfig(hubsConfigPath, undefined, { mode: "production" }); 55 | 56 | console.log("Building plugins..."); 57 | webpack(webpackConfig, (err, stats) => { 58 | if (err) { 59 | console.error(err.stack || err); 60 | if (err.details) { 61 | console.error(err.details); 62 | } 63 | return; 64 | } 65 | 66 | const info = stats.toJson(); 67 | 68 | if (stats.hasErrors()) { 69 | console.error(info.errors); 70 | } 71 | 72 | if (stats.hasWarnings()) { 73 | console.warn(info.warnings); 74 | } 75 | 76 | console.log("Plugins built. See the dist/ folder for the output."); 77 | }); 78 | }); 79 | 80 | async function main() { 81 | await program.parseAsync(process.argv); 82 | } 83 | 84 | main().catch((error) => { 85 | console.error(chalk.red("Error running command:")); 86 | console.error(" " + chalk.red(error)); 87 | process.exit(1) 88 | }); 89 | 90 | function resolveProjectPath(projectPathArg) { 91 | return projectPathArg ? path.resolve(process.cwd(), projectPathArg) : process.cwd(); 92 | } --------------------------------------------------------------------------------