@k8slens/extensions 5.3.1-git.851ad0e36b.0 → 5.3.1-git.889a4d5080.0

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/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;
 }

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

@@ -63,20 +63,20 @@ export declare abstract class LensProtocolRouter extends Singleton {
      * @param url the parsed URL that initiated the `lens://` protocol
      * @returns true if a route has been found
      */
-    protected _routeToInternal(url: Url): RouteAttempt;
+    protected _routeToInternal(url: Url<Record<string, string>>): RouteAttempt;
     /**
      * match against all matched URIs, returning either the first exact match or
      * the most specific match if none are exact.
      * @param routes the array of path schemas, handler pairs to match against
      * @param url the url (in its current state)
      */
-    protected _findMatchingRoute(routes: Iterable<[string, RouteHandler]>, url: Url): null | [match<Record<string, string>>, RouteHandler];
+    protected _findMatchingRoute(routes: Iterable<[string, RouteHandler]>, url: Url<Record<string, string>>): null | [match<Record<string, string>>, RouteHandler];
     /**
      * find the most specific matching handler and call it
      * @param routes the array of (path schemas, handler) pairs to match against
      * @param url the url (in its current state)
      */
-    protected _route(routes: Iterable<[string, RouteHandler]>, url: Url, extensionName?: string): RouteAttempt;
+    protected _route(routes: Iterable<[string, RouteHandler]>, url: Url<Record<string, string>>, extensionName?: string): RouteAttempt;
     /**
      * Tries to find the matching LensExtension instance
      *
@@ -84,7 +84,7 @@ export declare abstract class LensProtocolRouter extends Singleton {
      * @param url the protocol request URI that was "open"-ed
      * @returns either the found name or the instance of `LensExtension`
      */
-    protected _findMatchingExtensionByName(url: Url): Promise<LensExtension | string>;
+    protected _findMatchingExtensionByName(url: Url<Record<string, string>>): Promise<LensExtension | string>;
     /**
      * Find a matching extension by the first one or two path segments of `url` and then try to `_route`
      * its correspondingly registered handlers.
@@ -95,7 +95,7 @@ export declare abstract class LensProtocolRouter extends Singleton {
      * Note: this function modifies its argument, do not reuse
      * @param url the protocol request URI that was "open"-ed
      */
-    protected _routeToExtension(url: Url): Promise<RouteAttempt>;
+    protected _routeToExtension(url: Url<Record<string, string>>): Promise<RouteAttempt>;
     /**
      * Add a handler under the `lens://app` tree of routing.
      * @param pathSchema the URI path schema to match against for this handler