@k8slens/extensions 5.3.1-git.b7cb10521e.0 → 5.3.1-git.b7d29f8c49.0

package/dist/src/extensions/lens-renderer-extension.d.ts

@@ -13,12 +13,14 @@ 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";
+import type { AppPreferenceRegistration } from "../renderer/components/+preferences/app-preferences/app-preference-registration";
+import type { AdditionalCategoryColumnRegistration } from "../renderer/components/+catalog/custom-category-columns";
 export declare class LensRendererExtension extends LensExtension {
     globalPages: registries.PageRegistration[];
     clusterPages: registries.PageRegistration[];
     clusterPageMenus: registries.ClusterPageMenuRegistration[];
     kubeObjectStatusTexts: registries.KubeObjectStatusRegistration[];
-    appPreferences: registries.AppPreferenceRegistration[];
+    appPreferences: AppPreferenceRegistration[];
     entitySettings: registries.EntitySettingRegistration[];
     statusBarItems: registries.StatusBarRegistration[];
     kubeObjectDetailItems: registries.KubeObjectDetailRegistration[];
@@ -29,6 +31,7 @@ export declare class LensRendererExtension extends LensExtension {
     welcomeBanners: WelcomeBannerRegistration[];
     catalogEntityDetailItems: registries.CatalogEntityDetailRegistration<CatalogEntity>[];
     topBarItems: TopBarRegistration[];
+    additionalCategoryColumns: AdditionalCategoryColumnRegistration[];
     navigate<P extends object>(pageId?: string, params?: P): Promise<void>;
     /**
      * Defines if extension is enabled for a given cluster. This method is only

package/dist/src/extensions/registries/index.d.ts

@@ -4,7 +4,6 @@
  */
 export * from "./page-registry";
 export * from "./page-menu-registry";
-export * from "./app-preference-registry";
 export * from "./status-bar-registry";
 export * from "./kube-object-detail-registry";
 export * from "./kube-object-menu-registry";

package/dist/src/extensions/renderer-api/components.d.ts

@@ -12,6 +12,7 @@ export * from "../../renderer/components/slider";
 export * from "../../renderer/components/switch";
 export * from "../../renderer/components/input/input";
 export declare const CommandOverlay: import("../../renderer/components/command-palette/command-overlay.injectable").CommandOverlay;
+export type { CategoryColumnRegistration, AdditionalCategoryColumnRegistration, } from "../../renderer/components/+catalog/custom-category-columns";
 export * from "../../renderer/components/icon";
 export * from "../../renderer/components/tooltip";
 export * from "../../renderer/components/tabs";

package/dist/src/main/routes/port-forward/port-forward.d.ts

@@ -7,7 +7,6 @@ export interface PortForwardArgs {
     name: string;
     port: number;
     forwardPort: number;
-    protocol?: string;
 }
 interface Dependencies {
     getKubectlBinPath: (bundled: boolean) => Promise<string>;
@@ -24,7 +23,6 @@ export declare class PortForward {
     name: string;
     port: number;
     forwardPort: number;
-    protocol: string;
     constructor(dependencies: Dependencies, pathToKubeConfig: string, args: PortForwardArgs);
     start(): Promise<boolean>;
     stop(): Promise<void>;

package/dist/src/renderer/components/+catalog/__tests__/custom-columns.test.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 {};

package/dist/src/renderer/components/+catalog/custom-category-columns.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import type React from "react";
+import type { CatalogEntity } from "../../../common/catalog";
+import type { TableCellProps } from "../table";
+/**
+ * These are the supported props for the title cell
+ */
+export interface TitleCellProps {
+    className?: string;
+    title: React.ReactNode;
+}
+export interface CategoryColumnRegistration {
+    /**
+     * The sorting order value.
+     *
+     * @default 50
+     */
+    priority?: number;
+    /**
+     * This value MUST to be unique to your extension
+     */
+    id: string;
+    /**
+     * This function will be called to generate the cells (on demand) for the column
+     */
+    renderCell: (entity: CatalogEntity) => React.ReactNode;
+    /**
+     * This function will be used to generate the columns title cell.
+     */
+    titleProps: TitleCellProps;
+    /**
+     * If provided then the column will support sorting and this function will be called to
+     * determine a row's ordering.
+     *
+     * strings are sorted ahead of numbers, and arrays determine ordering between equal
+     * elements of the previous index.
+     */
+    sortCallback?: (entity: CatalogEntity) => string | number | (string | number)[];
+    /**
+     * If provided then searching is supported on this column and this function will be called
+     * to determine if the current search string matches for this row.
+     */
+    searchFilter?: (entity: CatalogEntity) => string | string[];
+}
+/**
+ * This is the type used to declare new catalog category columns
+ */
+export interface AdditionalCategoryColumnRegistration extends CategoryColumnRegistration {
+    /**
+     * The catalog entity kind that is declared by the category for this registration
+     *
+     * e.g.
+     * - `"KubernetesCluster"`
+     */
+    kind: string;
+    /**
+     * The catalog entity group that is declared by the category for this registration
+     *
+     * e.g.
+     * - `"entity.k8slens.dev"`
+     */
+    group: string;
+}
+export interface RegisteredAdditionalCategoryColumn {
+    id: string;
+    priority: number;
+    renderCell: (entity: CatalogEntity) => React.ReactNode;
+    titleProps: TableCellProps;
+    sortCallback?: (entity: CatalogEntity) => string | number | (string | number)[];
+    searchFilter?: (entity: CatalogEntity) => string | string[];
+}

package/dist/src/renderer/components/+catalog/custom-category-columns.injectable.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="@ogre-tools/injectable" />
+import { IComputedValue } from "mobx";
+import type { RegisteredAdditionalCategoryColumn } from "./custom-category-columns";
+declare const categoryColumnsInjectable: import("@ogre-tools/injectable").Injectable<import("@ogre-tools/injectable").InjectionToken<IComputedValue<Map<string, Map<string, RegisteredAdditionalCategoryColumn[]>>>, unknown>, IComputedValue<Map<string, Map<string, RegisteredAdditionalCategoryColumn[]>>>, unknown>;
+export default categoryColumnsInjectable;

package/dist/src/renderer/components/+catalog/get-category-columns.injectable.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="@ogre-tools/injectable" />
+import type { CatalogCategory, CatalogEntity } from "../../../common/catalog";
+import type { ItemListLayoutProps } from "../item-object-list";
+export interface GetCategoryColumnsParams {
+    activeCategory: CatalogCategory | null | undefined;
+}
+export declare type CategoryColumns = Required<Pick<ItemListLayoutProps<CatalogEntity>, "sortingCallbacks" | "searchFilters" | "renderTableContents" | "renderTableHeader">>;
+declare const getCategoryColumnsInjectable: import("@ogre-tools/injectable").Injectable<import("@ogre-tools/injectable").InjectionToken<(args_0: GetCategoryColumnsParams) => Required<Pick<ItemListLayoutProps<CatalogEntity<import("../../../common/catalog").CatalogEntityMetadata, import("../../../common/catalog").CatalogEntityStatus, import("../../../common/catalog").CatalogEntitySpec>>, "searchFilters" | "sortingCallbacks" | "renderTableHeader" | "renderTableContents">>, unknown>, (args_0: GetCategoryColumnsParams) => Required<Pick<ItemListLayoutProps<CatalogEntity<import("../../../common/catalog").CatalogEntityMetadata, import("../../../common/catalog").CatalogEntityStatus, import("../../../common/catalog").CatalogEntitySpec>>, "searchFilters" | "sortingCallbacks" | "renderTableHeader" | "renderTableContents">>, unknown>;
+export default getCategoryColumnsInjectable;

package/dist/src/renderer/components/+catalog/internal-category-columns.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.
+ */
+import type { RegisteredAdditionalCategoryColumn } from "./custom-category-columns";
+export declare const browseAllColumns: RegisteredAdditionalCategoryColumn[];
+export declare const nameCategoryColumn: RegisteredAdditionalCategoryColumn;
+export declare const defaultCategoryColumns: RegisteredAdditionalCategoryColumn[];

package/dist/src/renderer/components/+preferences/app-preferences/app-preferences.injectable.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+/// <reference types="@ogre-tools/injectable" />
+declare const appPreferencesInjectable: import("@ogre-tools/injectable").Injectable<import("@ogre-tools/injectable").InjectionToken<import("mobx").IComputedValue<import("./app-preference-registration").RegisteredAppPreference[]>, unknown>, import("mobx").IComputedValue<import("./app-preference-registration").RegisteredAppPreference[]>, unknown>;
+export default appPreferencesInjectable;

package/dist/src/renderer/components/+preferences/app-preferences/get-app-preferences.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { IComputedValue } from "mobx";
+import type { LensRendererExtension } from "../../../../extensions/lens-renderer-extension";
+import type { RegisteredAppPreference } from "./app-preference-registration";
+interface Dependencies {
+    extensions: IComputedValue<LensRendererExtension[]>;
+}
+export declare const getAppPreferences: ({ extensions }: Dependencies) => IComputedValue<RegisteredAppPreference[]>;
+export {};

package/dist/src/renderer/components/+preferences/application.d.ts

@@ -2,4 +2,7 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export declare const Application: () => JSX.Element;
+import React from "react";
+export declare const Application: React.ForwardRefExoticComponent<React.RefAttributes<any> & {
+    children?: React.ReactNode;
+}>;

package/dist/src/renderer/components/+preferences/extension-settings.d.ts

@@ -1,6 +1,6 @@
-import type { RegisteredAppPreference } from "../../../extensions/registries/app-preference-registry";
+import type { AppPreferenceRegistration } from "./app-preferences/app-preference-registration";
 interface ExtensionSettingsProps {
-    setting: RegisteredAppPreference;
+    setting: AppPreferenceRegistration;
     size: "small" | "normal";
 }
 export declare function ExtensionSettings({ setting, size }: ExtensionSettingsProps): JSX.Element;

package/dist/src/renderer/components/+preferences/extensions.d.ts

@@ -2,4 +2,7 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-export declare const Extensions: () => JSX.Element;
+import React from "react";
+export declare const Extensions: React.ForwardRefExoticComponent<React.RefAttributes<any> & {
+    children?: React.ReactNode;
+}>;

package/dist/src/renderer/components/+preferences/preferences.d.ts

@@ -4,9 +4,6 @@
  */
 import "./preferences.scss";
 import React from "react";
-export declare class Preferences extends React.Component {
-    historyLength: number | undefined;
-    constructor(props: {});
-    renderNavigation(): JSX.Element;
-    render(): JSX.Element;
-}
+export declare const Preferences: React.ForwardRefExoticComponent<React.RefAttributes<any> & {
+    children?: React.ReactNode;
+}>;

package/dist/src/renderer/components/+preferences/telemetry.d.ts

@@ -1 +1,4 @@
-export declare const Telemetry: () => JSX.Element;
+import React from "react";
+export declare const Telemetry: React.ForwardRefExoticComponent<React.RefAttributes<any> & {
+    children?: React.ReactNode;
+}>;

package/dist/src/renderer/components/+preferences/terminal.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 Terminal: () => JSX.Element;

package/dist/src/renderer/components/dock/terminal/terminal.d.ts

@@ -12,6 +12,7 @@ export declare class Terminal {
     private dependencies;
     tabId: TabId;
     protected api: TerminalApi;
+    private terminalConfig;
     static get spawningPool(): HTMLElement;
     static preloadFonts(): Promise<void>;
     private xterm;
@@ -37,6 +38,8 @@ export declare class Terminal {
     onClickLink: (evt: MouseEvent, link: string) => void;
     onContextMenu: () => void;
     onSelectionChange: () => void;
+    setFontSize: (size: number) => void;
+    setFontFamily: (family: string) => void;
     keyHandler: (evt: KeyboardEvent) => boolean;
 }
 export {};

package/dist/src/renderer/components/input/input.d.ts

@@ -51,6 +51,7 @@ export declare type InputProps = Omit<InputElementProps, "onChange" | "onSubmit"
     iconRight?: IconData;
     contentRight?: string | React.ReactNode;
     validators?: InputValidator | InputValidator[];
+    blurOnEnter?: boolean;
     onChange?(value: string, evt: React.ChangeEvent<InputElement>): void;
     onSubmit?(value: string, evt: React.KeyboardEvent<InputElement>): void;
 };

package/dist/src/renderer/components/table/table-cell.d.ts

@@ -7,17 +7,54 @@ import type { TableSortBy, TableSortParams } from "./table";
 import React, { ReactNode } from "react";
 export declare type TableCellElem = React.ReactElement<TableCellProps>;
 export interface TableCellProps extends React.DOMAttributes<HTMLDivElement> {
+    /**
+     * used for configuration visibility of columns
+     */
     id?: string;
+    /**
+     * Any css class names for this table cell. Only used if `title` is a "simple" react node
+     */
     className?: string;
+    /**
+     * The actual value of the cell
+     */
     title?: ReactNode;
+    /**
+     * content inside could be scrolled
+     */
     scrollable?: boolean;
+    /**
+     * render cell with a checkbox
+     */
     checkbox?: boolean;
+    /**
+     * mark checkbox as checked or not
+     */
     isChecked?: boolean;
+    /**
+     * show "true" or "false" for all of the children elements are "typeof boolean"
+     */
     renderBoolean?: boolean;
+    /**
+     * column name, must be same as key in sortable object <Table sortable={}/>
+     */
     sortBy?: TableSortBy;
+    /**
+     * id of the column which follow same visibility rules
+     */
     showWithColumn?: string;
+    /**
+     * @internal
+     */
     _sorting?: Partial<TableSortParams>;
+    /**
+     * @internal
+     */
     _sort?(sortBy: TableSortBy): void;
+    /**
+     * @internal
+     * indicator, might come from parent <TableHead>, don't use this prop outside (!)
+     */
     _nowrap?: boolean;
 }
 export declare class TableCell extends React.Component<TableCellProps> {

package/dist/src/renderer/components/wizard/wizard.d.ts

@@ -2,6 +2,7 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
+/// <reference types="lodash" />
 import "./wizard.scss";
 import React from "react";
 interface WizardCommonProps<D = any> {
@@ -73,8 +74,9 @@ export declare class WizardStep extends React.Component<WizardStepProps, WizardS
     componentWillUnmount(): void;
     prev: () => void;
     next: () => void;
-    submit: () => void;
+    submit: import("lodash").DebouncedFunc<() => void>;
     renderLoading(): JSX.Element;
+    keyDown(evt: React.KeyboardEvent<HTMLElement>): void;
     render(): JSX.Element;
 }
 export {};

package/package.json

@@ -2,7 +2,7 @@
   "name": "@k8slens/extensions",
   "productName": "OpenLens extensions",
   "description": "OpenLens - Open Source Kubernetes IDE: extensions",
-  "version": "5.3.1-git.b7cb10521e.0",
+  "version": "5.3.1-git.b7d29f8c49.0",
   "copyright": "© 2021 OpenLens Authors",
   "license": "MIT",
   "main": "dist/src/extensions/extension-api.js",

package/dist/src/extensions/registries/app-preference-registry.d.ts

@@ -1,22 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import type React from "react";
-import { BaseRegistry } from "./base-registry";
-export interface AppPreferenceComponents {
-    Hint: React.ComponentType<any>;
-    Input: React.ComponentType<any>;
-}
-export interface AppPreferenceRegistration {
-    title: string;
-    id?: string;
-    showInPreferencesTab?: string;
-    components: AppPreferenceComponents;
-}
-export interface RegisteredAppPreference extends AppPreferenceRegistration {
-    id: string;
-}
-export declare class AppPreferenceRegistry extends BaseRegistry<AppPreferenceRegistration, RegisteredAppPreference> {
-    getRegisteredItem(item: AppPreferenceRegistration): RegisteredAppPreference;
-}