GDevelop/Extensions/PlayerAuthentication/JsExtension.js

// @flow
/**
 * This is a declaration of an extension for GDevelop 5.
 *
 * ℹ️ Changes in this file are watched and automatically imported if the editor
 * is running. You can also manually run `node import-GDJS-Runtime.js` (in newIDE/app/scripts).
 *
 * The file must be named "JsExtension.js", otherwise GDevelop won't load it.
 * ⚠️ If you make a change and the extension is not loaded, open the developer console
 * and search for any errors.
 *
 * More information on https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md
 */

/*::
// Import types to allow Flow to do static type checking on this file.
// Extensions declaration are typed using Flow (like the editor), but the files
// for the game engine are checked with TypeScript annotations.
import { type ObjectsRenderingService, type ObjectsEditorService } from '../JsExtensionTypes.flow.js'
*/

module.exports = {
  createExtension: function (
    _ /*: (string) => string */,
    gd /*: libGDevelop */
  ) {
    const extension = new gd.PlatformExtension();
    extension
      .setExtensionInformation(
        'PlayerAuthentication',
        _('Player Authentication'),
        _('Allow your game to authenticate players.'),
        'Florian Rival',
        'Open source (MIT License)'
      )
      .setExtensionHelpPath('/all-features/player-authentication')
      .setCategory('Players');
    extension
      .addInstructionOrExpressionGroupMetadata(_('Player Authentication'))
      .setIcon('JsPlatform/Extensions/authentication.svg');

    extension
      .addDependency()
      .setName('InAppBrowser Cordova plugin')
      .setDependencyType('cordova')
      .setExportName('cordova-plugin-inappbrowser');

    extension
      .addAction(
        'DisplayAuthenticationBanner',
        _('Display authentication banner'),
        _(
          'Display an authentication banner at the top of the game screen, for the player to log in.'
        ),
        _('Display an authentication banner'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .addCodeOnlyParameter('currentScene', '')
      .setHelpPath('/all-features/player-authentication')
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.displayAuthenticationBanner');

    extension
      .addAction(
        'HideAuthenticationBanner',
        _('Hide authentication banner'),
        _(
          'Hide the authentication banner from the top of the game screen.'
        ),
        _('Hide the authentication banner'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .addCodeOnlyParameter('currentScene', '')
      .setHelpPath('/all-features/player-authentication')
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.removeAuthenticationBanner');

    extension
      .addAction(
        'OpenAuthenticationWindow',
        _('Open authentication window'),
        _('Open an authentication window for the player to log in.'),
        _('Open an authentication window'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .addCodeOnlyParameter('currentScene', '')
      .setHelpPath('/all-features/player-authentication')
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.openAuthenticationWindow');

    extension
      .addCondition(
        'IsAuthenticationWindowOpen',
        _('Authentication window is open'),
        _('Check if the authentication window is open.'),
        _('Authentication window is open'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.isAuthenticationWindowOpen');

    extension
      .addAction(
        'LogOut',
        _('Log out the player'),
        _('Log out the player.'),
        _('Log out the player'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .addCodeOnlyParameter('currentScene', '')
      .setHelpPath('/all-features/player-authentication')
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.logout');

    extension
      .addStrExpression(
        'Username',
        _('Username'),
        _('Get the username of the authenticated player.'),
        '',
        'JsPlatform/Extensions/authentication.svg'
      )
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.getUsername');

    extension
      .addStrExpression(
        'UserID',
        _('User ID'),
        _('Get the unique user ID of the authenticated player.'),
        '',
        'JsPlatform/Extensions/authentication.svg'
      )
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.getUserId');

    extension
      .addCondition(
        'IsPlayerAuthenticated',
        _('Player is authenticated'),
        _('Check if the player is authenticated.'),
        _('Player is authenticated'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.isAuthenticated');

    extension
      .addCondition(
        'HasPlayerLoggedIn',
        _('Player has logged in'),
        _('Check if the player has just logged in.'),
        _('Player has logged in'),
        '',
        'JsPlatform/Extensions/authentication.svg',
        'JsPlatform/Extensions/authentication.svg'
      )
      .getCodeExtraInformation()
      .setIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationcomponents.js'
      )
      .addIncludeFile(
        'Extensions/PlayerAuthentication/playerauthenticationtools.js'
      )
      .setFunctionName('gdjs.playerAuthentication.hasLoggedIn');

    return extension;
  },
  runExtensionSanityTests: function (
    gd /*: libGDevelop */,
    extension /*: gdPlatformExtension*/
  ) {
    return [];
  },
};