@jupyterlab/translation-extension 4.0.0-alpha.19 → 4.0.0-alpha.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlab/translation-extension",
-  "version": "4.0.0-alpha.19",
+  "version": "4.0.0-alpha.20",
   "description": "JupyterLab - Translation services",
   "keywords": [
     "jupyter",
@@ -28,7 +28,8 @@
     "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
     "schema/**/*.{json,}",
     "style/**/*.{css,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
-    "style/index.js"
+    "style/index.js",
+    "src/**/*.{ts,tsx}"
   ],
   "scripts": {
     "build": "tsc",
@@ -38,15 +39,15 @@
     "watch": "tsc -w"
   },
   "dependencies": {
-    "@jupyterlab/application": "^4.0.0-alpha.19",
-    "@jupyterlab/apputils": "^4.0.0-alpha.19",
-    "@jupyterlab/mainmenu": "^4.0.0-alpha.19",
-    "@jupyterlab/settingregistry": "^4.0.0-alpha.19",
-    "@jupyterlab/translation": "^4.0.0-alpha.19"
+    "@jupyterlab/application": "^4.0.0-alpha.20",
+    "@jupyterlab/apputils": "^4.0.0-alpha.20",
+    "@jupyterlab/mainmenu": "^4.0.0-alpha.20",
+    "@jupyterlab/settingregistry": "^4.0.0-alpha.20",
+    "@jupyterlab/translation": "^4.0.0-alpha.20"
   },
   "devDependencies": {
     "rimraf": "~3.0.0",
-    "typescript": "~4.7.3"
+    "typescript": "~5.0.0-beta"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -0,0 +1,195 @@
+/* ----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+/**
+ * @packageDocumentation
+ * @module translation-extension
+ */
+
+import {
+  ILabShell,
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { Dialog, ICommandPalette, showDialog } from '@jupyterlab/apputils';
+import { IMainMenu } from '@jupyterlab/mainmenu';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import {
+  ITranslator,
+  requestTranslationsAPI,
+  TranslationManager
+} from '@jupyterlab/translation';
+
+/**
+ * Translation plugins
+ */
+const PLUGIN_ID = '@jupyterlab/translation-extension:plugin';
+
+const translator: JupyterFrontEndPlugin<ITranslator> = {
+  id: '@jupyterlab/translation:translator',
+  autoStart: true,
+  requires: [JupyterFrontEnd.IPaths, ISettingRegistry],
+  optional: [ILabShell],
+  provides: ITranslator,
+  activate: async (
+    app: JupyterFrontEnd,
+    paths: JupyterFrontEnd.IPaths,
+    settings: ISettingRegistry,
+    labShell: ILabShell | null
+  ) => {
+    const setting = await settings.load(PLUGIN_ID);
+    const currentLocale: string = setting.get('locale').composite as string;
+    let stringsPrefix: string = setting.get('stringsPrefix')
+      .composite as string;
+    const displayStringsPrefix: boolean = setting.get('displayStringsPrefix')
+      .composite as boolean;
+    stringsPrefix = displayStringsPrefix ? stringsPrefix : '';
+    const serverSettings = app.serviceManager.serverSettings;
+    const translationManager = new TranslationManager(
+      paths.urls.translations,
+      stringsPrefix,
+      serverSettings
+    );
+    await translationManager.fetch(currentLocale);
+
+    // Set translator to UI
+    if (labShell) {
+      labShell.translator = translationManager;
+    }
+
+    Dialog.translator = translationManager;
+
+    return translationManager;
+  }
+};
+
+/**
+ * Initialization data for the extension.
+ */
+const langMenu: JupyterFrontEndPlugin<void> = {
+  id: PLUGIN_ID,
+  requires: [ISettingRegistry, ITranslator],
+  optional: [IMainMenu, ICommandPalette],
+  autoStart: true,
+  activate: (
+    app: JupyterFrontEnd,
+    settings: ISettingRegistry,
+    translator: ITranslator,
+    mainMenu: IMainMenu | null,
+    palette: ICommandPalette | null
+  ) => {
+    const trans = translator.load('jupyterlab');
+    const { commands } = app;
+    let currentLocale: string;
+    /**
+     * Load the settings for this extension
+     *
+     * @param setting Extension settings
+     */
+    function loadSetting(setting: ISettingRegistry.ISettings): void {
+      // Read the settings and convert to the correct type
+      currentLocale = setting.get('locale').composite as string;
+    }
+
+    settings
+      .load(PLUGIN_ID)
+      .then(setting => {
+        // Read the settings
+        loadSetting(setting);
+        document.documentElement.lang = (currentLocale ?? '').replace('_', '-');
+
+        // Listen for your plugin setting changes using Signal
+        setting.changed.connect(loadSetting);
+
+        // Create a languages menu
+        const languagesMenu = mainMenu
+          ? mainMenu.settingsMenu.items.find(
+              item =>
+                item.type === 'submenu' &&
+                item.submenu?.id === 'jp-mainmenu-settings-language'
+            )?.submenu
+          : null;
+
+        let command: string;
+
+        const serverSettings = app.serviceManager.serverSettings;
+        // Get list of available locales
+        requestTranslationsAPI<any>('', '', {}, serverSettings)
+          .then(data => {
+            for (const locale in data['data']) {
+              const value = data['data'][locale];
+              const displayName = value.displayName;
+              const nativeName = value.nativeName;
+              const toggled = displayName === nativeName;
+              const label = toggled
+                ? `${displayName}`
+                : `${displayName} - ${nativeName}`;
+
+              // Add a command per language
+              command = `jupyterlab-translation:${locale}`;
+              commands.addCommand(command, {
+                label: label,
+                caption: label,
+                isEnabled: () => !toggled,
+                isVisible: () => true,
+                isToggled: () => toggled,
+                execute: () => {
+                  return showDialog({
+                    title: trans.__('Change interface language?'),
+                    body: trans.__(
+                      'After changing the interface language to %1, you will need to reload JupyterLab to see the changes.',
+                      label
+                    ),
+                    buttons: [
+                      Dialog.cancelButton({ label: trans.__('Cancel') }),
+                      Dialog.okButton({ label: trans.__('Change and reload') })
+                    ]
+                  }).then(result => {
+                    if (result.button.accept) {
+                      setting
+                        .set('locale', locale)
+                        .then(() => {
+                          window.location.reload();
+                        })
+                        .catch(reason => {
+                          console.error(reason);
+                        });
+                    }
+                  });
+                }
+              });
+
+              // Add the language command to the menu
+              if (languagesMenu) {
+                languagesMenu.addItem({
+                  command,
+                  args: {}
+                });
+              }
+
+              if (palette) {
+                palette.addItem({
+                  category: trans.__('Display Languages'),
+                  command
+                });
+              }
+            }
+          })
+          .catch(reason => {
+            console.error(`Available locales errored!\n${reason}`);
+          });
+      })
+      .catch(reason => {
+        console.error(
+          `The jupyterlab translation extension appears to be missing.\n${reason}`
+        );
+      });
+  }
+};
+
+/**
+ * Export the plugins as default.
+ */
+const plugins: JupyterFrontEndPlugin<any>[] = [translator, langMenu];
+export default plugins;