@k8slens/extensions 5.3.1-git.b7cb10521e.0 → 5.3.1-git.b7d29f8c49.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

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;
@@ -62,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;
@@ -31,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,12 @@
+/**
+ * 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;

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,7 +2,7 @@
  * 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 { 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";