@rancher/shell 3.0.8-rc.8 → 3.0.8

package/utils/pagination-utils.ts

@@ -165,7 +165,7 @@ class PaginationUtils {
   /**
    * Is pagination enabled at a global level or for a specific resource
    */
-  isEnabled({ rootGetters, $plugin }: any, enabledFor: PaginationResourceContext) {
+  isEnabled({ rootGetters, $extension }: any, enabledFor: PaginationResourceContext) {
     // Cache must be enabled to support pagination api
     if (!this.isSteveCacheEnabled({ rootGetters })) {
       return false;
@@ -184,7 +184,7 @@ class PaginationUtils {
     }
 
     // Does an extension say this type is enabled?
-    const plugin = $plugin as ExtensionManager;
+    const plugin = $extension as ExtensionManager;
     const paginationExtensionPoints = plugin.getAll()[EXT_IDS.SERVER_SIDE_PAGINATION_RESOURCES];
 
     if (paginationExtensionPoints) {

package/utils/pagination-wrapper.ts

@@ -69,7 +69,7 @@ class PaginationWrapper<T extends object> {
     this.classify = formatResponse?.classify || false;
     this.reactive = formatResponse?.reactive || false;
 
-    this.isEnabled = paginationUtils.isEnabled({ rootGetters: $store.getters, $plugin: this.$store.$plugin }, enabledFor);
+    this.isEnabled = paginationUtils.isEnabled({ rootGetters: $store.getters, $extension: this.$store.$extension }, enabledFor);
   }
 
   async request({ pagination, forceWatch }: {

package/utils/provider.ts

@@ -0,0 +1,14 @@
+import { IClusterProvisioner, ClusterProvisionerContext } from '@shell/core/types';
+
+export function getHostedProviders(context: ClusterProvisionerContext) {
+  return context?.$extension?.getProviders(context)?.filter((p: IClusterProvisioner) => p.group === 'hosted') || [];
+}
+
+export function isHostedProvider(context: ClusterProvisionerContext, provisioner: string) {
+  if (!provisioner) {
+    return false;
+  }
+  const provisioners = new Set(getHostedProviders(context).map((p: IClusterProvisioner) => p.id.toLowerCase()));
+
+  return provisioners.has(provisioner.toLowerCase());
+}

package/utils/router.js

@@ -117,3 +117,53 @@ export function findMeta(route, key) {
 
   return undefined;
 }
+
+/**
+ * Find a route definition given a routeName
+ * @param {*} router VueRouter instance
+ * @param {*} routeName the name we want to look up
+ * @returns the route definition or undefined if it wasn't found
+ */
+export function findRouteDefinitionByName(router, routeName) {
+  const routes = router.getRoutes();
+
+  return routes.find((r) => r.name === routeName);
+}
+
+/**
+ * Looks for the route definition and then ensures there's only valid params
+ * @param {*} router VueRouter instance
+ * @param {*} routeRecord an object conforming to the Route Record interface
+ * @returns the passed in routeLocation with only valid params.
+ */
+export function filterLocationValidParams(router, routeRecord) {
+  if (!routeRecord || !routeRecord.name || !routeRecord.params) {
+    console.warn('filterLocationValidParams received invalid arguments'); // eslint-disable-line no-console
+
+    return routeRecord;
+  }
+
+  const routeDefinition = findRouteDefinitionByName(router, routeRecord.name);
+
+  if (!routeDefinition) {
+    console.warn('Could not find a route definition given the routeRecord', routeRecord); // eslint-disable-line no-console
+
+    return routeRecord;
+  }
+
+  const specifiedParams = routeRecord.params;
+  const validParams = {};
+
+  Object.entries(specifiedParams).forEach(([key, value]) => {
+    const pathParam = `:${ key }`;
+
+    if (routeDefinition.path.includes(pathParam)) {
+      validParams[key] = value;
+    }
+  });
+
+  return {
+    ...routeRecord,
+    params: validParams
+  };
+}

package/utils/selector-typed.ts

@@ -199,8 +199,12 @@ export function labelSelectorToSelector(labelSelector?: KubeLabelSelector): stri
   });
 
   (labelSelector?.matchExpressions || []).forEach((value: KubeLabelSelectorExpression) => {
-    if (value.operator === 'In' && value.values?.length === 1) {
-      res.push(`${ value.key }=${ value.values[0] }`);
+    if (value.operator === 'In' && value.values !== undefined) {
+      if (value.values?.length === 1) {
+        res.push(`${ value.key }=${ value.values[0] }`);
+      } else {
+        res.push(`${ value.key } in (${ value.values.join(',') })`);
+      }
     } else {
       throw new Error(`Unsupported matchExpression found when converting to selector string. ${ value }`);
     }

package/utils/unit-tests/pagination-utils.spec.ts

@@ -163,14 +163,14 @@ describe('pagination-utils', () => {
 
     it('should return false if steve cache is disabled', () => {
       mockRootGetters['features/get'].mockImplementation((feature: string) => feature === STEVE_CACHE ? false : undefined);
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(false);
     });
 
     it('should return false if pagination settings are not defined', () => {
       jest.spyOn(paginationUtils, 'getSettings').mockReturnValue(undefined);
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(false);
 
@@ -189,7 +189,7 @@ describe('pagination-utils', () => {
         return null;
       });
 
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, undefined as unknown as PaginationResourceContext);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, undefined as unknown as PaginationResourceContext);
 
       expect(result).toBe(false);
     });
@@ -200,7 +200,7 @@ describe('pagination-utils', () => {
 
       mockPlugin.getAll.mockReturnValue({ [EXT_IDS.SERVER_SIDE_PAGINATION_RESOURCES]: { 'my-ext': () => extensionSettings } });
 
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(true);
     });
@@ -215,7 +215,7 @@ describe('pagination-utils', () => {
       // Mocking PAGINATION_SETTINGS_STORE_DEFAULTS behavior
       jest.spyOn(paginationUtils, 'getStoreDefault').mockReturnValue(defaultSettings);
 
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(true);
     });
@@ -235,7 +235,7 @@ describe('pagination-utils', () => {
       // Mocking PAGINATION_SETTINGS_STORE_DEFAULTS behavior
       jest.spyOn(paginationUtils, 'getStoreDefault').mockReturnValue({ cluster: { resources: { enableAll: true } } });
 
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(true);
     });
@@ -255,7 +255,7 @@ describe('pagination-utils', () => {
         return null;
       });
 
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(true);
     });
@@ -275,7 +275,7 @@ describe('pagination-utils', () => {
         return null;
       });
 
-      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $plugin: mockPlugin }, enabledFor);
+      const result = paginationUtils.isEnabled({ rootGetters: mockRootGetters, $extension: mockPlugin }, enabledFor);
 
       expect(result).toBe(false);
     });

package/vue.config.js

@@ -323,16 +323,16 @@ const getVirtualModules = (dir, includePkg) => {
 
         // Package file must have rancher field to be a plugin
         if (includePkg(name) && library.rancher) {
-          reqs += `$plugin.registerBuiltinExtension('${ name }', require(\'~/pkg/${ name }\')); `;
+          reqs += `$extension.registerBuiltinExtension('${ name }', require(\'~/pkg/${ name }\')); `;
         }
       });
   }
 
   Object.keys(librariesIndex).forEach((i) => {
-    reqs += `$plugin.loadAsync('${ i }', '/pkg/${ i }/${ librariesIndex[i] }');`;
+    reqs += `$extension.loadAsync('${ i }', '/pkg/${ i }/${ librariesIndex[i] }');`;
   });
 
-  return new VirtualModulesPlugin({ 'node_modules/@rancher/dynamic.js': `export default function ($plugin) { ${ reqs } };` });
+  return new VirtualModulesPlugin({ 'node_modules/@rancher/dynamic.js': `export default function ($extension) { ${ reqs } };` });
 };
 
 const getAutoImport = () => new webpack.NormalModuleReplacementPlugin(/^@rancher\/auto-import$/, (resource) => {

package/composables/useExtensionManager.ts

@@ -1,17 +0,0 @@
-import { ExtensionManager } from '@shell/types/extension-manager';
-import { getExtensionManager } from '@shell/core/extension-manager-impl';
-
-/**
- * Provides access to the registered extension manager instance. Used within Vue
- * components or other composables that require extension functionality.
- * @returns The extension manager instance
- */
-export const useExtensionManager = (): ExtensionManager => {
-  const extension = getExtensionManager();
-
-  if (!extension) {
-    throw new Error('useExtensionManager must be called after the extensionManager has been initialized');
-  }
-
-  return extension;
-};

package/core/plugins.js

@@ -1,38 +0,0 @@
-import { throttle } from 'lodash';
-import { initExtensionManager } from './extension-manager-impl';
-
-export default function(context, inject) {
-  const extensionManager = initExtensionManager(context);
-  const deprecationMessage = '[DEPRECATED] `this.$plugin` is deprecated and will be removed in a future version. Use `this.$extension` instead.';
-
-  inject('plugin', deprecationProxy(extensionManager, deprecationMessage));
-  inject('extension', extensionManager);
-}
-
-/**
- * Proxy to log a deprecation warning when target is accessed. Only prints
- * deprecation warnings in dev builds.
- * @param {*} target the object to proxy
- * @param {*} message the deprecation warning to print to the console
- * @returns The proxied target that prints a deprecation warning when target is
- * accessed
- */
-const deprecationProxy = (target, message) => {
-  const logWarning = throttle(() => {
-    // eslint-disable-next-line no-console
-    console.warn(message);
-  }, 150);
-
-  const deprecationHandler = {
-    get(target, prop) {
-      logWarning();
-
-      return Reflect.get(target, prop);
-    }
-  };
-
-  // an empty handler allows the proxy to behave just like the original target
-  const proxyHandler = !!process.env.dev ? deprecationHandler : {};
-
-  return new Proxy(target, proxyHandler);
-};

package/directives/clean-tooltip.js

@@ -1,32 +0,0 @@
-import { VTooltip } from 'floating-vue';
-import { purifyHTML } from '@shell/plugins/clean-html';
-
-function purifyContent(value) {
-  const type = typeof value;
-
-  if (type === 'string') {
-    return purifyHTML(value);
-  } else if (value && type === 'object' && typeof value.content === 'string') {
-    return { ...value, content: purifyHTML(value.content) };
-  } else {
-    return value;
-  }
-}
-
-function beforeMount(el, { value, oldValue, modifiers }) {
-  const purifiedValue = purifyContent(value);
-
-  VTooltip.beforeMount(
-    el,
-    {
-      value: purifiedValue, oldValue, modifiers
-    });
-}
-
-const cleanTooltipDirective = {
-  ...VTooltip,
-  beforeMount,
-  updated: beforeMount,
-};
-
-export default cleanTooltipDirective;

package/plugins/internal-api/index.ts

@@ -1,37 +0,0 @@
-import { Store } from 'vuex';
-
-interface PluginContext {
-  store: Store<any>;
-  [key: string]: any;
-}
-
-export default function(context: PluginContext, inject: (key: string, value: any) => void) {
-  const { store } = context;
-
-  // Load all API modules
-  const apiContext = (require as any).context(
-    '@shell/plugins/internal-api', // the base directory
-    true, // whether to search subdirectories
-    /\.api\.ts$/ // only .api.ts files
-  );
-
-  apiContext.keys().forEach((relativePath: string) => {
-    const mod = apiContext(relativePath);
-    const ApiClass = mod.default;
-
-    if (typeof ApiClass === 'function') {
-      // Check for a static `apiName` property, or fallback to filename
-      let apiName: string = ApiClass.apiName();
-
-      if (!apiName) {
-        // fallback to filename (strip leading ‘./’ and extension)
-        apiName = `$${ relativePath.replace(/^\.\//, '').replace(/\.\w+$/, '') }`;
-      }
-
-      const instance = new ApiClass(store);
-
-      // The inject() method automatically adds the `$` prefix
-      inject(apiName, instance);
-    }
-  });
-}

package/plugins/internal-api/shared/base-api.ts

@@ -1,13 +0,0 @@
-export abstract class BaseApi {
-  // The Vuex store, available to all API classes
-  protected $store: any;
-
-  // Documented requirement: each API should define its static apiName.
-  static apiName(): string {
-    throw new Error('apiName() static method has not been implemented');
-  }
-
-  constructor(store: any) {
-    this.$store = store;
-  }
-}

package/plugins/internal-api/shell/shell.api.ts

@@ -1,108 +0,0 @@
-import { GrowlConfig } from '@shell/types/internal-api/shell/growl';
-import { ModalConfig } from '@shell/types/internal-api/shell/modal';
-import { SlideInConfig } from '@shell/types/internal-api/shell/slideIn';
-
-import { BaseApi } from '@shell/plugins/internal-api/shared/base-api';
-
-export default class ShellApi extends BaseApi {
-  static apiName() {
-    return 'shell';
-  }
-
-  /**
-   * Dispatches a growl notification.
-   *
-   * @param config - Configuration for the growl notification.
-   * - If `message` is a string, it is treated as the main content of the notification.
-   * - If `message` is a `DetailedMessage` object, `title` and `description` are extracted.
-   *
-   * Example:
-   * ```ts
-   * this.$shell.growl({ message: 'Operation successful!', type: 'success' });
-   * this.$shell.growl({ message: { title: 'Warning', description: 'Check your input.' }, type: 'warning' });
-   * ```
-   */
-  protected growl(config: GrowlConfig): void {
-    const { type = 'error', timeout = 5000 } = config;
-
-    let title = '';
-    let description = '';
-
-    if (typeof config.message === 'string') {
-      description = config.message;
-    } else {
-      title = config.message.title || '';
-      description = config.message.description;
-    }
-
-    this.$store.dispatch(
-      `growl/${ type }`,
-      {
-        title,
-        message: description,
-        timeout,
-      },
-      { root: true }
-    );
-  }
-
-  /**
-   * Opens a modal by committing to the Vuex store.
-   *
-   * This method updates the store's `modal` module to show a modal with the
-   * specified configuration. The modal is rendered using the `ModalManager` component,
-   * and its content is dynamically loaded based on the `component` field in the configuration.
-   *
-   * @param config A `ModalConfig` object defining the modal’s content and behavior.
-   *
-   * Example:
-   * ```ts
-   * this.$shell.modal({
-   *   component: MyCustomModal,
-   *   componentProps: { title: 'Hello Modal' },
-   *   resources: [someResource],
-   *   modalWidth: '800px',
-   *   closeOnClickOutside: false
-   * });
-   * ```
-   */
-  protected modal(config: ModalConfig): void {
-    this.$store.commit('modal/openModal', {
-      component:           config.component,
-      componentProps:      config.componentProps || {},
-      resources:           config.resources || [],
-      modalWidth:          config.modalWidth || '600px',
-      closeOnClickOutside: config.closeOnClickOutside ?? true,
-      // modalSticky:         config.modalSticky ?? false // Not implemented yet
-    });
-  }
-
-  /**
-   * Opens the slide-in panel with the specified component and props.
-   *
-   * This method commits the `open` mutation to the `slideInPanel` Vuex module,
-   * which sets the current component to be rendered and its associated props.
-   * The slide-in panel becomes visible after the mutation.
-   *
-   * @param config - The configuration object for the slide-in panel.
-   *
-   * Example Usage:
-   * ```ts
-   * import MyComponent from '@/components/MyComponent.vue';
-   *
-   * this.$shell.slideInPanel({
-   *   component: MyComponent,
-   *   componentProps: { foo: 'bar' }
-   * });
-   * ```
-   *
-   * @param config.component - A Vue component (imported SFC, functional component, etc.) to be rendered in the panel.
-   * @param config.componentProps - (Optional) Props to pass to the component. These should align with the component's defined props.
-   */
-  protected slideInPanel(config: SlideInConfig): void {
-    this.$store.commit('slideInPanel/open', {
-      component:      config.component,
-      componentProps: config.componentProps || {}
-    });
-  }
-}

package/plugins/nuxt-client-init.js

@@ -1,3 +0,0 @@
-export default async(context) => {
-  await context.store.dispatch('nuxtClientInit', context);
-};

package/types/internal-api/shell/growl.d.ts

@@ -1,25 +0,0 @@
-export interface DetailedMessage {
-  title?: string;
-  description: string;
-}
-
-export interface GrowlConfig {
-  /**
-   * The content of the notification message.
-   * Either a simple string or an object with `title` and `description` for detailed notifications.
-   */
-  message: string | DetailedMessage;
-
-  /**
-   * Optional type of the growl notification.
-   * Determines the visual style of the notification.
-   * Defaults to `'error'` if not provided.
-   */
-  type?: 'success' | 'info' | 'warning' | 'error';
-
-  /**
-   * Optional duration (in milliseconds) for which the notification should be displayed.
-   * Defaults to `5000` milliseconds. A value of `0` keeps the notification indefinitely.
-   */
-  timeout?: number;
-}

package/types/internal-api/shell/slideIn.d.ts

@@ -1,15 +0,0 @@
-import type { Component } from 'vue';
-
-/**
- * Configuration object for opening a slide-in panel.
- *
- * @property component - The Vue component to render in the slide-in panel.
- *                       This should be a valid Vue Component, such as an imported SFC or functional component.
- *
- * @property componentProps - (Optional) An object containing props to be passed to the component rendered in the slide-in panel.
- *                            Keys should match the props defined in the provided component.
- */
-export interface SlideInConfig {
-  component: Component | null;
-  componentProps?: Record<string, any>;
-}