@rancher/shell 3.0.12-rc.1 → 3.0.12-rc.3

package/tsconfig.paths.json

@@ -1,11 +1,9 @@
 {
   "compilerOptions": {
     "paths": {
-      "~/*": [
-        "../*"
-      ],
-      "@/*": [
-        "../*"
+      "@components/*": [
+        "./rancher-components/*",
+        "../pkg/rancher-components/src/components/*"
       ],
       "@shell/*": [
         "../shell/*"
@@ -13,9 +11,11 @@
       "@pkg/*": [
         "../shell/pkg/*"
       ],
-      "@components/*": [
-        "./rancher-components/*",
-        "../pkg/rancher-components/src/components/*"
+      "~/*": [
+        "../*"
+      ],
+      "@/*": [
+        "../*"
       ]
     },
   },

package/types/kube/kube-api.ts

@@ -1,4 +1,12 @@
+/**
+ * A label selector requirement that contains values, a key, and an operator that relates the key and values.
+ *
+ * See https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#labelselectorrequirement-v1-meta
+ */
 export interface KubeLabelSelectorExpression {
+  /**
+   * The label key that the selector applies to
+   */
   key: string,
   /**
    * Gt and Lt are only applicable to node selectors
@@ -14,9 +22,14 @@ export interface KubeLabelSelectorExpression {
  * https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#labelselector-v1-meta
  */
 export interface KubeLabelSelector {
+  /**
+   * A list of label selector requirements. The requirements are ANDed.
+   *
+   * See {@link KubeLabelSelectorExpression}
+   */
   matchExpressions?: KubeLabelSelectorExpression[],
   /**
-   * matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
+   * matchLabels is a map of `{key,value}` pairs. A single `{key,value}` in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
    */
   matchLabels?: { [key: string]: string }
 }

package/types/rancher/steve.api.ts

@@ -10,10 +10,21 @@ export const STEVE_RESPONSE_CODE = {
   UNKNOWN_REVISION: 'unknown revision'
 };
 
+/**
+ * Steve API JSON response for GET requests
+ */
+export interface SteveGetResponse extends KubeGetResponse {
+  // Rancher specific properties (there are more)
+  id: string,
+
+  // Bucket for everything else (hopefully to remove once above populated)
+  [key: string]: any
+}
+
 /**
  * Steve API JSON response for LIST requests
  */
-export interface SteveListResponse<T = any> {
+export interface SteveListResponse<T = SteveGetResponse> {
   actions: any,
   count: number,
   data: T[],
@@ -26,15 +37,4 @@ export interface SteveListResponse<T = any> {
   [key: string]: any
 }
 
-/**
- * Steve API JSON response for GET requests
- */
-export interface SteveGetResponse extends KubeGetResponse {
-  // Rancher specific properties (there are more)
-  id: string,
-
-  // Bucket for everything else (hopefully to remove once above populated)
-  [key: string]: any
-}
-
 export type RancherKubeMetadata = KubeMetadata

package/types/resources/settings.d.ts

@@ -109,7 +109,8 @@ type Metadata = {
   fields: string[];
   generation: number;
   managedFields: ManagedFields[];
-  name: string;
+  name?: string;
+  generateName?: string;
   relationships: null;
   resourceVersion: string;
   state: {

package/types/shell/index.d.ts

@@ -81,6 +81,7 @@ export namespace CATALOG {
     let _OTHER: string;
     let PRIME_ONLY: string;
     let EXPERIMENTAL: string;
+    let DEPRECATED: string;
     let NAMESPACE: string;
     let RELEASE_NAME: string;
     let FEATURED: string;
@@ -247,6 +248,7 @@ export namespace CATALOG {
     let _OTHER: string;
     let PRIME_ONLY: string;
     let EXPERIMENTAL: string;
+    let DEPRECATED: string;
     let NAMESPACE: string;
     let RELEASE_NAME: string;
     let FEATURED: string;
@@ -650,6 +652,7 @@ export const DEPRECATED: "deprecated";
 export const HIDDEN: "hidden";
 export const FROM_TOOLS: "tools";
 export const FROM_CLUSTER: "cluster";
+export const NEW_APP_INSTANCE: "new-instance";
 export const HIDE_SIDE_NAV: "hide-side-nav";
 export const PROVIDER: "provider";
 export const CLOUD_CREDENTIAL: "cloud";
@@ -725,6 +728,7 @@ export const DEPRECATED: "deprecated";
 export const HIDDEN: "hidden";
 export const FROM_TOOLS: "tools";
 export const FROM_CLUSTER: "cluster";
+export const NEW_APP_INSTANCE: "new-instance";
 export const HIDE_SIDE_NAV: "hide-side-nav";
 export const PROVIDER: "provider";
 export const CLOUD_CREDENTIAL: "cloud";
@@ -2507,6 +2511,35 @@ export namespace AUTOSCALER_ENABLED {
     let formatter_72: string;
     export { formatter_72 as formatter };
 }
+export namespace MGMT_CLUSTER_PROVIDER {
+    let name_128: string;
+    export { name_128 as name };
+    let labelKey_125: string;
+    export { labelKey_125 as labelKey };
+    export let subLabel: string;
+    let value_126: string;
+    export { value_126 as value };
+    let sort_116: string[];
+    export { sort_116 as sort };
+    let search_20: string[];
+    export { search_20 as search };
+    let formatter_73: string;
+    export { formatter_73 as formatter };
+}
+export namespace MGMT_CLUSTER_KUBE_VERSION {
+    let name_129: string;
+    export { name_129 as name };
+    let labelKey_126: string;
+    export { labelKey_126 as labelKey };
+    let subLabel_1: string;
+    export { subLabel_1 as subLabel };
+    let sort_117: string;
+    export { sort_117 as sort };
+    let search_21: string;
+    export { search_21 as search };
+    let formatter_74: string;
+    export { formatter_74 as formatter };
+}
 }
 
 // @shell/config/table-headers.js
@@ -4277,6 +4310,35 @@ export namespace AUTOSCALER_ENABLED {
     let formatter_72: string;
     export { formatter_72 as formatter };
 }
+export namespace MGMT_CLUSTER_PROVIDER {
+    let name_128: string;
+    export { name_128 as name };
+    let labelKey_125: string;
+    export { labelKey_125 as labelKey };
+    export let subLabel: string;
+    let value_126: string;
+    export { value_126 as value };
+    let sort_116: string[];
+    export { sort_116 as sort };
+    let search_20: string[];
+    export { search_20 as search };
+    let formatter_73: string;
+    export { formatter_73 as formatter };
+}
+export namespace MGMT_CLUSTER_KUBE_VERSION {
+    let name_129: string;
+    export { name_129 as name };
+    let labelKey_126: string;
+    export { labelKey_126 as labelKey };
+    let subLabel_1: string;
+    export { subLabel_1 as subLabel };
+    let sort_117: string;
+    export { sort_117 as sort };
+    let search_21: string;
+    export { search_21 as search };
+    let formatter_74: string;
+    export { formatter_74 as formatter };
+}
 }
 
 // @shell/config/types
@@ -4493,6 +4555,7 @@ export namespace MANAGEMENT {
     export let RKE_TEMPLATE_REVISION: string;
     export let CLUSTER_PROXY_CONFIG: string;
     export let OIDC_CLIENT: string;
+    export let PROXY_ENDPOINT: string;
 }
 export namespace BRAND {
     let SUSE: string;
@@ -4868,6 +4931,7 @@ export namespace MANAGEMENT {
     export let RKE_TEMPLATE_REVISION: string;
     export let CLUSTER_PROXY_CONFIG: string;
     export let OIDC_CLIENT: string;
+    export let PROXY_ENDPOINT: string;
 }
 export namespace BRAND {
     let SUSE: string;
@@ -5745,7 +5809,17 @@ export default class ClusterRepo {
     };
     get _isClusterRepoDisabled(): boolean;
     get _availableActions(): any;
-    refresh(): Promise<void>;
+    /**
+     * Refreshes the repository by updating its forceUpdate annotation and waiting for it to become active.
+     * @param {boolean} dispatchLoad - Whether to dispatch the catalog/load action after refreshing. Defaults to true.
+     */
+    refresh(dispatchLoad?: boolean): Promise<void>;
+    /**
+     * Performs a bulk refresh on multiple repositories concurrently, bypassing individual
+     * catalog loads, and dispatches a single catalog/load for all repositories once they are active.
+     * @param {ClusterRepo[]} items - Array of repository instances to refresh.
+     */
+    refreshBulk(items: ClusterRepo[]): Promise<void>;
     disableClusterRepo(): Promise<void>;
     enableClusterRepo(): Promise<void>;
     get isGit(): boolean;
@@ -5793,7 +5867,17 @@ export default class ClusterRepo {
     };
     get _isClusterRepoDisabled(): boolean;
     get _availableActions(): any;
-    refresh(): Promise<void>;
+    /**
+     * Refreshes the repository by updating its forceUpdate annotation and waiting for it to become active.
+     * @param {boolean} dispatchLoad - Whether to dispatch the catalog/load action after refreshing. Defaults to true.
+     */
+    refresh(dispatchLoad?: boolean): Promise<void>;
+    /**
+     * Performs a bulk refresh on multiple repositories concurrently, bypassing individual
+     * catalog loads, and dispatches a single catalog/load for all repositories once they are active.
+     * @param {ClusterRepo[]} items - Array of repository instances to refresh.
+     */
+    refreshBulk(items: ClusterRepo[]): Promise<void>;
     disableClusterRepo(): Promise<void>;
     enableClusterRepo(): Promise<void>;
     get isGit(): boolean;
@@ -6016,6 +6100,7 @@ export default class Ingress {
     get useNestedBackendField(): any;
     get serviceNamePath(): "service.name" | "serviceName";
     get servicePortPath(): "service.port.number" | "servicePort";
+    get servicePortNamePath(): "servicePort" | "service.port.name";
     get defaultBackendPath(): "defaultBackend" | "backend";
     get hasDefaultBackend(): boolean;
     get details(): any;
@@ -6079,6 +6164,7 @@ export default class Ingress {
     get useNestedBackendField(): any;
     get serviceNamePath(): "service.name" | "serviceName";
     get servicePortPath(): "service.port.number" | "servicePort";
+    get servicePortNamePath(): "servicePort" | "service.port.name";
     get defaultBackendPath(): "defaultBackend" | "backend";
     get hasDefaultBackend(): boolean;
     get details(): any;
@@ -6199,7 +6285,7 @@ declare namespace _default {
         commit: any;
         dispatch: any;
         state: any;
-    }, type: any, compareWatches: any): void;
+    }, payload: any): void;
     export function promptRemove({ commit, state }: {
         commit: any;
         state: any;
@@ -6369,7 +6455,7 @@ declare namespace _default {
         commit: any;
         dispatch: any;
         state: any;
-    }, type: any, compareWatches: any): void;
+    }, payload: any): void;
     export function promptRemove({ commit, state }: {
         commit: any;
         state: any;
@@ -8354,6 +8440,16 @@ export function compareChartVersions(v1: string, v2: string): number;
  * @returns {Object} The latest compatible chart version object.
  */
 export function getLatestCompatibleVersion(chart: any, workerOSs: Array<string>, showPrerelease: boolean): any;
+/**
+ * Builds the route URL for the standalone chart readme page.
+ *
+ * The helper maps chart context into query params so the readme page can fetch
+ * version info directly (instead of relying on local/session storage transfer).
+ */
+export function getStandaloneReadmeUrl(router: any, { cluster, repoType, repoName, chartName, versionName, deprecated, showAppReadme, hideReadmeFirstTitle, }?: {
+    showAppReadme?: boolean;
+    hideReadmeFirstTitle?: boolean;
+}): any;
 }
 
 // @shell/utils/chart.js
@@ -8381,6 +8477,16 @@ export function compareChartVersions(v1: string, v2: string): number;
  * @returns {Object} The latest compatible chart version object.
  */
 export function getLatestCompatibleVersion(chart: any, workerOSs: Array<string>, showPrerelease: boolean): any;
+/**
+ * Builds the route URL for the standalone chart readme page.
+ *
+ * The helper maps chart context into query params so the readme page can fetch
+ * version info directly (instead of relying on local/session storage transfer).
+ */
+export function getStandaloneReadmeUrl(router: any, { cluster, repoType, repoName, chartName, versionName, deprecated, showAppReadme, hideReadmeFirstTitle, }?: {
+    showAppReadme?: boolean;
+    hideReadmeFirstTitle?: boolean;
+}): any;
 }
 
 // @shell/utils/clipboard
@@ -9213,26 +9319,6 @@ export function resolveMachineConfigComponent(key: any): string;
 export function resolveCloudCredentialComponent(key: any): string;
 }
 
-// @shell/utils/ember-page
-
-declare module '@shell/utils/ember-page' {
-export function findEmberPage(): HTMLElement;
-export function clearEmberInactiveTimer(): void;
-export function startEmberInactiveTimer(): void;
-export function removeEmberPage(): void;
-export const EMBER_FRAME: "ember-iframe";
-}
-
-// @shell/utils/ember-page.js
-
-declare module '@shell/utils/ember-page.js' {
-export function findEmberPage(): HTMLElement;
-export function clearEmberInactiveTimer(): void;
-export function startEmberInactiveTimer(): void;
-export function removeEmberPage(): void;
-export const EMBER_FRAME: "ember-iframe";
-}
-
 // @shell/utils/error
 
 declare module '@shell/utils/error' {
@@ -10456,6 +10542,14 @@ export function sanitizeIP(v: any): any;
  */
 export function xOfy(x: any, y: any): string;
 export function isBase64(value: any): boolean;
+/**
+ * Checks if a value is a valid base64-encoded CA bundle.
+ * Unlike isBase64, this handles multiline base64 (e.g. openssl wraps at 76 chars)
+ * and rejects short strings that could be false positives.
+ * @param {string} value
+ * @returns {boolean}
+ */
+export function isBase64EncodedCert(value: string): boolean;
 export function generateRandomAlphaString(length: any): string;
 /**
  * Generate a key-value nested object from a list of paths that represents a directory tree.
@@ -10522,6 +10616,14 @@ export function sanitizeIP(v: any): any;
  */
 export function xOfy(x: any, y: any): string;
 export function isBase64(value: any): boolean;
+/**
+ * Checks if a value is a valid base64-encoded CA bundle.
+ * Unlike isBase64, this handles multiline base64 (e.g. openssl wraps at 76 chars)
+ * and rejects short strings that could be false positives.
+ * @param {string} value
+ * @returns {boolean}
+ */
+export function isBase64EncodedCert(value: string): boolean;
 export function generateRandomAlphaString(length: any): string;
 /**
  * Generate a key-value nested object from a list of paths that represents a directory tree.
@@ -10956,6 +11058,7 @@ export function isServerUrl(value: any): boolean;
 export function isHttps(value: any): any;
 export function isDomainWithoutProtocol(value: any): boolean;
 export function isLocalhost(value: any): boolean;
+export function isValidUrl(value: any): boolean;
 export function hasTrailingForwardSlash(value: any): any;
 }
 
@@ -10966,6 +11069,7 @@ export function isServerUrl(value: any): boolean;
 export function isHttps(value: any): any;
 export function isDomainWithoutProtocol(value: any): boolean;
 export function isLocalhost(value: any): boolean;
+export function isValidUrl(value: any): boolean;
 export function hasTrailingForwardSlash(value: any): any;
 }
 

package/types/store/dashboard-store.types.ts

@@ -2,21 +2,68 @@ import { KubeLabelSelector } from '@shell/types/kube/kube-api';
 import { PaginationArgs, StorePagination } from '@shell/types/store/pagination.types';
 
 /**
- * Properties on all findX actions
+ * @internal
+ * Core properties on all findX actions
  */
-export type ActionCoreFindArgs = {
+export type ActionCoreFindOptions = {
+  /**
+   * Use this to override URL instead of looking up the URL for the type/id
+   */
   url?: string,
+  /**
+   * Force the request to go to the server instead of checking for a cached value first
+   */
   force?: boolean,
 }
 
 /**
+ * @internal
+ * Args used for find action
+ */
+export interface ActionFindArgs extends ActionCoreFindOptions {
+  /**
+   * Watch for changes
+   *
+   * false = no, all other values = yes
+   */
+  watch?: boolean,
+  /**
+   * @internal
+   * Whether to invalidate the page cache (default: false)
+   */
+  invalidatePageCache?: boolean,
+  /**
+   * XHR request verbs `get`, `post`, `put`, `delete` (default: get)
+   */
+  method?: string,
+  /**
+   * Used if we want to specify custom headers for the request
+   */
+  headers?: object,
+  /**
+   * Use this to override URL instead of looking up the URL for the type/id
+   */
+  url?: string,
+}
+
+/**
+ * @internal
  * Args used for findAll action
  */
-export interface ActionFindAllArgs extends ActionCoreFindArgs {
+export interface ActionFindAllArgs extends ActionCoreFindOptions {
+  /**
+   * Watch for changes
+   *
+   * false = no, all other values = yes
+   */
   watch?: boolean,
+  /**
+   * Array of namespaces to filter by (used in url path, not part of pagination params)
+   */
   namespaced?: string[],
   /**
-   * Should resources be fetched in increments?
+   * @internal
+   * Properties that determine and control if resources should be fetched in increments
    */
   incremental?: {
     /**
@@ -38,24 +85,32 @@ export interface ActionFindAllArgs extends ActionCoreFindArgs {
      */
     pageByNumber: boolean,
   },
+  /**
+   * @internal
+   * Flag to indicate if this request is coming from a list with manual refresh, which may require different handling in the store
+   */
   hasManualRefresh?: boolean,
+  /**
+   * Number of records to return per page
+   */
   limit?: number,
   /**
-   * Iterate over all pages and return all resources.
-   *
-   * This is done via the native kube pagination api, not steve
+   * @internal
+   * Iterate over all pages and return all resources. This is done via the native kube pagination api, not Steve
    */
   depaginate?: boolean,
   /**
+   * @internal
    * Specifies the name to use if we should save the count returned in the paginated request
    */
   saveCountAs?: string,
 }
 
 /**
+ * @internal
  * Args used for findPage action
  */
-export interface ActionFindPageArgs extends ActionCoreFindArgs {
+export interface ActionFindPageArgs extends ActionCoreFindOptions {
   /**
    * Set of pagination settings that creates the url.
    *
@@ -73,6 +128,7 @@ export interface ActionFindPageArgs extends ActionCoreFindArgs {
    */
   watch?: boolean,
   /**
+   * @internal
    * Does this request stem from a list with manual refresh?
    */
   hasManualRefresh?: boolean,
@@ -81,6 +137,10 @@ export interface ActionFindPageArgs extends ActionCoreFindArgs {
    */
   transient?: boolean,
 
+  /**
+   * @internal
+   * Specifies the name to use if we should save the count returned in the paginated request
+   */
   saveCountAs?: string,
 
   /**
@@ -97,6 +157,14 @@ export interface ActionFindPageArgs extends ActionCoreFindArgs {
 }
 
 /**
+ * @internal
+ * Response to the find action
+ * resource object returned by the API, or null if not found
+ */
+export type ActionFindResponse<T = any> = T;
+
+/**
+ * @internal
  * Response to a transient (not stored in cache) findPage action
  */
 export type ActionFindPageTransientResponse<T = any> = {
@@ -105,6 +173,7 @@ export type ActionFindPageTransientResponse<T = any> = {
 };
 
 /**
+ * @internal
  * Response to the findPage action
  *
  * If the request was transient (not stored in cache) this will be an object contain all the details of the request
@@ -114,20 +183,48 @@ export type ActionFindPageTransientResponse<T = any> = {
 export type ActionFindPageResponse<T = any> = ActionFindPageTransientResponse | T[];
 
 /**
- * Args used for findPage action
+ * Args used for findMatching action
  */
-export interface ActionFindMatchingArgs extends ActionCoreFindArgs {
+export interface ActionFindMatchingArgs extends ActionCoreFindOptions {
+  /**
+   * Represents the label selector to filter by
+   * @example
+   * ```
+   * {
+   *   matchLabels: {
+   *     app: 'my-app',
+   *     tier: 'frontend'
+   *   },
+   *   matchExpressions: [
+   *     {
+   *       key: 'environment',
+   *       operator: 'In',
+   *       values: ['production', 'staging']
+   *     }
+   *   ]
+   * }
+   * ```
+   */
   labelSelector: KubeLabelSelector,
+  /**
+   * The single namespace to filter by (used in url path, not part of pagination params)
+   */
   namespaced?: string,
+  /**
+   * @internal
+   * Iterate over all pages and return all resources.
+   */
   depaginate?: boolean
 }
 
 /**
+ * @internal
  * Response to the findMatching action
  */
 export type ActionFindMatchingResponse<T = any> = ActionFindPageResponse<T>
 
 /**
+ * @internal
  * Args used for findLabelSelector action
  */
-export type ActionFindLabelSelectorArgs = ActionFindPageArgs | ActionFindMatchingArgs;
+export type ActionFindLabelSelectorArgs = Omit<ActionFindPageArgs, 'pagination' | 'namespace'> | ActionFindMatchingArgs;

package/types/store/pagination.types.ts

@@ -44,13 +44,16 @@ export interface PaginationSort {
    * Name of field within the object to sort by
    */
   field: string,
+  /**
+   * Sort direction. `true` for ascending, `false` for descending
+   */
   asc: boolean
 }
 
 /**
  * Equalities that can be used with a `filter` query param
  *
- * filter=<field><equality><values>
+ * `filter=<field><equality><values>`
  *
  * For example
  * - filter=a=b
@@ -143,14 +146,14 @@ type FilterFieldCtorArgs = {
 /**
  * Filter the pagination result by these specific fields
  *
- * In format of <field><equality><value>
+ * In format of `<field><equality><value>`
  *
  * For example
  *
  * - metadata.name=test
  * - metadata.namespace!=system
  *
- * These are sub items for @PaginationParam, for example filter=<PaginationFilterField>
+ * These are sub items for {@link PaginationParam}, for example `filter=<PaginationFilterField>`
  *
  * For more information regarding the API see https://github.com/rancher/steve?tab=readme-ov-file#query-parameters
  */