@k8slens/extensions 5.3.1-git.7973f4bce2.0 → 5.3.1-git.8082501bb3.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/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;
@@ -132,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>;
@@ -159,6 +182,7 @@ 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;

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/protocol-handler/router.d.ts

@@ -19,8 +19,8 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 import { match } from "react-router";
-import { Singleton } from "../utils";
 import type Url from "url-parse";
+import type { ExtensionLoader as ExtensionLoaderType } from "../../extensions/extension-loader/extension-loader";
 import type { LensExtension } from "../../extensions/lens-extension";
 import type { RouteHandler } from "../../extensions/registries/protocol-handler";
 export declare const ProtocolHandlerIpcPrefix = "protocol-handler";
@@ -54,10 +54,15 @@ export declare enum RouteAttempt {
     MISSING_EXTENSION = "no-extension"
 }
 export declare function foldAttemptResults(mainAttempt: RouteAttempt, rendererAttempt: RouteAttempt): RouteAttempt;
-export declare abstract class LensProtocolRouter extends Singleton {
+interface Dependencies {
+    extensionLoader: ExtensionLoaderType;
+}
+export declare abstract class LensProtocolRouter {
+    protected dependencies: Dependencies;
     protected internalRoutes: Map<string, RouteHandler>;
     static readonly LoggingPrefix = "[PROTOCOL ROUTER]";
     static readonly ExtensionUrlSchema: string;
+    constructor(dependencies: Dependencies);
     /**
      * Attempts to route the given URL to all internal routes that have been registered
      * @param url the parsed URL that initiated the `lens://` protocol
@@ -108,3 +113,4 @@ export declare abstract class LensProtocolRouter extends Singleton {
      */
     removeInternalHandler(urlSchema: string): void;
 }
+export {};

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

@@ -39,6 +39,19 @@ export interface DownloadMirror {
 }
 export declare const defaultPackageMirror = "default";
 export declare const packageMirrors: Map<string, DownloadMirror>;
+export declare enum ExtensionRegistryLocation {
+    DEFAULT = "default",
+    NPMRC = "npmrc",
+    CUSTOM = "custom"
+}
+export declare type ExtensionRegistry = {
+    location: ExtensionRegistryLocation.DEFAULT | ExtensionRegistryLocation.NPMRC;
+    customUrl?: undefined;
+} | {
+    location: ExtensionRegistryLocation.CUSTOM;
+    customUrl: string;
+};
+export declare const defaultExtensionRegistryUrl = "https://registry.npmjs.org";
 declare type PreferencesModelType<field extends keyof typeof DESCRIPTORS> = typeof DESCRIPTORS[field] extends PreferenceDescription<infer T, any> ? T : never;
 declare type UserStoreModelType<field extends keyof typeof DESCRIPTORS> = typeof DESCRIPTORS[field] extends PreferenceDescription<any, infer T> ? T : never;
 export declare type UserStoreFlatModel = {
@@ -65,6 +78,7 @@ export declare const DESCRIPTORS: {
     editorConfiguration: PreferenceDescription<EditorConfiguration, EditorConfiguration>;
     terminalCopyOnSelect: PreferenceDescription<boolean, boolean>;
     updateChannel: PreferenceDescription<string, string>;
+    extensionRegistryUrl: PreferenceDescription<ExtensionRegistry, ExtensionRegistry>;
 };
 export declare const CONSTANTS: {
     updateChannels: Map<string, {

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

@@ -20,7 +20,7 @@
  */
 import { BaseStore } from "../base-store";
 import { ObservableToggleSet } from "../../renderer/utils";
-import { EditorConfiguration, KubeconfigSyncValue, UserPreferencesModel } from "./preferences-helpers";
+import { EditorConfiguration, ExtensionRegistry, KubeconfigSyncValue, UserPreferencesModel } from "./preferences-helpers";
 export interface UserStoreModel {
     lastSeenAppVersion: string;
     preferences: UserPreferencesModel;
@@ -47,6 +47,7 @@ export declare class UserStore extends BaseStore<UserStoreModel> {
     kubectlBinariesPath?: string;
     terminalCopyOnSelect: boolean;
     updateChannel?: string;
+    extensionRegistryUrl: ExtensionRegistry;
     /**
      * Download kubectl binaries matching cluster version
      */

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

@@ -44,6 +44,7 @@ export * from "./n-fircate";
 export * from "./objects";
 export * from "./openExternal";
 export * from "./paths";
+export * from "./promise-exec";
 export * from "./reject-promise";
 export * from "./singleton";
 export * from "./sort-compare";

package/dist/src/common/utils/promise-exec.d.ts

@@ -19,6 +19,5 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 /// <reference types="node" />
-import { exec, execFile } from "child_process";
-export declare const promiseExec: typeof exec.__promisify__;
+import { execFile } from "child_process";
 export declare const promiseExecFile: typeof execFile.__promisify__;

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

@@ -39,7 +39,7 @@ export declare class ReadableWebToNodeStream<T extends TypedArray> extends Reada
     private pendingRead;
     /**
      *
-     * @param stream Readable​Stream: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
+     * @param stream ReadableStream: https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream
      */
     constructor(stream: ReadableStream<T>);
     /**
@@ -50,7 +50,7 @@ export declare class ReadableWebToNodeStream<T extends TypedArray> extends Reada
      */
     _read(): Promise<void>;
     /**
-     * If there is no unresolved read call to Web-API Readable​Stream immediately returns;
+     * If there is no unresolved read call to Web-API ReadableStream immediately returns;
      * otherwise will wait until the read is resolved.
      */
     waitForReadToComplete(): Promise<void>;