Accept an external instance (v1.3.0)

[Furnyr]

This pull request adds support for using an external SDK instance to improve compatibility with the Robo.js framework.

New exports

• DiscordSDK: class
• useSdk: function
• DataPromise: type

Explanation

Dissonity v1 needs to have an instance and a user object to provide functionality. By the time the Unity build loads, the message handler has to be already awaiting the data. If useSdk was called once the authentication was done (and you had access to the user object), messages sent by Unity until then would be lost.

This is avoided by passing a promise to useSdk that will resolve once authentication is done. That way, messages sent by Unity before authentication are left pending until the promise is resolved.

The DataPromise type represents the shape this promise needs to have.

Use

index.ts

import { useSdk, DiscordSDK, DataPromise } from "dissonity";

window.addEventListener("DOMContentLoaded", async () => {

    const promise: DataPromise = new Promise(async resolve => {
    
        const discordSdk = new DiscordSDK(/* Client id */);
        await discordSdk.ready();
  
        // (Authorization process...)
  
        const { user } = await discordSdk.commands.authenticate({
            access_token: /* Retrieved access token */,
        });

        resolve({ discordSdk, user });
    });

  useSdk(promise);
});

TODO

• Update example server to use v1.3.0
• Add documentation

[Furnyr]

I can make the user parameter nullable to make authentication optional. However, it's important to note that if the user isn't authenticated, while the Unity game would load anyway, any attempt to communicate with the Discord client will result in an error.

[Furnyr]

Using an external instance without authentication would be something like this:

---

index.ts

import { useSdk, DiscordSDK, DataPromise } from "dissonity";

let authenticate = /* Authenticate? */;

window.addEventListener("DOMContentLoaded", async () => {

    const promise: DataPromise = new Promise(async resolve => {
    
        const discordSdk = new DiscordSDK(/* Client id */);
        await discordSdk.ready();
  
        if (authenticate) {
        
            // (Authorization process...)
  
            const { user } = await discordSdk.commands.authenticate({
                access_token: /* Retrieved access token */,
            });
            
            resolve({ discordSdk, user });
        }
        
        else {
            resolve({ discordSdk, user: null });
        }
    });

  useSdk(promise);
});