@rancher/shell 3.0.8 → 3.0.9-rc.2

package/types/kube/kube-api.ts

@@ -25,11 +25,37 @@ export interface KubeLabelSelector {
  * https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.31/#objectmeta-v1-meta
  */
 export interface KubeMetadata {
+  namespace?: string,
+  name: string
+
   labels?: { [key: string]: string },
   annotations?: { [key: string]: string },
 }
 
-export interface RancherKubeMetadata extends KubeMetadata {
-  namespace?: string,
-  name: string
+/**
+ * Kube API JSON response for LIST requests
+ */
+export interface KubeListResponse<T = any> {
+  kind: string,
+  apiVersion: string,
+
+  items: T[],
+
+  // Bucket for everything else (hopefully to remove once above populated)
+  [key: string]: any
+}
+
+/**
+ * Kube API JSON response for GET requests
+ */
+export interface KubeGetResponse {
+  kind: string,
+  apiVersion: string,
+
+  metadata: KubeMetadata,
+  spec: any,
+  status: any,
+
+  // Bucket for everything else (hopefully to remove once above populated)
+  [key: string]: any
 }

package/types/rancher/steve.api.ts

@@ -0,0 +1,40 @@
+import { KubeGetResponse, KubeMetadata } from '@shell/types/kube/kube-api';
+
+/**
+ * Collection of string based values used by the Steve API response's `code` field
+ */
+export const STEVE_RESPONSE_CODE = {
+  /**
+   * When the query param `revision` is sent and it's not in the vai cache then return this error
+   */
+  UNKNOWN_REVISION: 'unknown revision'
+};
+
+/**
+ * Steve API JSON response for LIST requests
+ */
+export interface SteveListResponse<T = any> {
+  actions: any,
+  count: number,
+  data: T[],
+  links: any,
+  resourceType: string,
+  revision: string,
+  type: string,
+
+  // Bucket for everything else (hopefully to remove once above populated)
+  [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/shell/index.d.ts

@@ -2097,9 +2097,34 @@ export namespace WORKLOAD_TYPES {
     let REPLICA_SET: string;
     let REPLICATION_CONTROLLER: string;
 }
+export namespace WORKLOAD_KINDS {
+    let DEPLOYMENT_1: string;
+    export { DEPLOYMENT_1 as DEPLOYMENT };
+    let CRON_JOB_1: string;
+    export { CRON_JOB_1 as CRON_JOB };
+    let DAEMON_SET_1: string;
+    export { DAEMON_SET_1 as DAEMON_SET };
+    let JOB_1: string;
+    export { JOB_1 as JOB };
+    let STATEFUL_SET_1: string;
+    export { STATEFUL_SET_1 as STATEFUL_SET };
+    let REPLICA_SET_1: string;
+    export { REPLICA_SET_1 as REPLICA_SET };
+    let REPLICATION_CONTROLLER_1: string;
+    export { REPLICATION_CONTROLLER_1 as REPLICATION_CONTROLLER };
+}
+/**
+ * Map Rancher Workload types to Kube Workload Kinds
+ */
 export const WORKLOAD_TYPE_TO_KIND_MAPPING: {
     [x: string]: string;
 };
+/**
+ * Map Kube Workload Kinds types to Rancher Workload
+ */
+export const WORKLOAD_KIND_TO_TYPE_MAPPING: {
+    [x: string]: string;
+};
 export const METRICS_SUPPORTED_KINDS: string[];
 export namespace SCALABLE_WORKLOAD_TYPES { }
 export namespace LIST_WORKLOAD_TYPES {
@@ -3434,6 +3459,46 @@ export default class Resource {
             id: any;
         };
     };
+    /**
+     * Override this getter to provide additional action buttons or a custom component
+     * for the detail page title bar.
+     *
+     * @returns {undefined|object|Array} A Vue component definition, an array of RcButton props, or undefined
+     *
+     * @example
+     * // Using an array of button props with the new variant/size props
+     * get detailPageAdditionalActions() {
+     *   return [
+     *     { label: 'Action 1', variant: 'secondary', onClick: () => this.doAction1() },
+     *     { label: 'Action 2', variant: 'primary', size: 'large', onClick: () => this.doAction2() }
+     *   ];
+     * }
+     *
+     * @example
+     * // Using defineComponent with h() render function for custom rendering
+     * import { defineComponent, h } from 'vue';
+     * import RcButton from '@components/RcButton/RcButton.vue';
+     *
+     * get detailPageAdditionalActions() {
+     *   return defineComponent({
+     *     render() {
+     *       return h(RcButton, {
+     *         variant: 'primary',
+     *         onClick: () => console.log('clicked')
+     *       }, () => 'Click Me');
+     *     }
+     *   });
+     * }
+     *
+     * @example
+     * // Using dynamic import for a custom component
+     * import { defineAsyncComponent } from 'vue';
+     *
+     * get detailPageAdditionalActions() {
+     *   return defineAsyncComponent(() => import('@shell/components/MyCustomActions.vue'));
+     * }
+     */
+    get detailPageAdditionalActions(): any;
     goToDetail(): void;
     /**
      * Resource action redirects to the detail page with a query parameter 'clone'
@@ -3647,6 +3712,33 @@ export default class Resource {
      * Allows model to specify JSON Paths that should be folded in the YAML editor by default
      */
     get yamlFolding(): any[];
+    get resourceConditions(): any;
+    get resourceEvents(): any;
+    get insightCardProps(): {
+        title: any;
+        rows: any[];
+    };
+    get insightCard(): {
+        component: any;
+        props: {
+            title: any;
+            rows: any[];
+        };
+    };
+    get _cards(): {
+        component: any;
+        props: {
+            title: any;
+            rows: any[];
+        };
+    }[];
+    get cards(): {
+        component: any;
+        props: {
+            title: any;
+            rows: any[];
+        };
+    }[];
 }
 }
 
@@ -4461,6 +4553,7 @@ export class ApiError extends Error {
     };
 }
 export function normalizeError(err: any): any;
+export function formatAWSError(err: any): any;
 }
 
 // @shell/utils/favicon
@@ -5318,6 +5411,12 @@ export function seenReleaseNotes(store: any): boolean;
 export function markSeenReleaseNotes(store: any): Promise<void>;
 export function readReleaseNotes(store: any): boolean;
 export function markReadReleaseNotes(store: any): Promise<void>;
+/**
+ * Get the release notes URL for a given version
+ *
+ * @param {Get} version s
+ */
+export function getReleaseNotesURL(isPrime: any, version: Get): string;
 }
 
 // @shell/utils/width

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

@@ -48,11 +48,6 @@ export interface ActionFindAllArgs extends ActionCoreFindArgs {
   depaginate?: boolean,
 }
 
-export interface ActionFindPageTransientResult<T> {
-  pagination: StorePagination,
-  data: T[],
-}
-
 /**
  * Args used for findPage action
  */
@@ -81,19 +76,46 @@ export interface ActionFindPageArgs extends ActionCoreFindArgs {
    * If true don't persist the http response to the store, just pass it back
    */
   transient?: boolean,
+  /**
+   * The target minimum revision for the resource.
+   *
+   * If this is higher than the latest revision known to rancher then an error will be returned
+   */
+  revision?: string
 }
 
-export type ActionFindPageResponse<T = any> = {
+/**
+ * Response to a transient (not stored in cache) findPage action
+ */
+export type ActionFindPageTransientResponse<T = any> = {
   data: T[],
   pagination?: StorePagination
-} | T[];
+};
+
+/**
+ * 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
+ *
+ * If the request was not transient this will just be the array of resources
+ */
+export type ActionFindPageResponse<T = any> = ActionFindPageTransientResponse | T[];
 
+/**
+ * Args used for findPage action
+ */
 export interface ActionFindMatchingArgs extends ActionCoreFindArgs {
   labelSelector: KubeLabelSelector,
   namespaced?: string,
   depaginate?: boolean
 }
 
+/**
+ * Response to the findMatching action
+ */
 export type ActionFindMatchingResponse<T = any> = ActionFindPageResponse<T>
 
+/**
+ * Args used for findLabelSelector action
+ */
 export type ActionFindLabelSelectorArgs = ActionFindPageArgs | ActionFindMatchingArgs;

package/types/store/pagination.types.ts

@@ -599,6 +599,7 @@ export interface StorePaginationResult {
    * The last time the resource was updated. Used to assist list watching for changes
    */
   timestamp: number,
+  revision: string,
 }
 
 export interface StorePaginationRequest {

package/types/store/subscribe-events.types.ts

@@ -17,6 +17,7 @@ export interface STEVE_WATCH_EVENT_PARAMS_COMMON {
  */
 export type STEVE_WATCH_EVENT_LISTENER_CALLBACK_PARAMS = {
   forceWatch?: boolean,
+  revision?: string,
 }
 
 /**

package/utils/__tests__/azure.test.ts

@@ -0,0 +1,56 @@
+import { parseAzureError } from '@shell/utils/azure';
+
+describe('azure.js', () => {
+  describe('parseAzureError', () => {
+    it('should extract error from Message="..." format', () => {
+      const err = 'Something went wrong Message="Failure"';
+
+      expect(parseAzureError(err)).toBe('Failure');
+    });
+
+    it('should extract error_description from single-line Response body JSON', () => {
+      const err = 'Error X Response body: {"error_description": "Failure"}';
+
+      expect(parseAzureError(err)).toBe('Failure');
+    });
+
+    it('should extract error.message from multiline JSON containing "error":', () => {
+      const err = `
+       { "error": { "code": "NoRegisteredProviderFound", "message": "No registered resource provider found for location 'X'" } }
+      `;
+
+      expect(parseAzureError(err)).toBe("No registered resource provider found for location 'X'");
+    });
+
+    it('should return undefined if single-line JSON exists but lacks error_description', () => {
+      // Note: Current implementation returns undefined immediately if JSON parses but key is missing
+      const err = 'Response body: {"other_field": "value"}';
+
+      expect(parseAzureError(err)).toBeUndefined();
+    });
+
+    it('should return false if multiline JSON exists but lacks error.message', () => {
+      const err = `
+        {
+          "error": {
+            "code": "NoMessage"
+          }
+        }
+      `;
+
+      expect(parseAzureError(err)).toBe(false);
+    });
+
+    it('should return false if JSON parsing fails', () => {
+      const err1 = 'Response body: { invalid json }';
+      const err2 = '{ "error": { invalid } }';
+
+      expect(parseAzureError(err1)).toBe(false);
+      expect(parseAzureError(err2)).toBe(false);
+    });
+
+    it('should return false for unmatched strings', () => {
+      expect(parseAzureError('error string')).toBe(false);
+    });
+  });
+});