mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
9b9b8e0d05
* adding extension api for terminal environment variables Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * modified shell env api to work as a transformer (WIP) Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * address some review comments Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * shell env modifiers now take a CatalogEntity in ShellEnvContext param Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * tweaks and bug fix Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * refactored to remove ShellEnvModifier code from shell-session to local-shell-session Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * further refactoring and documentation Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * added comment Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
46 lines
2.1 KiB
TypeScript
46 lines
2.1 KiB
TypeScript
/**
|
|
* Copyright (c) OpenLens Authors. All rights reserved.
|
|
* Licensed under MIT License. See LICENSE in root directory for more information.
|
|
*/
|
|
|
|
import { LensExtension } from "./lens-extension";
|
|
import { WindowManager } from "../main/window-manager";
|
|
import { catalogEntityRegistry } from "../main/catalog";
|
|
import type { CatalogEntity } from "../common/catalog";
|
|
import type { IObservableArray } from "mobx";
|
|
import type { MenuRegistration } from "../main/menu/menu-registration";
|
|
import type { TrayMenuRegistration } from "../main/tray/tray-menu-registration";
|
|
import type { ShellEnvModifier } from "../main/shell-session/shell-env-modifier/shell-env-modifier-registration";
|
|
|
|
export class LensMainExtension extends LensExtension {
|
|
appMenus: MenuRegistration[] = [];
|
|
trayMenus: TrayMenuRegistration[] = [];
|
|
|
|
/**
|
|
* implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature
|
|
*
|
|
* (ctx: ShellEnvContext, env: Record<string, string | undefined>) => Record<string, string | undefined>
|
|
*
|
|
* @param ctx the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get
|
|
* cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier
|
|
*
|
|
* @param env the current shell environment that the terminal will be opened with. The implementation should modify this as desired.
|
|
*
|
|
* @returns the modified shell environment that the terminal will be opened with. The implementation must return env as passed in, if it
|
|
* does not modify the shell environment
|
|
*/
|
|
terminalShellEnvModifier?: ShellEnvModifier;
|
|
|
|
async navigate(pageId?: string, params?: Record<string, any>, frameId?: number) {
|
|
return WindowManager.getInstance().navigateExtension(this.id, pageId, params, frameId);
|
|
}
|
|
|
|
addCatalogSource(id: string, source: IObservableArray<CatalogEntity>) {
|
|
catalogEntityRegistry.addObservableSource(`${this.name}:${id}`, source);
|
|
}
|
|
|
|
removeCatalogSource(id: string) {
|
|
catalogEntityRegistry.removeSource(`${this.name}:${id}`);
|
|
}
|
|
}
|