@rancher/shell 3.0.8-rc.10 → 3.0.8-rc.13

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