@k8slens/extensions 5.3.1-git.5ca194b401.0 → 5.3.1-git.65669f6a64.0

package/dist/src/common/catalog/catalog-entity.d.ts

@@ -5,6 +5,7 @@
 /// <reference types="react" />
 import type TypedEmitter from "typed-emitter";
 import { Disposer } from "../utils";
+import type { CategoryColumnRegistration } from "../../renderer/components/+catalog/custom-category-columns";
 declare type ExtractEntityMetadataType<Entity> = Entity extends CatalogEntity<infer Metadata> ? Metadata : never;
 declare type ExtractEntityStatusType<Entity> = Entity extends CatalogEntity<any, infer Status> ? Status : never;
 declare type ExtractEntitySpecType<Entity> = Entity extends CatalogEntity<any, any, infer Spec> ? Spec : never;
@@ -40,6 +41,9 @@ export interface CatalogCategorySpec {
      * `name = "v1alpha1"` then the resulting `.apiVersion` MUST be `entity.k8slens.dev/v1alpha1`
      */
     versions: CatalogCategoryVersion<CatalogEntity>[];
+    /**
+     * This is the concerning the category
+     */
     names: {
         /**
          * The kind of entity that this category is for. This value MUST be a DNS
@@ -48,30 +52,92 @@ export interface CatalogCategorySpec {
          */
         kind: string;
     };
+    /**
+     * These are the columns used for displaying entities when in the catalog.
+     *
+     * If this is not provided then some default columns will be used, similar in
+     * scope to the columns in the "Browse" view.
+     *
+     * Even if you provide columns, a "Name" column will be provided as well with
+     * `priority: 0`.
+     *
+     * These columns will not be used in the "Browse" view.
+     */
+    displayColumns?: CategoryColumnRegistration[];
 }
 /**
- * If the filter returns true, the menu item is displayed
+ * If the filter return a thruthy value, the menu item is displayed
  */
 export declare type AddMenuFilter = (menu: CatalogEntityAddMenu) => any;
 export interface CatalogCategoryEvents {
+    /**
+     * This event will be emitted when the category is loaded in the catalog
+     * view.
+     */
     load: () => void;
+    /**
+     * This event will be emitted when the catalog add menu is opened and is the
+     * way to added entries to that menu.
+     */
     catalogAddMenu: (context: CatalogEntityAddMenuContext) => void;
+    /**
+     * This event will be emitted when the context menu for an entity is declared
+     * by this category is opened.
+     */
     contextMenuOpen: (entity: CatalogEntity, context: CatalogEntityContextMenuContext) => void;
 }
 declare const CatalogCategory_base: new () => TypedEmitter<CatalogCategoryEvents>;
 export declare abstract class CatalogCategory extends CatalogCategory_base {
+    /**
+     * The version of category that you are wanting to declare.
+     *
+     * Currently supported values:
+     *
+     * - `"catalog.k8slens.dev/v1alpha1"`
+     */
     abstract readonly apiVersion: string;
+    /**
+     * The kind of item you wish to declare.
+     *
+     * Currently supported values:
+     *
+     * - `"CatalogCategory"`
+     */
     abstract readonly kind: string;
-    abstract metadata: {
+    /**
+     * The data about the category itself
+     */
+    abstract readonly metadata: {
+        /**
+         * The name of your category. The category can be searched for by this
+         * value. This will also be used for the catalog menu.
+         */
         name: string;
+        /**
+         * Either an `<svg>` or the name of an icon from {@link IconProps}
+         */
         icon: string;
     };
+    /**
+     * The most important part of a category, as it is where entity versions are declared.
+     */
     abstract spec: CatalogCategorySpec;
+    /**
+     * @internal
+     */
     protected filters: import("mobx").ObservableSet<AddMenuFilter>;
-    static parseId(id?: string): {
+    /**
+     * Parse a category ID into parts.
+     * @param id The id of a category is parse
+     * @returns The group and kind parts of the ID
+     */
+    static parseId(id: string): {
         group?: string;
         kind?: string;
     };
+    /**
+     * Get the ID of this category
+     */
     getId(): string;
     /**
      * Add a filter for menu items of catalogAddMenu
@@ -176,7 +242,7 @@ export declare abstract class CatalogEntity<Metadata extends CatalogEntityMetada
     metadata: Metadata;
     status: Status;
     spec: Spec;
-    constructor(data: CatalogEntityData<Metadata, Status, Spec>);
+    constructor({ metadata, status, spec }: CatalogEntityData<Metadata, Status, Spec>);
     /**
      * Get the UID of this entity
      */

package/dist/src/common/catalog-entities/kubernetes-cluster.d.ts

@@ -44,10 +44,10 @@ export declare type KubernetesClusterStatusPhase = "connected" | "connecting" |
 export interface KubernetesClusterStatus extends CatalogEntityStatus {
 }
 export declare class KubernetesCluster extends CatalogEntity<KubernetesClusterMetadata, KubernetesClusterStatus, KubernetesClusterSpec> {
-    static readonly apiVersion = "entity.k8slens.dev/v1alpha1";
-    static readonly kind = "KubernetesCluster";
-    readonly apiVersion = "entity.k8slens.dev/v1alpha1";
-    readonly kind = "KubernetesCluster";
+    static readonly apiVersion: string;
+    static readonly kind: string;
+    readonly apiVersion: string;
+    readonly kind: string;
     connect(): Promise<void>;
     disconnect(): Promise<void>;
     onRun(context: CatalogEntityActionContext): Promise<void>;

package/dist/src/common/hotbar-store.d.ts

@@ -44,10 +44,9 @@ export declare class HotbarStore extends BaseStore<HotbarStoreModel> {
     switchToPrevious(): void;
     switchToNext(): void;
     /**
-     * Checks if entity already pinned to hotbar
-     * @returns boolean
+     * Checks if entity already pinned to the active hotbar
      */
-    isAddedToActive(entity: CatalogEntity): boolean;
+    isAddedToActive(entity: CatalogEntity | null | undefined): boolean;
     getDisplayLabel(hotbar: Hotbar): string;
     getDisplayIndex(hotbar: Hotbar): string;
 }

package/dist/src/common/ipc/catalog.d.ts

@@ -2,13 +2,15 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export declare enum CatalogIpcEvents {
-    /**
-     * This is broadcast on whenever there is an update to any catalog item
-     */
-    ITEMS = "catalog:items",
-    /**
-     * This can be sent from renderer to main to initialize a broadcast of ITEMS
-     */
-    INIT = "catalog:init"
-}
+/**
+ * This is used to activate a specific entity in the renderer main frame
+ */
+export declare const catalogEntityRunListener = "catalog-entity:run";
+/**
+ * This is broadcast on whenever there is an update to any catalog item
+ */
+export declare const catalogItemsChannel = "catalog:items";
+/**
+ * This can be sent from renderer to main to initialize a broadcast of ITEMS
+ */
+export declare const catalogInitChannel = "catalog:init";

package/dist/src/common/{cluster-ipc.d.ts → ipc/cluster.d.ts}

@@ -12,3 +12,11 @@ export declare const clusterSetDeletingHandler = "cluster:deleting:set";
 export declare const clusterClearDeletingHandler = "cluster:deleting:clear";
 export declare const clusterKubectlApplyAllHandler = "cluster:kubectl-apply-all";
 export declare const clusterKubectlDeleteAllHandler = "cluster:kubectl-delete-all";
+export declare const clusterStates = "cluster:states";
+/**
+ * This channel is broadcast on whenever the cluster fails to list namespaces
+ * during a refresh and no `accessibleNamespaces` have been set.
+ */
+export declare const clusterListNamespaceForbiddenChannel = "cluster:list-namespace-forbidden";
+export declare type ListNamespaceForbiddenArgs = [clusterId: string];
+export declare function isListNamespaceForbiddenArgs(args: unknown[]): args is ListNamespaceForbiddenArgs;

package/dist/src/common/ipc/dialog.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+export declare const openFilePickingDialogChannel = "dialog:open:file-picking";

package/dist/src/common/ipc/extension-handling.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+export declare const extensionDiscoveryStateChannel = "extension-discovery:state";
+export declare const bundledExtensionsLoaded = "extension-loader:bundled-extensions-loaded";
+export declare const extensionLoaderFromMainChannel = "extension-loader:main:state";
+export declare const extensionLoaderFromRendererChannel = "extension-loader:renderer:state";

package/dist/src/common/ipc/hotbar.d.ts

@@ -2,4 +2,4 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export declare const HotbarTooManyItems = "hotbar:too-many-items";
+export declare const hotbarTooManyItemsChannel = "hotbar:too-many-items";

package/dist/src/common/ipc/index.d.ts

@@ -2,12 +2,7 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export declare const dialogShowOpenDialogHandler = "dialog:show-open-dialog";
-export declare const catalogEntityRunListener = "catalog-entity:run";
 export * from "./ipc";
 export * from "./invalid-kubeconfig";
-export * from "./update-available.ipc";
-export * from "./cluster.ipc";
+export * from "./update-available";
 export * from "./type-enforced-ipc";
-export * from "./hotbar";
-export * from "./extension-loader.ipc";

package/dist/src/common/ipc/ipc.d.ts

@@ -3,9 +3,8 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import type { Disposer } from "../utils";
-export declare function requestMain(channel: string, ...args: any[]): Promise<any>;
+export declare const broadcastMainChannel = "ipc:broadcast-main";
 export declare function ipcMainHandle(channel: string, listener: (event: Electron.IpcMainInvokeEvent, ...args: any[]) => any): void;
-export declare function broadcastMessage(channel: string, ...args: any[]): void;
+export declare function broadcastMessage(channel: string, ...args: any[]): Promise<void>;
 export declare function ipcMainOn(channel: string, listener: (event: Electron.IpcMainEvent, ...args: any[]) => any): Disposer;
 export declare function ipcRendererOn(channel: string, listener: (event: Electron.IpcRendererEvent, ...args: any[]) => any): Disposer;
-export declare function bindBroadcastHandlers(): void;

package/dist/src/common/ipc/window.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+export declare const windowActionHandleChannel = "window:window-action";
+export declare const windowOpenAppMenuAsContextMenuChannel = "window:open-app-context-menu";
+export declare const windowLocationChangedChannel = "window:location-changed";
+/**
+ * The supported actions on the current window. The argument for `windowActionHandleChannel`
+ */
+export declare enum WindowAction {
+    /**
+     * Request that the current window goes back one step of browser history
+     */
+    GO_BACK = "back",
+    /**
+     * Request that the current window goes forward one step of browser history
+     */
+    GO_FORWARD = "forward",
+    /**
+     * Request that the current window is minimized
+     */
+    MINIMIZE = "minimize",
+    /**
+     * Request that the current window is maximized if it isn't, or unmaximized
+     * if it is
+     */
+    TOGGLE_MAXIMIZE = "toggle-maximize",
+    /**
+     * Request that the current window is closed
+     */
+    CLOSE = "close"
+}

package/dist/src/common/ipc-channel/channel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+export interface Channel<TInstance> {
+    name: string;
+    _template: TInstance;
+}

package/dist/src/common/k8s-api/endpoints/helm-releases.api.d.ts

@@ -57,7 +57,7 @@ export declare function deleteRelease(name: string, namespace: string): Promise<
 export declare function getReleaseValues(name: string, namespace: string, all?: boolean): Promise<string>;
 export declare function getReleaseHistory(name: string, namespace: string): Promise<IReleaseRevision[]>;
 export declare function rollbackRelease(name: string, namespace: string, revision: number): Promise<JsonApiData>;
-export interface HelmRelease {
+interface HelmReleaseDto {
     appVersion: string;
     name: string;
     namespace: string;
@@ -66,17 +66,13 @@ export interface HelmRelease {
     updated: string;
     revision: string;
 }
-export declare class HelmRelease implements ItemObject {
-    constructor(data: any);
-    static create(data: any): HelmRelease;
-    getId(): string;
-    getName(): string;
-    getNs(): string;
-    getChart(withVersion?: boolean): string;
-    getRevision(): number;
-    getStatus(): string;
-    getVersion(): string;
-    getUpdated(humanize?: boolean, compact?: boolean): string | number;
-    getRepo(): Promise<string>;
+export interface HelmRelease extends HelmReleaseDto, ItemObject {
+    getNs: () => string;
+    getChart: (withVersion?: boolean) => string;
+    getRevision: () => number;
+    getStatus: () => string;
+    getVersion: () => string;
+    getUpdated: (humanize?: boolean, compact?: boolean) => string | number;
+    getRepo: () => Promise<string>;
 }
 export {};

package/dist/src/common/k8s-api/kube-watch-event.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type { KubeJsonApiData } from "./kube-json-api";
+export interface IKubeWatchEvent<T extends KubeJsonApiData> {
+    type: "ADDED" | "MODIFIED" | "DELETED" | "ERROR";
+    object?: T;
+}

package/dist/src/common/routes/preferences.d.ts

@@ -10,6 +10,7 @@ export declare const kubernetesRoute: RouteProps;
 export declare const editorRoute: RouteProps;
 export declare const telemetryRoute: RouteProps;
 export declare const extensionRoute: RouteProps;
+export declare const terminalRoute: RouteProps;
 export declare const preferencesURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;
 export declare const appURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;
 export declare const proxyURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;
@@ -17,3 +18,4 @@ export declare const kubernetesURL: ({ params, query, fragment }?: import("../ut
 export declare const editorURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;
 export declare const telemetryURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;
 export declare const extensionURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;
+export declare const terminalURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<{}, {}>) => string;

package/dist/src/common/user-store/preferences-helpers.d.ts

@@ -10,7 +10,12 @@ export interface KubeconfigSyncEntry extends KubeconfigSyncValue {
 }
 export interface KubeconfigSyncValue {
 }
-export declare type EditorConfiguration = Pick<editor.IStandaloneEditorConstructionOptions, "minimap" | "tabSize" | "lineNumbers">;
+export interface TerminalConfig {
+    fontSize: number;
+    fontFamily: string;
+}
+export declare const defaultTerminalConfig: TerminalConfig;
+export declare type EditorConfiguration = Pick<editor.IStandaloneEditorConstructionOptions, "minimap" | "tabSize" | "lineNumbers" | "fontSize" | "fontFamily">;
 export declare const defaultEditorConfig: EditorConfiguration;
 interface PreferenceDescription<T, R = T> {
     fromStore(val: T | undefined): R;
@@ -48,6 +53,7 @@ export declare const DESCRIPTORS: {
     httpsProxy: PreferenceDescription<string, string>;
     shell: PreferenceDescription<string, string>;
     colorTheme: PreferenceDescription<string, string>;
+    terminalTheme: PreferenceDescription<string, string>;
     localeTimezone: PreferenceDescription<string, string>;
     allowUntrustedCAs: PreferenceDescription<boolean, boolean>;
     allowTelemetry: PreferenceDescription<boolean, boolean>;
@@ -61,6 +67,7 @@ export declare const DESCRIPTORS: {
     syncKubeconfigEntries: PreferenceDescription<KubeconfigSyncEntry[], Map<string, KubeconfigSyncValue>>;
     editorConfiguration: PreferenceDescription<EditorConfiguration, EditorConfiguration>;
     terminalCopyOnSelect: PreferenceDescription<boolean, boolean>;
+    terminalConfig: PreferenceDescription<TerminalConfig, TerminalConfig>;
     updateChannel: PreferenceDescription<string, string>;
     extensionRegistryUrl: PreferenceDescription<ExtensionRegistry, ExtensionRegistry>;
 };

package/dist/src/common/user-store/user-store.d.ts

@@ -4,7 +4,7 @@
  */
 import { BaseStore } from "../base-store";
 import { ObservableToggleSet } from "../../renderer/utils";
-import { EditorConfiguration, ExtensionRegistry, KubeconfigSyncValue, UserPreferencesModel } from "./preferences-helpers";
+import { EditorConfiguration, ExtensionRegistry, KubeconfigSyncValue, UserPreferencesModel, TerminalConfig } from "./preferences-helpers";
 export interface UserStoreModel {
     lastSeenAppVersion: string;
     preferences: UserPreferencesModel;
@@ -23,6 +23,7 @@ export declare class UserStore extends BaseStore<UserStoreModel> {
     allowErrorReporting: boolean;
     allowUntrustedCAs: boolean;
     colorTheme: string;
+    terminalTheme: string;
     localeTimezone: string;
     downloadMirror: string;
     httpsProxy?: string;
@@ -30,6 +31,7 @@ export declare class UserStore extends BaseStore<UserStoreModel> {
     downloadBinariesPath?: string;
     kubectlBinariesPath?: string;
     terminalCopyOnSelect: boolean;
+    terminalConfig: TerminalConfig;
     updateChannel?: string;
     extensionRegistryUrl: ExtensionRegistry;
     /**

package/dist/src/common/utils/__tests__/bind.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/common/utils/collection-functions.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+/**
+ * Get the value behind `key`. If it was not present, first insert `value`
+ * @param map The map to interact with
+ * @param key The key to insert into the map with
+ * @param value The value to optional add to the map
+ * @returns The value in the map
+ */
+export declare function getOrInsert<K, V>(map: Map<K, V>, key: K, value: V): V;
+/**
+ * Like `getOrInsert` but specifically for when `V` is `Map<any, any>` so that
+ * the typings are inferred.
+ */
+export declare function getOrInsertMap<K, MK, MV>(map: Map<K, Map<MK, MV>>, key: K): Map<MK, MV>;
+/**
+ * Like `getOrInsert` but with delayed creation of the item
+ */
+export declare function getOrInsertWith<K, V>(map: Map<K, V>, key: K, value: () => V): V;

package/dist/src/common/utils/index.d.ts

@@ -6,11 +6,16 @@
  * A function that does nothing
  */
 export declare function noop<T extends any[]>(...args: T): void;
+/**
+ * A typecorrect version of <function>.bind()
+ */
+export declare function bind<BoundArgs extends any[], NonBoundArgs extends any[], ReturnType>(fn: (...args: [...BoundArgs, ...NonBoundArgs]) => ReturnType, thisArg: any, ...boundArgs: BoundArgs): (...args: NonBoundArgs) => ReturnType;
 export * from "./app-version";
 export * from "./autobind";
 export * from "./camelCase";
 export * from "./cloneJson";
 export * from "./cluster-id-url-parsing";
+export * from "./collection-functions";
 export * from "./convertCpu";
 export * from "./convertMemory";
 export * from "./debouncePromise";

package/dist/src/common/vars.d.ts

@@ -18,6 +18,9 @@ export declare const productName: string;
 export declare const appName: string;
 export declare const publicPath: string;
 export declare const defaultTheme: string;
+export declare const defaultFontSize = 12;
+export declare const defaultTerminalFontFamily = "RobotoMono";
+export declare const defaultEditorFontFamily = "RobotoMono";
 export declare const contextDir: string;
 export declare const buildDir: string;
 export declare const preloadEntrypoint: string;

package/dist/src/extensions/common-api/registrations.d.ts

@@ -2,11 +2,12 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export type { AppPreferenceRegistration, AppPreferenceComponents } from "../registries/app-preference-registry";
+export type { StatusBarRegistration } from "../../renderer/components/cluster-manager/status-bar-registration";
+export type { AppPreferenceRegistration, AppPreferenceComponents } from "../../renderer/components/+preferences/app-preferences/app-preference-registration";
 export type { KubeObjectDetailRegistration, KubeObjectDetailComponents } from "../registries/kube-object-detail-registry";
 export type { KubeObjectMenuRegistration, KubeObjectMenuComponents } from "../registries/kube-object-menu-registry";
 export type { KubeObjectStatusRegistration } from "../registries/kube-object-status-registry";
 export type { PageRegistration, RegisteredPage, PageParams, PageComponentProps, PageComponents, PageTarget } from "../registries/page-registry";
 export type { ClusterPageMenuRegistration, ClusterPageMenuComponents } from "../registries/page-menu-registry";
-export type { StatusBarRegistration } from "../registries/status-bar-registry";
 export type { ProtocolHandlerRegistration, RouteParams as ProtocolRouteParams, RouteHandler as ProtocolRouteHandler } from "../registries/protocol-handler";
+export type { CustomCategoryViewProps, CustomCategoryViewComponents, CustomCategoryViewRegistration } from "../../renderer/components/+catalog/custom-views";