@k8slens/extensions 5.2.3 → 5.3.0-git.07c8177a97.0

package/dist/src/common/catalog/catalog-category-registry.d.ts

@@ -20,15 +20,24 @@
  */
 import { Disposer, ExtendedMap } from "../utils";
 import { CatalogCategory, CatalogEntityData, CatalogEntityKindData } from "./catalog-entity";
+export declare type CategoryFilter = (category: CatalogCategory) => any;
 export declare class CatalogCategoryRegistry {
     protected categories: import("mobx").ObservableSet<CatalogCategory>;
     protected groupKinds: ExtendedMap<string, ExtendedMap<string, CatalogCategory>>;
+    protected filters: import("mobx").ObservableSet<CategoryFilter>;
     constructor();
     add(category: CatalogCategory): Disposer;
     get items(): CatalogCategory[];
+    get filteredItems(): CatalogCategory[];
     getForGroupKind<T extends CatalogCategory>(group: string, kind: string): T | undefined;
     getEntityForData(data: CatalogEntityData & CatalogEntityKindData): import("./catalog-entity").CatalogEntity<import("./catalog-entity").CatalogEntityMetadata, import("./catalog-entity").CatalogEntityStatus, import("./catalog-entity").CatalogEntitySpec>;
     getCategoryForEntity<T extends CatalogCategory>(data: CatalogEntityData & CatalogEntityKindData): T | undefined;
     getByName(name: string): CatalogCategory;
+    /**
+     * Add a new filter to the set of category filters
+     * @param fn The function that should return a truthy value if that category should be displayed
+     * @returns A function to remove that filter
+     */
+    addCatalogCategoryFilter(fn: CategoryFilter): Disposer;
 }
 export declare const catalogCategoryRegistry: CatalogCategoryRegistry;

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

@@ -20,6 +20,7 @@
  */
 /// <reference types="react" />
 import type TypedEmitter from "typed-emitter";
+import { Disposer } from "../utils";
 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;
@@ -35,6 +36,10 @@ export interface CatalogCategorySpec {
         kind: string;
     };
 }
+/**
+ * If the filter returns true, the menu item is displayed
+ */
+export declare type AddMenuFilter = (menu: CatalogEntityAddMenu) => any;
 export interface CatalogCategoryEvents {
     load: () => void;
     catalogAddMenu: (context: CatalogEntityAddMenuContext) => void;
@@ -49,11 +54,24 @@ export declare abstract class CatalogCategory extends CatalogCategory_base {
         icon: string;
     };
     abstract spec: CatalogCategorySpec;
+    protected filters: import("mobx").ObservableSet<AddMenuFilter>;
     static parseId(id?: string): {
         group?: string;
         kind?: string;
     };
     getId(): string;
+    /**
+     * Add a filter for menu items of catalogAddMenu
+     * @param fn The function that should return a truthy value if that menu item should be displayed
+     * @returns A function to remove that filter
+     */
+    addMenuFilter(fn: AddMenuFilter): Disposer;
+    /**
+     * Filter menuItems according to the Category's set filters
+     * @param menuItems menu items to filter
+     * @returns filtered menu items
+     */
+    filteredItems(menuItems: CatalogEntityAddMenu[]): CatalogEntityAddMenu[];
 }
 export interface CatalogEntityMetadata {
     uid: string;

package/dist/src/common/catalog/catalog-run-event.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { CatalogEntity } from "../catalog";
+export declare class CatalogRunEvent {
+    #private;
+    get defaultPrevented(): boolean;
+    get target(): CatalogEntity<import("./catalog-entity").CatalogEntityMetadata, import("./catalog-entity").CatalogEntityStatus, import("./catalog-entity").CatalogEntitySpec>;
+    constructor({ target }: {
+        target: CatalogEntity;
+    });
+    preventDefault(): void;
+}

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

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

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

@@ -19,7 +19,7 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 import type { KubeJsonApiData } from "../kube-json-api";
-export declare const resourceApplierApi: {
-    annotations: string[];
-    update(resource: object | string): Promise<KubeJsonApiData | null>;
-};
+import type { Patch } from "rfc6902";
+export declare const annotations: string[];
+export declare function update(resource: object | string): Promise<KubeJsonApiData>;
+export declare function patch(name: string, kind: string, ns: string, patch: Patch): Promise<KubeJsonApiData>;

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

@@ -69,12 +69,30 @@ export interface IKubeResourceList {
         verbs: string[];
     }[];
 }
-export interface IKubeApiCluster {
+export interface ILocalKubeApiConfig {
     metadata: {
         uid: string;
     };
 }
-export declare function forCluster<T extends KubeObject>(cluster: IKubeApiCluster, kubeClass: KubeObjectConstructor<T>): KubeApi<T>;
+/**
+ * @deprecated
+ */
+export interface IKubeApiCluster extends ILocalKubeApiConfig {
+}
+export interface IRemoteKubeApiConfig {
+    cluster: {
+        server: string;
+        caData?: string;
+        skipTLSVerify?: boolean;
+    };
+    user: {
+        token?: string;
+        clientCertificateData?: string;
+        clientKeyData?: string;
+    };
+}
+export declare function forCluster<T extends KubeObject>(cluster: ILocalKubeApiConfig, kubeClass: KubeObjectConstructor<T>): KubeApi<T>;
+export declare function forRemoteCluster<T extends KubeObject>(config: IRemoteKubeApiConfig, kubeClass: KubeObjectConstructor<T>): KubeApi<T>;
 export declare function ensureObjectSelfLink(api: KubeApi<KubeObject>, object: KubeJsonApiData): void;
 export declare type KubeApiWatchCallback = (data: IKubeWatchEvent<KubeJsonApiData>, error: any) => void;
 export declare type KubeApiWatchOptions = {

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

@@ -21,6 +21,7 @@
 import type { KubeJsonApiData, KubeJsonApiDataList, KubeJsonApiListMetadata, KubeJsonApiMetadata } from "./kube-json-api";
 import type { ItemObject } from "../item.store";
 import type { JsonApiParams } from "./json-api";
+import type { Patch } from "rfc6902";
 export declare type KubeObjectConstructor<K extends KubeObject> = (new (data: KubeJsonApiData | any) => K) & {
     kind?: string;
     namespaced?: boolean;
@@ -76,6 +77,10 @@ export interface KubeObjectStatus {
     }[];
 }
 export declare type KubeMetaField = keyof KubeObjectMetadata;
+export declare class KubeCreationError extends Error {
+    data: any;
+    constructor(message: string, data: any);
+}
 export declare class KubeObject<Metadata extends KubeObjectMetadata = KubeObjectMetadata, Status = any, Spec = any> implements ItemObject {
     static readonly kind: string;
     static readonly namespaced: boolean;
@@ -96,7 +101,11 @@ export declare class KubeObject<Metadata extends KubeObjectMetadata = KubeObject
     static stringifyLabels(labels?: {
         [name: string]: string;
     }): string[];
-    protected static readonly nonEditableFields: string[];
+    /**
+     * These must be RFC6902 compliant paths
+     */
+    private static readonly nonEditiablePathPrefixes;
+    private static readonly nonEditablePaths;
     constructor(data: KubeJsonApiData);
     get selfLink(): string;
     getId(): string;
@@ -119,6 +128,14 @@ export declare class KubeObject<Metadata extends KubeObjectMetadata = KubeObject
     }[];
     getSearchFields(): string[];
     toPlainObject(): object;
+    patch(patch: Patch): Promise<KubeJsonApiData | null>;
+    /**
+     * Perform a full update (or more specifically a replace)
+     *
+     * Note: this is brittle if `data` is not actually partial (but instead whole).
+     * As fields such as `resourceVersion` will probably out of date. This is a
+     * common race condition.
+     */
     update(data: Partial<this>): Promise<KubeJsonApiData | null>;
     delete(params?: JsonApiParams): Promise<KubeJsonApiData>;
 }

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

@@ -25,6 +25,7 @@ import { ItemStore } from "../item.store";
 import { IKubeApiQueryParams, KubeApi } from "./kube-api";
 import type { KubeJsonApiData } from "./kube-json-api";
 import type { RequestInit } from "node-fetch";
+import type { Patch } from "rfc6902";
 export interface KubeObjectStoreLoadingParams<K extends KubeObject> {
     namespaces: string[];
     api?: KubeApi<K>;
@@ -91,6 +92,8 @@ export declare abstract class KubeObjectStore<T extends KubeObject> extends Item
         name: string;
         namespace?: string;
     }, data?: Partial<T>): Promise<T>;
+    private postUpdate;
+    patch(item: T, patch: Patch): Promise<T>;
     update(item: T, data: Partial<T>): Promise<T>;
     remove(item: T): Promise<void>;
     removeSelectedItems(): Promise<void[]>;

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

@@ -24,4 +24,6 @@ export interface CatalogViewRouteParam {
     kind?: string;
 }
 export declare const catalogRoute: RouteProps;
+export declare const getPreviousTabUrl: (path: string) => string;
 export declare const catalogURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<CatalogViewRouteParam, {}>) => string;
+export declare const browseCatalogTab = "browse";

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

@@ -39,6 +39,7 @@ export * from "./network-policies";
 export * from "./network";
 export * from "./nodes";
 export * from "./pod-disruption-budgets";
+export * from "./port-forwards";
 export * from "./preferences";
 export * from "./releases";
 export * from "./resource-quotas";

package/dist/src/common/routes/port-forwards.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { RouteProps } from "react-router";
+export declare const portForwardsRoute: RouteProps;
+export interface PortForwardsRouteParams {
+}
+export declare const portForwardsURL: ({ params, query, fragment }?: import("../utils/buildUrl").URLParams<PortForwardsRouteParams, {}>) => string;

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

@@ -59,5 +59,6 @@ export declare const DESCRIPTORS: {
     hiddenTableColumns: PreferenceDescription<[string, string[]][], Map<string, ObservableToggleSet<string>>>;
     syncKubeconfigEntries: PreferenceDescription<KubeconfigSyncEntry[], Map<string, KubeconfigSyncValue>>;
     editorConfiguration: PreferenceDescription<EditorConfiguration, EditorConfiguration>;
+    terminalCopyOnSelect: PreferenceDescription<boolean, boolean>;
 };
 export {};

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

@@ -45,6 +45,7 @@ export declare class UserStore extends BaseStore<UserStoreModel> {
     shell?: string;
     downloadBinariesPath?: string;
     kubectlBinariesPath?: string;
+    terminalCopyOnSelect: boolean;
     /**
      * Download kubectl binaries matching cluster version
      */