@k8slens/extensions 5.3.1-git.cd2f5094dc.0 → 5.3.1-git.d8dbe51e7a.0

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

@@ -26,13 +26,42 @@ declare type ExtractEntityStatusType<Entity> = Entity extends CatalogEntity<any,
 declare type ExtractEntitySpecType<Entity> = Entity extends CatalogEntity<any, any, infer Spec> ? Spec : never;
 export declare type CatalogEntityConstructor<Entity extends CatalogEntity> = ((new (data: CatalogEntityData<ExtractEntityMetadataType<Entity>, ExtractEntityStatusType<Entity>, ExtractEntitySpecType<Entity>>) => Entity));
 export interface CatalogCategoryVersion<Entity extends CatalogEntity> {
+    /**
+     * The specific version that the associated constructor is for. This MUST be
+     * a DNS label and SHOULD be of the form `vN`, `vNalphaY`, or `vNbetaY` where
+     * `N` and `Y` are both integers greater than 0.
+     *
+     * Examples: The following are valid values for this field.
+     * - `v1`
+     * - `v1beta1`
+     * - `v1alpha2`
+     * - `v3beta2`
+     */
     name: string;
+    /**
+     * The constructor for the entities.
+     */
     entityClass: CatalogEntityConstructor<Entity>;
 }
 export interface CatalogCategorySpec {
+    /**
+     * The grouping for for the category. This MUST be a DNS label.
+     */
     group: string;
+    /**
+     * The specific versions of the constructors.
+     *
+     * NOTE: the field `.apiVersion` after construction MUST match `{.group}/{.versions.[] | .name}`.
+     * For example, if `group = "entity.k8slens.dev"` and there is an entry in `.versions` with
+     * `name = "v1alpha1"` then the resulting `.apiVersion` MUST be `entity.k8slens.dev/v1alpha1`
+     */
     versions: CatalogCategoryVersion<CatalogEntity>[];
     names: {
+        /**
+         * The kind of entity that this category is for. This value MUST be a DNS
+         * label and MUST be equal to the `kind` fields that are produced by the
+         * `.versions.[] | .entityClass` fields.
+         */
         kind: string;
     };
 }
@@ -76,6 +105,7 @@ export declare abstract class CatalogCategory extends CatalogCategory_base {
 export interface CatalogEntityMetadata {
     uid: string;
     name: string;
+    shortName?: string;
     description?: string;
     source?: string;
     labels: Record<string, string>;
@@ -151,14 +181,35 @@ export interface CatalogEntityKindData {
     readonly kind: string;
 }
 export declare abstract class CatalogEntity<Metadata extends CatalogEntityMetadata = CatalogEntityMetadata, Status extends CatalogEntityStatus = CatalogEntityStatus, Spec extends CatalogEntitySpec = CatalogEntitySpec> implements CatalogEntityKindData {
+    /**
+     * The group and version of this class.
+     */
     abstract readonly apiVersion: string;
+    /**
+     * A DNS label name of the entity.
+     */
     abstract readonly kind: string;
     metadata: Metadata;
     status: Status;
     spec: Spec;
     constructor(data: CatalogEntityData<Metadata, Status, Spec>);
+    /**
+     * Get the UID of this entity
+     */
     getId(): string;
+    /**
+     * Get the name of this entity
+     */
     getName(): string;
+    /**
+     * Get the specified source of this entity, defaulting to `"unknown"` if not
+     * provided
+     */
+    getSource(): string;
+    /**
+     * Get if this entity is enabled.
+     */
+    isEnabled(): boolean;
     abstract onRun?(context: CatalogEntityActionContext): void | Promise<void>;
     abstract onContextMenuOpen(context: CatalogEntityContextMenuContext): void | Promise<void>;
     abstract onSettingsOpen(context: CatalogEntitySettingsContext): void | Promise<void>;

package/dist/src/common/cluster-types.d.ts

@@ -76,7 +76,11 @@ export interface ClusterPreferences extends ClusterPrometheusPreferences {
     terminalCWD?: string;
     clusterName?: string;
     iconOrder?: number;
-    icon?: string;
+    /**
+     * The <img> src for the cluster. If set to `null` that means that it was
+     * cleared by preferences.
+     */
+    icon?: string | null;
     httpsProxy?: string;
     hiddenMetrics?: string[];
     nodeShellImage?: string;

package/dist/src/{extensions/registries/menu-registry.d.ts → common/ipc/catalog.d.ts}

@@ -18,10 +18,13 @@
  * 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 { MenuItemConstructorOptions } from "electron";
-import { BaseRegistry } from "./base-registry";
-export interface MenuRegistration extends MenuItemConstructorOptions {
-    parentId: string;
-}
-export declare class MenuRegistry extends BaseRegistry<MenuRegistration> {
+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"
 }

package/dist/src/{renderer/utils/copyToClipboard.d.ts → common/ipc/extension-loader.ipc.d.ts}

@@ -18,10 +18,4 @@
  * 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.
  */
-export declare function copyToClipboard(elem: HTMLElement, { resetSelection }?: {
-    resetSelection?: boolean;
-}): {
-    copied: boolean;
-    copiedText: string;
-    clearSelection: () => void;
-};
+export declare const BundledExtensionsLoaded = "extension-loader:bundled-extensions-loaded";

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

@@ -25,3 +25,4 @@ export * from "./update-available.ipc";
 export * from "./cluster.ipc";
 export * from "./type-enforced-ipc";
 export * from "./hotbar";
+export * from "./extension-loader.ipc";

package/dist/src/common/k8s-api/endpoints/daemon-set.api.d.ts

@@ -22,17 +22,14 @@ import { IAffinity, WorkloadKubeObject } from "../workload-kube-object";
 import { KubeApi } from "../kube-api";
 import type { KubeJsonApiData } from "../kube-json-api";
 import type { IPodContainer, IPodMetrics } from "./pods.api";
+import type { LabelSelector } from "../kube-object";
 export declare class DaemonSet extends WorkloadKubeObject {
     static kind: string;
     static namespaced: boolean;
     static apiBase: string;
     constructor(data: KubeJsonApiData);
     spec: {
-        selector: {
-            matchLabels: {
-                [name: string]: string;
-            };
-        };
+        selector: LabelSelector;
         template: {
             metadata: {
                 creationTimestamp?: string;

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

@@ -22,6 +22,7 @@ import { IAffinity, WorkloadKubeObject } from "../workload-kube-object";
 import { KubeApi } from "../kube-api";
 import type { IPodMetrics } from "./pods.api";
 import type { KubeJsonApiData } from "../kube-json-api";
+import type { LabelSelector } from "../kube-object";
 export declare class DeploymentApi extends KubeApi<Deployment> {
     protected getScaleApiUrl(params: {
         namespace: string;
@@ -67,11 +68,7 @@ export declare class Deployment extends WorkloadKubeObject {
     constructor(data: KubeJsonApiData);
     spec: {
         replicas: number;
-        selector: {
-            matchLabels: {
-                [app: string]: string;
-            };
-        };
+        selector: LabelSelector;
         template: {
             metadata: {
                 creationTimestamp?: string;

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

@@ -22,6 +22,7 @@ import { IAffinity, WorkloadKubeObject } from "../workload-kube-object";
 import { KubeApi } from "../kube-api";
 import type { KubeJsonApiData } from "../kube-json-api";
 import type { IPodContainer, IPodMetrics } from "./pods.api";
+import type { LabelSelector } from "../kube-object";
 export declare class Job extends WorkloadKubeObject {
     static kind: string;
     static namespaced: boolean;
@@ -31,11 +32,7 @@ export declare class Job extends WorkloadKubeObject {
         parallelism?: number;
         completions?: number;
         backoffLimit?: number;
-        selector?: {
-            matchLabels: {
-                [name: string]: string;
-            };
-        };
+        selector?: LabelSelector;
         template: {
             metadata: {
                 creationTimestamp?: string;

package/dist/src/common/k8s-api/endpoints/network-policy.api.d.ts

@@ -18,50 +18,90 @@
  * 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 { KubeObject } from "../kube-object";
+import { KubeObject, LabelSelector } from "../kube-object";
 import { KubeApi } from "../kube-api";
 import type { KubeJsonApiData } from "../kube-json-api";
 export interface IPolicyIpBlock {
     cidr: string;
     except?: string[];
 }
-export interface IPolicySelector {
-    matchLabels: {
-        [label: string]: string;
-    };
+/**
+ * @deprecated Use `LabelSelector` instead
+ */
+export declare type IPolicySelector = LabelSelector;
+export interface NetworkPolicyPort {
+    /**
+     * The protocol which network traffic must match.
+     *
+     * One of:
+     * - `"TCP"`
+     * - `"UDP"`
+     * - `"SCTP"`
+     *
+     * @default "TCP"
+     */
+    protocol?: string;
+    /**
+     * The port on the given protocol. This can either be a numerical or named
+     * port on a pod. If this field is not provided, this matches all port names and
+     * numbers.
+     *
+     * If present, only traffic on the specified protocol AND port will be matched.
+     */
+    port?: number | string;
+    /**
+     * If set, indicates that the range of ports from port to endPort, inclusive,
+     * should be allowed by the policy. This field cannot be defined if the port field
+     * is not defined or if the port field is defined as a named (string) port.
+     *
+     * The endPort must be equal or greater than port.
+     */
+    endPort?: number;
+}
+export interface NetworkPolicyPeer {
+    /**
+     * IPBlock defines policy on a particular IPBlock. If this field is set then
+     * neither of the other fields can be.
+     */
+    ipBlock?: IPolicyIpBlock;
+    /**
+     * Selects Namespaces using cluster-scoped labels. This field follows standard label
+     * selector semantics; if present but empty, it selects all namespaces.
+     *
+     * If PodSelector is also set, then the NetworkPolicyPeer as a whole selects
+     * the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
+     *
+     * Otherwise it selects all Pods in the Namespaces selected by NamespaceSelector.
+     */
+    namespaceSelector?: LabelSelector;
+    /**
+     * This is a label selector which selects Pods. This field follows standard label
+     * selector semantics; if present but empty, it selects all pods.
+     *
+     * If NamespaceSelector is also set, then the NetworkPolicyPeer as a whole selects
+     * the Pods matching PodSelector in the Namespaces selected by NamespaceSelector.
+     *
+     * Otherwise it selects the Pods matching PodSelector in the policy's own Namespace.
+     */
+    podSelector?: LabelSelector;
 }
 export interface IPolicyIngress {
-    from: {
-        ipBlock?: IPolicyIpBlock;
-        namespaceSelector?: IPolicySelector;
-        podSelector?: IPolicySelector;
-    }[];
-    ports: {
-        protocol: string;
-        port: number;
-    }[];
+    from?: NetworkPolicyPeer[];
+    ports?: NetworkPolicyPort[];
 }
 export interface IPolicyEgress {
-    to: {
-        ipBlock: IPolicyIpBlock;
-    }[];
-    ports: {
-        protocol: string;
-        port: number;
-    }[];
+    to?: NetworkPolicyPeer[];
+    ports?: NetworkPolicyPort[];
+}
+export declare type PolicyType = "Ingress" | "Egress";
+export interface NetworkPolicySpec {
+    podSelector: LabelSelector;
+    policyTypes?: PolicyType[];
+    ingress?: IPolicyIngress[];
+    egress?: IPolicyEgress[];
 }
 export interface NetworkPolicy {
-    spec: {
-        podSelector: {
-            matchLabels: {
-                [label: string]: string;
-                role: string;
-            };
-        };
-        policyTypes: string[];
-        ingress: IPolicyIngress[];
-        egress: IPolicyEgress[];
-    };
+    spec: NetworkPolicySpec;
 }
 export declare class NetworkPolicy extends KubeObject {
     static kind: string;

package/dist/src/common/k8s-api/endpoints/persistent-volume-claims.api.d.ts

@@ -18,7 +18,7 @@
  * 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 { KubeObject } from "../kube-object";
+import { KubeObject, LabelSelector } from "../kube-object";
 import { IMetrics } from "./metrics.api";
 import type { Pod } from "./pods.api";
 import { KubeApi } from "../kube-api";
@@ -35,16 +35,7 @@ export interface PersistentVolumeClaim {
     spec: {
         accessModes: string[];
         storageClassName: string;
-        selector: {
-            matchLabels: {
-                release: string;
-            };
-            matchExpressions: {
-                key: string;
-                operator: string;
-                values: string[];
-            }[];
-        };
+        selector: LabelSelector;
         resources: {
             requests: {
                 storage: string;
@@ -63,11 +54,7 @@ export declare class PersistentVolumeClaim extends KubeObject {
     getPods(allPods: Pod[]): Pod[];
     getStorage(): string;
     getMatchLabels(): string[];
-    getMatchExpressions(): {
-        key: string;
-        operator: string;
-        values: string[];
-    }[];
+    getMatchExpressions(): import("../kube-object").LabelMatchExpression[];
     getStatus(): string;
 }
 declare let pvcApi: PersistentVolumeClaimsApi;

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

@@ -18,18 +18,14 @@
  * 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 { KubeObject } from "../kube-object";
+import { KubeObject, LabelSelector } from "../kube-object";
 import { KubeApi } from "../kube-api";
 import type { KubeJsonApiData } from "../kube-json-api";
 export interface PodDisruptionBudget {
     spec: {
         minAvailable: string;
         maxUnavailable: string;
-        selector: {
-            matchLabels: {
-                [app: string]: string;
-            };
-        };
+        selector: LabelSelector;
     };
     status: {
         currentHealthy: number;

package/dist/src/common/k8s-api/endpoints/replica-set.api.d.ts

@@ -22,6 +22,7 @@ import { WorkloadKubeObject } from "../workload-kube-object";
 import { KubeApi } from "../kube-api";
 import type { IPodMetrics, Pod } from "./pods.api";
 import type { KubeJsonApiData } from "../kube-json-api";
+import type { LabelSelector } from "../kube-object";
 export declare class ReplicaSetApi extends KubeApi<ReplicaSet> {
     protected getScaleApiUrl(params: {
         namespace: string;
@@ -44,11 +45,7 @@ export declare class ReplicaSet extends WorkloadKubeObject {
     constructor(data: KubeJsonApiData);
     spec: {
         replicas?: number;
-        selector: {
-            matchLabels: {
-                [app: string]: string;
-            };
-        };
+        selector: LabelSelector;
         template?: {
             metadata: {
                 labels: {

package/dist/src/common/k8s-api/endpoints/stateful-set.api.d.ts

@@ -22,6 +22,7 @@ import { IAffinity, WorkloadKubeObject } from "../workload-kube-object";
 import { KubeApi } from "../kube-api";
 import type { IPodMetrics } from "./pods.api";
 import type { KubeJsonApiData } from "../kube-json-api";
+import type { LabelSelector } from "../kube-object";
 export declare class StatefulSetApi extends KubeApi<StatefulSet> {
     protected getScaleApiUrl(params: {
         namespace: string;
@@ -45,11 +46,7 @@ export declare class StatefulSet extends WorkloadKubeObject {
     spec: {
         serviceName: string;
         replicas: number;
-        selector: {
-            matchLabels: {
-                [key: string]: string;
-            };
-        };
+        selector: LabelSelector;
         template: {
             metadata: {
                 labels: {

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

@@ -28,7 +28,7 @@ export interface IKubeApiLinkRef {
     apiPrefix?: string;
     apiVersion: string;
     resource: string;
-    name: string;
+    name?: string;
     namespace?: string;
 }
 export interface IKubeApiParsed extends IKubeApiLinkRef {
@@ -37,4 +37,4 @@ export interface IKubeApiParsed extends IKubeApiLinkRef {
     apiVersionWithGroup: string;
 }
 export declare function parseKubeApi(path: string): IKubeApiParsed;
-export declare function createKubeApiURL(ref: IKubeApiLinkRef): string;
+export declare function createKubeApiURL({ apiPrefix, resource, apiVersion, name, namespace }: IKubeApiLinkRef): string;

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

@@ -24,9 +24,14 @@ import { KubeJsonApi, KubeJsonApiData } from "./kube-json-api";
 import type { RequestInit } from "node-fetch";
 import AbortController from "abort-controller";
 import type { Patch } from "rfc6902";
+/**
+ * The options used for creating a `KubeApi`
+ */
 export interface IKubeApiOptions<T extends KubeObject> {
     /**
      * base api-path for listing all resources, e.g. "/api/v1/pods"
+     *
+     * If not specified then will be the one on the `objectConstructor`
      */
     apiBase?: string;
     /**
@@ -36,11 +41,29 @@ export interface IKubeApiOptions<T extends KubeObject> {
      * This option only has effect if checkPreferredVersion is true.
      */
     fallbackApiBases?: string[];
+    /**
+     * If `true` then will check all declared apiBases against the kube api server
+     * for the first accepted one.
+     */
+    checkPreferredVersion?: boolean;
+    /**
+     * The constructor for the kube objects returned from the API
+     */
     objectConstructor: KubeObjectConstructor<T>;
+    /**
+     * The api instance to use for making requests
+     *
+     * @default apiKube
+     */
     request?: KubeJsonApi;
+    /**
+     * @deprecated should be specified by `objectConstructor`
+     */
     isNamespaced?: boolean;
+    /**
+     * @deprecated should be specified by `objectConstructor`
+     */
     kind?: string;
-    checkPreferredVersion?: boolean;
 }
 export interface IKubeApiQueryParams {
     watch?: boolean | number;
@@ -81,6 +104,9 @@ export declare type PropagationPolicy = undefined | "Orphan" | "Foreground" | "B
  */
 export interface IKubeApiCluster extends ILocalKubeApiConfig {
 }
+export declare type PartialKubeObject<T extends KubeObject> = Partial<Omit<T, "metadata">> & {
+    metadata?: Partial<T["metadata"]>;
+};
 export interface IRemoteKubeApiConfig {
     cluster: {
         server: string;
@@ -129,11 +155,11 @@ export interface DeleteResourceDescriptor extends ResourceDescriptor {
 export declare class KubeApi<T extends KubeObject> {
     protected options: IKubeApiOptions<T>;
     readonly kind: string;
-    readonly apiBase: string;
-    readonly apiPrefix: string;
-    readonly apiGroup: string;
     readonly apiVersion: string;
-    readonly apiVersionPreferred?: string;
+    apiBase: string;
+    apiPrefix: string;
+    apiGroup: string;
+    apiVersionPreferred?: string;
     readonly apiResource: string;
     readonly isNamespaced: boolean;
     objectConstructor: KubeObjectConstructor<T>;
@@ -156,14 +182,15 @@ export declare class KubeApi<T extends KubeObject> {
     setResourceVersion(namespace: string, newVersion: string): void;
     getResourceVersion(namespace?: string): string;
     refreshResourceVersion(params?: KubeApiListOptions): Promise<T[]>;
+    private computeApiBase;
     getUrl({ name, namespace }?: Partial<ResourceDescriptor>, query?: Partial<IKubeApiQueryParams>): string;
     protected normalizeQuery(query?: Partial<IKubeApiQueryParams>): Partial<IKubeApiQueryParams>;
     protected parseResponse(data: unknown, namespace?: string): T | T[] | null;
     list({ namespace, reqInit }?: KubeApiListOptions, query?: IKubeApiQueryParams): Promise<T[] | null>;
     get(desc: ResourceDescriptor, query?: IKubeApiQueryParams): Promise<T | null>;
-    create({ name, namespace }: Partial<ResourceDescriptor>, data?: Partial<T>): Promise<T | null>;
-    update({ name, namespace }: ResourceDescriptor, data: Partial<T>): Promise<T | null>;
-    patch(desc: ResourceDescriptor, data?: Partial<T> | Patch, strategy?: KubeApiPatchType): Promise<T | null>;
+    create({ name, namespace }: Partial<ResourceDescriptor>, data?: PartialKubeObject<T>): Promise<T | null>;
+    update({ name, namespace }: ResourceDescriptor, data: PartialKubeObject<T>): Promise<T | null>;
+    patch(desc: ResourceDescriptor, data?: PartialKubeObject<T> | Patch, strategy?: KubeApiPatchType): Promise<T>;
     delete({ propagationPolicy, ...desc }: DeleteResourceDescriptor): Promise<KubeJsonApiData>;
     getWatchUrl(namespace?: string, query?: IKubeApiQueryParams): string;
     watch(opts?: KubeApiWatchOptions): () => void;

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

@@ -20,7 +20,6 @@
  */
 import { JsonApi, JsonApiData, JsonApiError } from "./json-api";
 import type { Response } from "node-fetch";
-import type { Cluster } from "../../main/cluster";
 export interface KubeJsonApiListMetadata {
     resourceVersion: string;
     selfLink?: string;
@@ -64,6 +63,6 @@ export interface KubeJsonApiError extends JsonApiError {
     };
 }
 export declare class KubeJsonApi extends JsonApi<KubeJsonApiData> {
-    static forCluster(cluster: Cluster): KubeJsonApi;
+    static forCluster(clusterId: string): KubeJsonApi;
     protected parseError(error: KubeJsonApiError | any, res: Response): string[];
 }

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

@@ -81,6 +81,28 @@ export declare class KubeCreationError extends Error {
     data: any;
     constructor(message: string, data: any);
 }
+export declare type LabelMatchExpression = {
+    /**
+     * The label key that the selector applies to.
+     */
+    key: string;
+} & ({
+    /**
+     * This represents the key's relationship to a set of values.
+     */
+    operator: "Exists" | "DoesNotExist";
+    values?: undefined;
+} | {
+    operator: "In" | "NotIn";
+    /**
+     * The set of values for to match according to the operator for the label.
+     */
+    values: string[];
+});
+export interface LabelSelector {
+    matchLabels?: Record<string, string | undefined>;
+    matchExpressions?: LabelMatchExpression[];
+}
 export declare class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata, Status = any, Spec = any> implements ItemObject {
     static readonly kind?: string;
     static readonly namespaced?: boolean;

package/dist/src/common/protocol-handler/error.d.ts

@@ -27,13 +27,13 @@ export declare enum RoutingErrorType {
     NO_EXTENSION_ID = "no-ext-id",
     MISSING_EXTENSION = "missing-ext"
 }
-export declare class RoutingError extends Error {
+export declare class RoutingError<Query> extends Error {
     type: RoutingErrorType;
-    url: Url;
+    url: Url<Query>;
     /**
      * Will be set if the routing error originated in an extension route table
      */
     extensionName?: string;
-    constructor(type: RoutingErrorType, url: Url);
+    constructor(type: RoutingErrorType, url: Url<Query>);
     toString(): string;
 }