@theia/plugin-ext 1.37.0-next.16 → 1.37.0-next.19

package/src/plugin/localization-ext.ts

@@ -0,0 +1,84 @@
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { nls } from '@theia/core';
+import { Localization } from '@theia/core/lib/common/i18n/localization';
+import { LocalizationExt, LocalizationMain, Plugin, PLUGIN_RPC_CONTEXT, StringDetails } from '../common';
+import { LanguagePackBundle } from '../common/language-pack-service';
+import { RPCProtocol } from '../common/rpc-protocol';
+import { URI } from './types-impl';
+
+export class LocalizationExtImpl implements LocalizationExt {
+
+    private readonly _proxy: LocalizationMain;
+    private currentLanguage?: string;
+    private isDefaultLanguage = true;
+    private readonly bundleCache = new Map<string, LanguagePackBundle | undefined>();
+
+    constructor(rpc: RPCProtocol) {
+        this._proxy = rpc.getProxy(PLUGIN_RPC_CONTEXT.LOCALIZATION_MAIN);
+    }
+
+    translateMessage(pluginId: string, details: StringDetails): string {
+        const { message, args, comment } = details;
+        if (this.isDefaultLanguage) {
+            return Localization.format(message, (args ?? {}));
+        }
+
+        let key = message;
+        if (comment && comment.length > 0) {
+            key += `/${Array.isArray(comment) ? comment.join() : comment}`;
+        }
+        const str = this.bundleCache.get(pluginId)?.contents[key];
+        return Localization.format(str ?? message, (args ?? {}));
+    }
+
+    getBundle(pluginId: string): { [key: string]: string } | undefined {
+        return this.bundleCache.get(pluginId)?.contents;
+    }
+
+    getBundleUri(pluginId: string): URI | undefined {
+        const uri = this.bundleCache.get(pluginId)?.uri;
+        return uri ? URI.parse(uri) : undefined;
+    }
+
+    async initializeLocalizedMessages(plugin: Plugin, currentLanguage: string): Promise<void> {
+        this.currentLanguage ??= currentLanguage;
+        this.isDefaultLanguage = this.currentLanguage === nls.defaultLocale;
+
+        if (this.isDefaultLanguage) {
+            return;
+        }
+
+        if (this.bundleCache.has(plugin.model.id)) {
+            return;
+        }
+
+        let bundle: LanguagePackBundle | undefined;
+
+        try {
+            bundle = await this._proxy.$fetchBundle(plugin.model.id);
+        } catch (e) {
+            console.error(`Failed to load translations for ${plugin.model.id}: ${e.message}`);
+            return;
+        }
+
+        this.bundleCache.set(plugin.model.id, bundle);
+    }
+
+}

package/src/plugin/plugin-context.ts

@@ -234,6 +234,7 @@ import { PluginPackage } from '../common';
 import { Endpoint } from '@theia/core/lib/browser/endpoint';
 import { FilePermission } from '@theia/filesystem/lib/common/files';
 import { TabsExtImpl } from './tabs';
+import { LocalizationExtImpl } from './localization-ext';
 
 export function createAPIFactory(
     rpc: RPCProtocol,
@@ -245,7 +246,8 @@ export function createAPIFactory(
     workspaceExt: WorkspaceExtImpl,
     messageRegistryExt: MessageRegistryExt,
     clipboard: ClipboardExt,
-    webviewExt: WebviewsExtImpl
+    webviewExt: WebviewsExtImpl,
+    localizationExt: LocalizationExtImpl
 ): PluginAPIFactory {
 
     const authenticationExt = rpc.set(MAIN_RPC_CONTEXT.AUTHENTICATION_EXT, new AuthenticationExtImpl(rpc));
@@ -1073,6 +1075,27 @@ export function createAPIFactory(
             }
         };
 
+        const l10n: typeof theia.l10n = {
+            // eslint-disable-next-line max-len
+            t(...params: [message: string, ...args: Array<string | number | boolean>] | [message: string, args: Record<string, any>] | [{ message: string; args?: Array<string | number | boolean> | Record<string, any>; comment: string | string[] }]): string {
+                if (typeof params[0] === 'string') {
+                    const key = params.shift() as string;
+
+                    // We have either rest args which are Array<string | number | boolean> or an array with a single Record<string, any>.
+                    // This ensures we get a Record<string | number, any> which will be formatted correctly.
+                    const argsFormatted = !params || typeof params[0] !== 'object' ? params : params[0];
+                    return localizationExt.translateMessage(plugin.model.id, { message: key, args: argsFormatted as Record<string | number, any> | undefined });
+                }
+                return localizationExt.translateMessage(plugin.model.id, params[0]);
+            },
+            get bundle() {
+                return localizationExt.getBundle(plugin.model.id);
+            },
+            get uri() {
+                return localizationExt.getBundleUri(plugin.model.id);
+            }
+        };
+
         // notebooks API (@stubbed)
         // The following implementation is temporarily `@stubbed` and marked as such under `theia.d.ts`
         const notebooks: typeof theia.notebooks = {
@@ -1148,6 +1171,7 @@ export function createAPIFactory(
             tasks,
             scm,
             notebooks,
+            l10n,
             tests,
             // Types
             StatusBarAlignment: StatusBarAlignment,

package/src/plugin/plugin-manager.ts

@@ -26,7 +26,8 @@ import {
     ConfigStorage,
     PluginManagerInitializeParams,
     PluginManagerStartParams,
-    TerminalServiceExt
+    TerminalServiceExt,
+    LocalizationExt
 } from '../common/plugin-api-rpc';
 import { PluginMetadata, PluginJsonValidationContribution } from '../common/plugin-protocol';
 import * as theia from '@theia/plugin';
@@ -122,6 +123,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         private readonly secrets: SecretsExtImpl,
         private readonly preferencesManager: PreferenceRegistryExtImpl,
         private readonly webview: WebviewsExtImpl,
+        private readonly localization: LocalizationExt,
         private readonly rpc: RPCProtocol
     ) {
         this.messageRegistryProxy = this.rpc.getProxy(PLUGIN_RPC_CONTEXT.MESSAGE_REGISTRY_MAIN);
@@ -398,6 +400,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         }
         const id = plugin.model.displayName || plugin.model.id;
         if (typeof pluginMain[plugin.lifecycle.startMethod] === 'function') {
+            await this.localization.initializeLocalizedMessages(plugin, this.envExt.language);
             const pluginExport = await pluginMain[plugin.lifecycle.startMethod].apply(getGlobal(), [pluginContext]);
             this.activatedPlugins.set(plugin.model.id, new ActivatedPlugin(pluginContext, pluginExport, stopFn));
         } else {