mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
abe90ad92a
- Deprecate the "scope" on command registrations as it is buggy and generally unfixable - Switch to mounting CommandContainer in each new frame so that there is no need to broadcast anything other than opening palette - Add CRD entries to the command registry within each cluster - Add navigate to CommandActionContext to simplify handling of root frame scoped URLs - Switch to using DI for some of the deps Signed-off-by: Sebastian Malton <sebastian@malton.name>
99 lines
4.6 KiB
TypeScript
99 lines
4.6 KiB
TypeScript
/**
|
|
* Copyright (c) 2021 OpenLens Authors
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|
* the Software without restriction, including without limitation the rights to
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|
* subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
|
|
import type * as registries from "./registries";
|
|
import { Disposers, LensExtension } from "./lens-extension";
|
|
import { getExtensionPageUrl } from "./registries/page-registry";
|
|
import type { CatalogEntity } from "../common/catalog";
|
|
import type { Disposer } from "../common/utils";
|
|
import { catalogEntityRegistry, EntityFilter } from "../renderer/api/catalog-entity-registry";
|
|
import { catalogCategoryRegistry, CategoryFilter } from "../renderer/api/catalog-category-registry";
|
|
import type { TopBarRegistration } from "../renderer/components/layout/top-bar/top-bar-registration";
|
|
import type { KubernetesCluster } from "../common/catalog-entities";
|
|
import type { WelcomeMenuRegistration } from "../renderer/components/+welcome/welcome-menu-items/welcome-menu-registration";
|
|
import type { WelcomeBannerRegistration } from "../renderer/components/+welcome/welcome-banner-items/welcome-banner-registration";
|
|
import type { CommandRegistration } from "../renderer/components/command-palette/registered-commands/commands";
|
|
|
|
export class LensRendererExtension extends LensExtension {
|
|
globalPages: registries.PageRegistration[] = [];
|
|
clusterPages: registries.PageRegistration[] = [];
|
|
clusterPageMenus: registries.ClusterPageMenuRegistration[] = [];
|
|
kubeObjectStatusTexts: registries.KubeObjectStatusRegistration[] = [];
|
|
appPreferences: registries.AppPreferenceRegistration[] = [];
|
|
entitySettings: registries.EntitySettingRegistration[] = [];
|
|
statusBarItems: registries.StatusBarRegistration[] = [];
|
|
kubeObjectDetailItems: registries.KubeObjectDetailRegistration[] = [];
|
|
kubeObjectMenuItems: registries.KubeObjectMenuRegistration[] = [];
|
|
kubeWorkloadsOverviewItems: registries.WorkloadsOverviewDetailRegistration[] = [];
|
|
commands: CommandRegistration[] = [];
|
|
welcomeMenus: WelcomeMenuRegistration[] = [];
|
|
welcomeBanners: WelcomeBannerRegistration[] = [];
|
|
catalogEntityDetailItems: registries.CatalogEntityDetailRegistration<CatalogEntity>[] = [];
|
|
topBarItems: TopBarRegistration[] = [];
|
|
|
|
async navigate<P extends object>(pageId?: string, params?: P) {
|
|
const { navigate } = await import("../renderer/navigation");
|
|
const pageUrl = getExtensionPageUrl({
|
|
extensionId: this.name,
|
|
pageId,
|
|
params: params ?? {}, // compile to url with params
|
|
});
|
|
|
|
navigate(pageUrl);
|
|
}
|
|
|
|
/**
|
|
* Defines if extension is enabled for a given cluster. This method is only
|
|
* called when the extension is created within a cluster frame.
|
|
*
|
|
* The default implementation is to return `true`
|
|
*/
|
|
async isEnabledForCluster(cluster: KubernetesCluster): Promise<Boolean> {
|
|
return (void cluster) || true;
|
|
}
|
|
|
|
/**
|
|
* Add a filtering function for the catalog entities. This will be removed if the extension is disabled.
|
|
* @param fn The function which should return a truthy value for those entities which should be kept.
|
|
* @returns A function to clean up the filter
|
|
*/
|
|
addCatalogFilter(fn: EntityFilter): Disposer {
|
|
const dispose = catalogEntityRegistry.addCatalogFilter(fn);
|
|
|
|
this[Disposers].push(dispose);
|
|
|
|
return dispose;
|
|
}
|
|
|
|
/**
|
|
* Add a filtering function for the catalog categories. This will be removed if the extension is disabled.
|
|
* @param fn The function which should return a truthy value for those categories which should be kept.
|
|
* @returns A function to clean up the filter
|
|
*/
|
|
addCatalogCategoryFilter(fn: CategoryFilter): Disposer {
|
|
const dispose = catalogCategoryRegistry.addCatalogCategoryFilter(fn);
|
|
|
|
this[Disposers].push(dispose);
|
|
|
|
return dispose;
|
|
}
|
|
}
|