├── .gitignore ├── LICENSE ├── README.md ├── package.json └── src ├── constants.js ├── index.js └── rpc └── command.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | package-lock.json -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 big nutty 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ActivitySDK 2 | ![npm](https://img.shields.io/npm/v/activitysdk) 3 | 4 | Unofficial SDK to communicate between the discord client and an embedded activity. 5 | 6 | ## Using activitysdk 7 | For an example of how to integrate activitysdk into your project, check out [activity-framework](https://github.com/justsomederpystuff/activity-framework/). 8 | 9 | If you have any further questions, feel free to ask them in my [discord server](https://discord.gg/DDg5Z7kZvs). -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "activitysdk", 3 | "version": "0.2.0", 4 | "description": "Unofficial SDK to communicate between the discord client and an embedded activity.", 5 | "main": "src/index.js", 6 | "dependencies": { 7 | "eventemitter3": "^5.0.0", 8 | "uuid": "^9.0.0" 9 | }, 10 | "devDependencies": {}, 11 | "repository": { 12 | "type": "git", 13 | "url": "git+https://github.com/justsomederpystuff/activitysdk.git" 14 | }, 15 | "author": "big nutty", 16 | "license": "MIT", 17 | "bugs": { 18 | "url": "https://github.com/justsomederpystuff/activitysdk/issues" 19 | }, 20 | "homepage": "https://github.com/justsomederpystuff/activitysdk#readme" 21 | } 22 | -------------------------------------------------------------------------------- /src/constants.js: -------------------------------------------------------------------------------- 1 | module.exports.OPCODES = Object.freeze({ 2 | 0: "HANDSHAKE", 3 | 1: "FRAME", 4 | 2: "CLOSE", 5 | 3: "HELLO", 6 | "HANDSHAKE": 0, 7 | "FRAME": 1, 8 | "CLOSE": 2, 9 | "HELLO": 3 10 | }) 11 | 12 | module.exports.PLATFORM_TYPES = Object.freeze([ 13 | "desktop", 14 | "mobile" 15 | ]) 16 | 17 | module.exports.ORIENTATION_LOCK_STATES = Object.freeze({ 18 | "UNLOCKED": 1, 19 | "PORTRAIT": 2, 20 | "LANDSCAPE": 3 21 | }) 22 | 23 | module.exports.RPC_EVENTS = Object.freeze([ 24 | "CURRENT_USER_UPDATE", 25 | "GUILD_STATUS", 26 | "GUILD_CREATE", 27 | "CHANNEL_CREATE", 28 | "RELATIONSHIP_UPDATE", 29 | "VOICE_CHANNEL_SELECT", 30 | "VOICE_STATE_CREATE", 31 | "VOICE_STATE_DELETE", 32 | "VOICE_STATE_UPDATE", 33 | "VOICE_SETTINGS_UPDATE", 34 | "VOICE_SETTINGS_UPDATE_2", 35 | "VOICE_CONNECTION_STATUS", 36 | "SPEAKING_START", 37 | "SPEAKING_STOP", 38 | "GAME_JOIN", 39 | "GAME_SPECTATE", 40 | "ACTIVITY_JOIN", 41 | "ACTIVITY_JOIN_REQUEST", 42 | "ACTIVITY_SPECTATE", 43 | "ACTIVITY_INVITE", 44 | "ACTIVITY_PIP_MODE_UPDATE", 45 | "THERMAL_STATE_UPDATE", 46 | "ORIENTATION_UPDATE", 47 | "NOTIFICATION_CREATE", 48 | "MESSAGE_CREATE", 49 | "MESSAGE_UPDATE", 50 | "MESSAGE_DELETE", 51 | "LOBBY_DELETE", 52 | "LOBBY_UPDATE", 53 | "LOBBY_MEMBER_CONNECT", 54 | "LOBBY_MEMBER_DISCONNECT", 55 | "LOBBY_MEMBER_UPDATE", 56 | "LOBBY_MESSAGE", 57 | "OVERLAY", 58 | "OVERLAY_UPDATE", 59 | "ENTITLEMENT_CREATE", 60 | "ENTITLEMENT_DELETE", 61 | "USER_ACHIEVEMENT_UPDATE", 62 | "VOICE_CHANNEL_EFFECT_SEND", 63 | "VOICE_CHANNEL_EFFECT_RECENT_EMOJI", 64 | "VOICE_CHANNEL_EFFECT_TOGGLE_ANIMATION_TYPE", 65 | "READY", 66 | "ERROR" 67 | ]) 68 | 69 | module.exports.RPC_COMMANDS = Object.freeze([ 70 | "DISPATCH", 71 | "SET_CONFIG", 72 | "AUTHORIZE", 73 | "AUTHENTICATE", 74 | "GET_GUILD", 75 | "GET_GUILDS", 76 | "GET_CHANNEL", 77 | "GET_CHANNELS", 78 | "CREATE_CHANNEL_INVITE", 79 | "GET_RELATIONSHIPS", 80 | "GET_USER", 81 | "SUBSCRIBE", 82 | "UNSUBSCRIBE", 83 | "SET_USER_VOICE_SETTINGS", 84 | "SET_USER_VOICE_SETTINGS_2", 85 | "SELECT_VOICE_CHANNEL", 86 | "GET_SELECTED_VOICE_CHANNEL", 87 | "SELECT_TEXT_CHANNEL", 88 | "GET_VOICE_SETTINGS", 89 | "SET_VOICE_SETTINGS_2", 90 | "SET_VOICE_SETTINGS", 91 | "SET_ACTIVITY", 92 | "SEND_ACTIVITY_JOIN_INVITE", 93 | "CLOSE_ACTIVITY_JOIN_REQUEST", 94 | "ACTIVITY_INVITE_USER", 95 | "ACCEPT_ACTIVITY_INVITE", 96 | "OPEN_INVITE_DIALOG", 97 | "INVITE_BROWSER", 98 | "DEEP_LINK", 99 | "CONNECTIONS_CALLBACK", 100 | "BILLING_POPUP_BRIDGE_CALLBACK", 101 | "BRAINTREE_POPUP_BRIDGE_CALLBACK", 102 | "GIFT_CODE_BROWSER", 103 | "GUILD_TEMPLATE_BROWSER", 104 | "OVERLAY", 105 | "BROWSER_HANDOFF", 106 | "SET_CERTIFIED_DEVICES", 107 | "GET_IMAGE", 108 | "CREATE_LOBBY", 109 | "UPDATE_LOBBY", 110 | "DELETE_LOBBY", 111 | "UPDATE_LOBBY_MEMBER", 112 | "CONNECT_TO_LOBBY", 113 | "DISCONNECT_FROM_LOBBY", 114 | "SEND_TO_LOBBY", 115 | "SEARCH_LOBBIES", 116 | "CONNECT_TO_LOBBY_VOICE", 117 | "DISCONNECT_FROM_LOBBY_VOICE", 118 | "SET_OVERLAY_LOCKED", 119 | "OPEN_OVERLAY_ACTIVITY_INVITE", 120 | "OPEN_OVERLAY_GUILD_INVITE", 121 | "OPEN_OVERLAY_VOICE_SETTINGS", 122 | "VALIDATE_APPLICATION", 123 | "GET_ENTITLEMENT_TICKET", 124 | "GET_APPLICATION_TICKET", 125 | "START_PURCHASE", 126 | "START_PREMIUM_PURCHASE", 127 | "GET_SKUS", 128 | "GET_ENTITLEMENTS", 129 | "GET_NETWORKING_CONFIG", 130 | "NETWORKING_SYSTEM_METRICS", 131 | "NETWORKING_PEER_METRICS", 132 | "NETWORKING_CREATE_TOKEN", 133 | "SET_USER_ACHIEVEMENT", 134 | "GET_USER_ACHIEVEMENTS", 135 | "USER_SETTINGS_GET_LOCALE", 136 | "GET_ACTIVITY_JOIN_TICKET", 137 | "SEND_GENERIC_EVENT", 138 | "SEND_ANALYTICS_EVENT", 139 | "OPEN_EXTERNAL_LINK", 140 | "CAPTURE_LOG", 141 | "ENCOURAGE_HW_ACCELERATION", 142 | "SET_ORIENTATION_LOCK_STATE", 143 | "GET_PLATFORM_BEHAVIORS" 144 | ]) -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | const EventEmitter = require('eventemitter3'); 2 | const uuid = require('uuid') 3 | 4 | const { OPCODES, RPC_COMMANDS, RPC_EVENTS } = require('./constants'); 5 | const ActivitySDKCommands = require('./rpc/command'); 6 | 7 | class ActivitySDK extends EventEmitter { 8 | constructor(appId) { 9 | super(); 10 | this.appId = appId; 11 | 12 | this.rpcTarget = window.parent 13 | if(!this.rpcTarget) this.rpcTarget = window.parent.opener 14 | 15 | this.rpcOrigin = document.referrer 16 | if(!this.rpcOrigin) this.rpcOrigin = "*" 17 | 18 | this.commandCache = new Map(); 19 | 20 | this._handleMessage = (message) => { 21 | let d = message.data; 22 | const opcode = d[0]; 23 | if(!OPCODES[opcode]) throw "Invalid opcode recieved: " + opcode 24 | switch(OPCODES[opcode]){ 25 | case "HANDSHAKE": 26 | return; 27 | case "FRAME": 28 | this._handleFrame(d[1]); 29 | return; 30 | case "CLOSE": 31 | return; 32 | case "HELLO": 33 | return; 34 | default: 35 | throw "Unable to handle opcode: " + OPCODES[opcode] 36 | } 37 | } 38 | 39 | // Sends data to the RPC server via the iframe 40 | this._sendData = (opcode, data) => { 41 | const nonce = uuid.v4(); 42 | 43 | data['nonce'] = nonce; 44 | 45 | this.rpcTarget.postMessage([ 46 | opcode, 47 | data, 48 | ], this.rpcOrigin); 49 | 50 | const response = new Promise((resolve, reject) => this.commandCache.set(nonce, { resolve, reject })); 51 | return response; 52 | } 53 | 54 | this._sendCommand = (type, data) => { 55 | if(!RPC_COMMANDS.includes(type)) throw "Invalid RPC Command: " + type 56 | 57 | return this._sendData(OPCODES.FRAME, { 58 | cmd: type, 59 | args: data 60 | }) 61 | } 62 | 63 | this._sendCommandRaw = (type, data) => { 64 | if(!RPC_COMMANDS.includes(type)) throw "Invalid RPC Command: " + type 65 | return this._sendData(OPCODES.FRAME, Object.assign({ 66 | cmd: type 67 | }, data)) 68 | } 69 | 70 | this.commands = new ActivitySDKCommands(this._sendCommand); 71 | 72 | window.addEventListener('message', this._handleMessage); 73 | this._init(); 74 | } 75 | 76 | // Closes the activity 77 | close(data){ 78 | window.removeEventListener('message', this._handleMessage); 79 | this._sendData(OPCODES.CLOSE, { code: data.code, message: data.message }) 80 | } 81 | 82 | // Command Handling 83 | _resolveCommand(nonce, data){ 84 | const response = this.commandCache.get(nonce) 85 | if(response) response.resolve(data) 86 | 87 | this.commandCache.delete(nonce) 88 | } 89 | 90 | _rejectCommand(nonce, data){ 91 | const response = this.commandCache.get(nonce) 92 | if(response) response.reject(data) 93 | 94 | this.commandCache.delete(nonce) 95 | } 96 | 97 | _handleFrame(data){ 98 | if(data.cmd == "DISPATCH") return this.emit(data.evt, data.data); 99 | 100 | if(!data.nonce) throw "Missing nonce" 101 | 102 | if(data.evt == "ERROR") return this._rejectCommand(data.nonce, data.data); 103 | 104 | return this._resolveCommand(data.nonce, data.data); 105 | }; 106 | 107 | // Handling RPC Events 108 | async subscribe(event, args, reciever){ 109 | if(!RPC_EVENTS.includes(event)) throw "Invalid RPC Event: " + type 110 | 111 | await this._sendCommandRaw("SUBSCRIBE", { 112 | evt: event, 113 | args 114 | }) 115 | 116 | return this.on(event, reciever) 117 | } 118 | 119 | async unsubscribe(event, reciever){ 120 | if(!RPC_EVENTS.includes(event)) throw "Invalid RPC Event: " + type 121 | 122 | await this._sendCommandRaw("UNSUBSCRIBE", { 123 | evt: event 124 | }) 125 | 126 | return this.off(event, reciever) 127 | } 128 | 129 | // Helpers 130 | getPlatform(){ 131 | return this.platform 132 | } 133 | 134 | getChannelId(){ 135 | return this.channelId 136 | } 137 | 138 | getGuildId(){ 139 | return this.guildId 140 | } 141 | 142 | // Internal startup logic 143 | _kill() { 144 | window.removeEventListener('message', this._handleMessage); 145 | this.removeAllListeners(); 146 | } 147 | 148 | _handshake(){ 149 | this.rpcTarget.postMessage([ 150 | OPCODES.HANDSHAKE, 151 | { 152 | v: 1, 153 | encoding: 'json', 154 | client_id: this.appId, 155 | frame_id: this.frameId, 156 | }, 157 | ], this.rpcOrigin); 158 | } 159 | 160 | _init(){ 161 | const params = new URLSearchParams(window.location.search); 162 | this.frameId = params.get('frame_id') 163 | this.instanceId = params.get('instance_id') 164 | this.platform = params.get('platform') 165 | 166 | this.channelId = params.get('channel_id') 167 | this.guildId = params.get('guild_id') 168 | 169 | if(!this.frameId) throw "Window missing frame_id" 170 | if(!this.instanceId) throw "Window missing instance_id" 171 | if(!this.platform) throw "Window missing platform" 172 | if(!["desktop", "mobile"].includes(this.platform)) throw "Invalid platform" 173 | 174 | this._handshake(); 175 | } 176 | 177 | } 178 | 179 | module.exports = ActivitySDK; -------------------------------------------------------------------------------- /src/rpc/command.js: -------------------------------------------------------------------------------- 1 | // RPC Commands 2 | 3 | const { ORIENTATION_LOCK_STATES } = require("../constants"); 4 | 5 | class ActivitySDKCommands { 6 | constructor(send) { 7 | this.sendCommand = send; 8 | } 9 | 10 | authorize(data){ 11 | return this.sendCommand("AUTHORIZE", data); 12 | } 13 | 14 | authenticate(data){ 15 | return this.sendCommand("AUTHENTICATE", data); 16 | } 17 | 18 | setConfig(data){ 19 | return this.sendCommand("SET_CONFIG", data); 20 | } 21 | 22 | getCurrentUser(){ 23 | return this.sendCommand("GET_USER", {}); 24 | } 25 | 26 | getSelectedVoiceChannel(){ 27 | return this.sendCommand("GET_SELECTED_VOICE_CHANNEL", {}); 28 | } 29 | 30 | setActivity(data){ 31 | return this.sendCommand("SET_ACTIVITY", data); 32 | } 33 | 34 | getGuild(id){ 35 | return this.sendCommand("GET_GUILD", { guild_id: id }); 36 | } 37 | 38 | getGuilds(){ 39 | return this.sendCommand("GET_GUILDS", {}); 40 | } 41 | 42 | getChannel(){ 43 | return this.sendCommand("GET_CHANNEL", { channel_id: id }); 44 | } 45 | 46 | getChannels(){ 47 | return this.sendCommand("GET_CHANNELS", {}); 48 | } 49 | 50 | createChannelInvite(){ 51 | return this.sendCommand("CREATE_CHANNEL_INVITE", {}); 52 | } 53 | 54 | openInviteDialog(){ 55 | return this.sendCommand("OPEN_INVITE_DIALOG", {}) 56 | } 57 | 58 | encourageHardwareAcceleration(){ 59 | return this.sendCommand("ENCOURAGE_HW_ACCELERATION", {}) 60 | } 61 | 62 | getUserLocale(){ 63 | return this.sendCommand("USER_SETTINGS_GET_LOCALE", {}) 64 | } 65 | 66 | setOrientationStateLock(state){ 67 | if(typeof(state) == "string") state = ORIENTATION_LOCK_STATES[state.toUpperCase()] 68 | return this.sendCommand("SET_ORIENTATION_LOCK_STATE", { 69 | lock_state: state 70 | }) 71 | } 72 | 73 | openExternalLink(url){ 74 | return this.sendCommand("OPEN_EXTERNAL_LINK", { url }) 75 | } 76 | 77 | getVoiceSettings(){ 78 | return this.sendCommand("GET_VOICE_SETTINGS", {}) 79 | } 80 | 81 | setVoiceSettings(settings){ 82 | return this.sendCommand("SET_VOICE_SETTINGS", settings) 83 | } 84 | 85 | selectTextChannel(id){ 86 | return this.sendCommand("SELECT_TEXT_CHANNEL", { channel_id: id }) 87 | } 88 | } 89 | 90 | module.exports = ActivitySDKCommands --------------------------------------------------------------------------------