dashboard-shell-shell 1.0.10000011122 → 1.6.0-alpha.2

package/rancher-components/RcItemCard/RcItemCard.vue

@@ -0,0 +1,430 @@
+<script setup lang="ts">
+import { ref, computed } from 'vue';
+import { useStore } from 'vuex';
+import { useI18n } from '@shell/composables/useI18n';
+import LazyImage from '@shell/components/LazyImage.vue';
+import { DropdownOption } from '@components/RcDropdown/types';
+import ActionMenu from '@shell/components/ActionMenuShell.vue';
+
+const store = useStore();
+const { t } = useI18n(store);
+
+/**
+ * Variants available for ItemCard layout
+ */
+type RcItemCardVariant = 'small' | 'medium';
+
+/**
+ * A label that can be either plain text or a translatable key.
+ */
+type Label = {
+  key?: string;
+  text?: string;
+};
+
+/**
+ * Represents an image used in the card.
+ */
+type Image = {
+  src: string;
+  alt?: Label;
+};
+
+/**
+ * Optional pill badge, typically used to highlight a tag or state.
+ */
+type Pill = {
+  label: Label;
+  tooltip?: Label;
+};
+
+/**
+ * Represents an icon-based status indicator shown in the card header.
+ */
+type Status = {
+  icon: string;
+  color?: string;
+  customColor?: string;
+  tooltip?: Label;
+  handleClick?: () => void;
+};
+
+/**
+ * Header metadata for the card.
+ */
+type Header = {
+  title?: Label;
+  statuses?: Status[];
+};
+
+/**
+ * The generic data value passed to the card.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type ItemValue = Record<string, any>;
+
+/**
+ * Props accepted by the ItemCard component.
+ */
+interface RcItemCardProps {
+  /** Unique identifier for the card (used in test IDs) */
+  id: string;
+
+  /** Any object value associated with this card */
+  value: ItemValue;
+
+  /** Card title, status icons and action menu. Image will be included in the header in small variant too */
+  header: Header;
+
+  /** Optional image to show in card (position depends on variant). A slot is available for it too #item-card-image */
+  image?: Image;
+
+  /** Optional actions that will be displayed inside an action-menu */
+  actions?: DropdownOption[];
+
+  /** Text content inside the card body. A slot is available for it too #item-card-content */
+  content?: Label;
+
+  /** Layout variant: 'small' or 'medium' */
+  variant?: RcItemCardVariant;
+
+  /** Optional pill shown (only if variant is not 'small'). A slot is available for it too #item-card-pill */
+  pill?: Pill;
+
+  /** Makes the card clickable and emits 'card-click' on click/enter/space */
+  clickable?: boolean;
+}
+
+const props = defineProps<RcItemCardProps>();
+
+/**
+ * Emits 'card-click' when card is clicked or activated via keyboard.
+ */
+const emit = defineEmits<{( e: 'card-click', value: ItemValue): void; }>();
+
+/**
+ * Handles the card click while avoiding nested interactive elements
+ * By using RcItemCardAction.vue the 'item-card-action' attribute automatically gets added
+ * which then gets used to ignore 'card-click'
+ */
+function _handleCardClick(e: MouseEvent | KeyboardEvent) {
+  const interactiveSelector = '[item-card-action]';
+
+  // Prevent card click if the user clicks on an inner actionable element like repo, category, or tag
+  if ((e.target as HTMLElement).closest(interactiveSelector)) {
+    return;
+  }
+
+  emit('card-click', props.value);
+}
+
+/**
+ * Utility to resolve localized or plain text labels.
+ */
+function labelText(label?: Label): string {
+  return label?.key ? t(label.key) : label?.text ?? '';
+}
+
+/** ---------------- data ------------------ */
+const cardEl = ref<HTMLElement | null>(null);
+
+/** ---------------- Computed ------------------ */
+
+const headerTitle = computed(() => labelText(props.header.title));
+const imageAlt = computed(() => labelText(props.image?.alt));
+const pillLabel = computed(() => labelText(props.pill?.label));
+const pillTooltip = computed(() => labelText(props.pill?.tooltip));
+const contentText = computed(() => labelText(props.content));
+const statusTooltips = computed(() => props.header.statuses?.map((status) => labelText(status.tooltip)) || []);
+
+const cardMeta = computed(() => ({
+  ariaLabel: props.clickable ? t('itemCard.ariaLabel.clickable', { cardTitle: labelText(props.header.title) }) : undefined,
+  tabIndex:  props.clickable ? '0' : undefined,
+  role:      props.clickable ? 'button' : undefined
+}));
+
+</script>
+
+<template>
+  <div
+    ref="cardEl"
+    class="item-card"
+    :class="{
+      'clickable':
+        clickable
+    }"
+    :role="cardMeta.role"
+    :tabindex="cardMeta.tabIndex"
+    :aria-label="cardMeta.ariaLabel"
+    :data-testid="`item-card-${id}`"
+    @click="_handleCardClick"
+    @keydown.enter="_handleCardClick"
+    @keydown.space.prevent="_handleCardClick"
+  >
+    <div :class="['item-card-body', variant]">
+      <template v-if="variant !== 'small'">
+        <div>
+          <slot name="item-card-image">
+            <div
+              v-if="image"
+              :class="['item-card-image', variant]"
+              data-testid="item-card-image"
+            >
+              <LazyImage
+                :src="image.src"
+                :alt="imageAlt"
+                :style="{'width': '40px', 'height': '40px', 'object-fit': 'contain'}"
+              />
+            </div>
+          </slot>
+          <slot name="item-card-pill">
+            <div
+              v-if="pill"
+              v-clean-tooltip="pillTooltip"
+              class="item-card-pill"
+              data-testid="item-card-pill"
+            >
+              {{ pillLabel }}
+            </div>
+          </slot>
+        </div>
+      </template>
+
+      <div :class="['item-card-body-details', variant]">
+        <div :class="['item-card-header', variant]">
+          <div class="item-card-header-left">
+            <template v-if="variant === 'small'">
+              <slot name="item-card-image">
+                <div
+                  v-if="image"
+                  :class="['item-card-image', variant]"
+                  data-testid="item-card-image"
+                >
+                  <LazyImage
+                    :src="image.src"
+                    :alt="imageAlt"
+                    :style="{'width': '24px', 'height': '24px', 'object-fit': 'contain'}"
+                  />
+                </div>
+              </slot>
+            </template>
+            <slot name="item-card-header-title">
+              <h3
+                v-if="header.title"
+                v-clean-tooltip="headerTitle"
+                :class="['item-card-header-title', variant]"
+                data-testid="item-card-header-title"
+              >
+                {{ headerTitle }}
+              </h3>
+            </slot>
+          </div>
+          <div class="item-card-header-right">
+            <div
+              v-if="header.statuses?.length"
+              class="item-card-header-statuses"
+            >
+              <div
+                v-for="(status, i) in header.statuses"
+                :key="i"
+                class="item-card-header-statuses-status"
+                data-testid="item-card-header-statuses-status"
+              >
+                <i
+                  v-clean-tooltip="statusTooltips[i]"
+                  :class="['icon', status.icon, status.color]"
+                  :style="{color: status.customColor}"
+                  :data-testid="`item-card-header-status-${i}`"
+                />
+              </div>
+            </div>
+
+            <template v-if="$slots['item-card-actions']">
+              <div class="item-card-header-action-menu">
+                <slot name="item-card-actions" />
+              </div>
+            </template>
+            <template v-else-if="actions">
+              <div class="item-card-header-action-menu">
+                <ActionMenu
+                  data-testid="item-card-header-action-menu"
+                  :custom-actions="actions"
+                />
+              </div>
+            </template>
+          </div>
+        </div>
+
+        <slot name="item-card-sub-header" />
+
+        <template v-if="$slots['item-card-content']">
+          <slot name="item-card-content">
+            <div
+              class="item-card-content"
+              data-testid="item-card-content"
+            />
+          </slot>
+        </template>
+        <template v-else-if="content">
+          <div
+            class="item-card-content"
+            data-testid="item-card-content"
+          >
+            <p>{{ contentText }}</p>
+          </div>
+        </template>
+
+        <slot name="item-card-footer" />
+      </div>
+    </div>
+  </div>
+</template>
+
+<style scoped lang="scss">
+$image-medium-box-width: 48px;
+
+.item-card {
+  display: flex;
+  padding: 16px;
+  align-items: flex-start;
+  gap: var(--gap-lg);
+  border-radius: var(--border-radius-md);
+  border: 1px solid var(--border);
+  background: var(--body-bg);
+
+  &.clickable:hover {
+    border-color: var(--primary);
+  }
+
+  &:focus-visible {
+    @include focus-outline;
+    outline-offset: -2px;
+  }
+
+  &-image {
+    width: $image-medium-box-width;
+    height: $image-medium-box-width;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    background: #fff;
+    border-radius: var(--border-radius);
+
+    &.small {
+      width: 32px;
+      height: 32px;
+      margin-right: 12px;
+    }
+  }
+
+  &-header {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+    width: 100%;
+    height: 24px;
+    color: var(--body-text);
+
+    &-left,
+    &-right {
+      display: flex;
+      align-items: center;
+    }
+
+    &-left {
+      flex-grow: 1;
+      min-width: 0;
+    }
+
+    &-title {
+      max-width: 80%;
+      font-size: 18px;
+      font-weight: 600;
+      margin-bottom: 0px;
+      line-height: 24px;
+      text-overflow: ellipsis;
+      white-space: nowrap;
+      overflow: hidden;
+    }
+
+    &-statuses {
+      display: flex;
+      align-items: flex-start;
+      gap: 12px;
+
+      &-status {
+        width: 24px;
+        height: 24px;
+        display: flex;
+        align-items: center;
+        justify-content: center;
+
+        .icon {
+          font-size: 23px;
+
+          &.error    { color: var(--error); }
+          &.info     { color: var(--info); }
+          &.success  { color: var(--success); }
+        }
+      }
+    }
+
+    &-action-menu {
+      margin-left: 12px;
+    }
+  }
+
+  &-content {
+    display: -webkit-box;
+    -webkit-line-clamp: 3;
+    -webkit-box-orient: vertical;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    line-height: 21px;
+    word-break: break-word;
+  }
+
+  &-pill {
+    display: flex;
+    width: $image-medium-box-width;
+    padding: 4px 8px;
+    margin-top: 16px;
+    justify-content: center;
+    align-items: center;
+    border-radius: var(--border-radius);
+    background: var(--default);
+    text-transform: uppercase;
+    color: var(--disabled-text);
+    font-size: 10px;
+    font-weight: 600;
+  }
+
+  &-body {
+    display: flex;
+    flex-direction: row;
+    width: 100%;
+    gap: var(--gap-lg);
+
+    &.small {
+      flex-direction: column;
+      align-items: flex-start;
+      gap: var(--gap);
+      flex: 1;
+    }
+
+    &-details {
+      display: flex;
+      flex-direction: column;
+      align-items: flex-start;
+      width: calc(100% - var(--gap-lg) - $image-medium-box-width);
+      gap: var(--gap);
+      flex: 1;
+
+      &.small {
+        width: 100%;
+      }
+    }
+  }
+}
+
+</style>

package/rancher-components/RcItemCard/RcItemCardAction.vue

@@ -0,0 +1,24 @@
+<script setup lang="ts">
+/**
+ * RcItemCardAction
+ *
+ * This component is used to wrap any interactive elements (like buttons, links)
+ * inside an RcItemCard so they don't trigger the card-click event.
+ *
+ * Usage:
+ *
+ * <rc-item-card-action @click="doSomething">
+ *   <a href="#">Click me</a>
+ * </rc-item-card-action>
+ *
+ */
+</script>
+
+<template>
+  <div
+    item-card-action
+    data-testid="rc-item-card-action"
+  >
+    <slot />
+  </div>
+</template>

package/rancher-components/RcItemCard/index.ts

@@ -0,0 +1,2 @@
+export { default as RcItemCard } from './RcItemCard.vue';
+export { default as RcItemCardAction } from './RcItemCardAction.vue';

package/rancher-components/StringList/StringList.vue

@@ -633,7 +633,7 @@ export default defineComponent({
 }
 
 :deep() {
-  /* .labeled-input INPUT.no-label, */
+  // .labeled-input INPUT.no-label,
   .labeled-input INPUT:hover.no-label,
   .labeled-input INPUT:focus.no-label {
     padding: 1px 0px 0px 0px;

package/scripts/extension/publish

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-set -eo pipefail
+# set -eo pipefail comment out for now because of a Harvester issue
 
 SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
 BASE_DIR="$(pwd)"

package/scripts/publish-shell.sh

@@ -1,110 +1,136 @@
 #!/usr/bin/env bash
 
-# 执行命令：TAG=cloud-shell-pkg-v{版本号} ./cloud-shell/scripts/publish-shell.sh
+# 执行命令示例：
+# TAG=shell-pkg-v3.0.5-test.35 ./shell/scripts/publish-shell.sh
 
-set -eo pipefail
+set -euo pipefail
 
+# --------------------------
+# 基础路径
+# --------------------------
 SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" &>/dev/null && pwd)"
-BASE_DIR="$(cd $SCRIPT_DIR && cd ../.. && pwd)"
+BASE_DIR="$(cd "$SCRIPT_DIR" && cd ../.. && pwd)"
 echo "BASE_DIR is ${BASE_DIR}"
 echo "SCRIPT_DIR is ${SCRIPT_DIR}"
 echo "PWD is $(pwd)"
-CLOUD_SHELL_DIR=$BASE_DIR/cloud-shell/
-echo "CLOUD_SHELL_DIR is ${CLOUD_SHELL_DIR}"
-CREATORS_DIR=$BASE_DIR/creators/extension
+
+SHELL_DIR="$BASE_DIR/shell/"
+CREATORS_DIR="$BASE_DIR/creators/extension"
+
 FORCE_PUBLISH_TO_NPM="false"
 DEFAULT_NPM_REGISTRY="https://registry.npmjs.org"
 
-# if TAG doesn't exist, we can exit as it's needed for any type of publish.
-if [ -z "$TAG" ]; then
+# --------------------------
+# TAG 必须存在
+# --------------------------
+if [ -z "${TAG:-}" ]; then
   echo "You need to set the TAG variable first!"
   exit 1
 fi
 
-if [ ! -d "${BASE_DIR}/node_modules" ]; then
+# --------------------------
+# node_modules 检查
+# --------------------------
+if [[ ! -d "$BASE_DIR/node_modules" ]]; then
   echo "You need to run 'yarn install' first"
   exit 1
 fi
 
-echo "Publishing Cloud Shell Packages"
+echo "Publishing Shell Packages"
 
-if [ "$1" == "--npm" ]; then
+# --------------------------
+# NPM 发布参数
+# --------------------------
+if [[ "${1:-}" == "--npm" ]]; then
   FORCE_PUBLISH_TO_NPM="true"
 fi
 
-if [ "$FORCE_PUBLISH_TO_NPM" == "true" ]; then
-  export NPM_REGISTRY=$DEFAULT_NPM_REGISTRY
+if [[ "$FORCE_PUBLISH_TO_NPM" == "true" ]]; then
+  export NPM_REGISTRY="$DEFAULT_NPM_REGISTRY"
 fi
 
-PUBLISH_ARGS="--no-git-tag-version --access public --registry $NPM_REGISTRY"
-
-pushd ${CLOUD_SHELL_DIR} >/dev/null
-
-function publish() {
-  NAME=$1
-  FOLDER=$2
+PUBLISH_ARGS="--no-git-tag-version --access public --registry ${NPM_REGISTRY:-$DEFAULT_NPM_REGISTRY}"
 
-  if [ -n "$3" ]; then
-    PKG_VERSION=$3
-  fi
+# --------------------------
+# 解析 TAG
+# --------------------------
+if [[ "$TAG" =~ ^([a-zA-Z-]+)-pkg-v(.+)$ ]]; then
+  PKG_NAME="${BASH_REMATCH[1]}"
+  PKG_V="${BASH_REMATCH[2]}"
+else
+  echo "TAG format invalid: $TAG. Must be like 'shell-pkg-v3.0.2-rc.105'"
+  exit 1
+fi
 
-  if [ ${DRY_RUN} == "true" ]; then
-    PUBLISH_ARGS="$PUBLISH_ARGS --dry-run"
+echo "PKG_NAME=${PKG_NAME}"
+echo "PKG_V=${PKG_V}"
+
+# --------------------------
+# publish 函数
+# --------------------------
+publish() {
+  local NAME="$1"
+  local FOLDER="$2"
+  local VERSION="${3:-$PKG_V}"
+
+  if [[ "${DRY_RUN:-false}" == "true" ]]; then
+    local ARGS="$PUBLISH_ARGS --dry-run"
+  else
+    local ARGS="$PUBLISH_ARGS"
   fi
 
-  echo "Publish to NPM - arguments ::: ${PUBLISH_ARGS}"
+  echo "Publish to NPM - arguments ::: ${ARGS}"
+  echo "Publishing ${NAME} version ${VERSION} from ${FOLDER}"
 
-  echo "Publishing ${NAME} from ${FOLDER}"
-  pushd ${FOLDER} >/dev/null
+  pushd "$FOLDER" >/dev/null || exit 1
 
-  # For now, copy the rancher components into the shell and ship them with it
-  if [ "$NAME" == "Cloud Shell" ]; then
+  # 复制 rancher-components
+  if [[ "$NAME" == "Shell" ]]; then
     echo "Adding Rancher Components"
     rm -rf ./rancher-components
-    cp -R ${BASE_DIR}/pkg/rancher-components/src/components ./rancher-components/
+    cp -R "$BASE_DIR/pkg/rancher-components/src/components" ./rancher-components/
   fi
 
-  node ${SCRIPT_DIR}/record-deps.js
-
-  echo "Publishing to registry: $NPM_REGISTRY"
+  # 记录依赖
+  node "$SCRIPT_DIR/record-deps.js" || {
+    echo "record-deps.js failed"
+    popd >/dev/null
+    exit 1
+  }
 
-  npm publish ${PUBLISH_ARGS}
-  RET=$?
+  # NPM 发布
+  echo "Publishing to registry: ${NPM_REGISTRY:-$DEFAULT_NPM_REGISTRY}"
+  npm publish $ARGS || {
+    echo "Error publishing package ${NAME}"
+    popd >/dev/null
+    exit 1
+  }
 
   popd >/dev/null
-
-  if [ $RET -ne 0 ]; then
-    echo "Error publishing package ${NAME}"
-    exit $RET
-  fi
 }
 
-echo "TAG ${TAG}"
-  
-# let's get the package name and version from the tag
-PKG_NAME=$(sed 's/-pkg-v.*//' <<< "$TAG")
-PKG_V=$(sed 's/.*-pkg-v//'<<< "$TAG")
-
-echo "PKG_NAME ${PKG_NAME}"
-echo "PKG_V ${PKG_V}"
-
-# Generate the type definitions for the cloud-shell
-if [ ${PKG_NAME} == "cloud-shell" ]; then
-  ${SCRIPT_DIR}/typegen.sh
+# --------------------------
+# 生成 TypeScript 类型
+# --------------------------
+if [[ "$PKG_NAME" == "shell" ]]; then
+  echo "Generating TypeScript definitions..."
+  bash "$SCRIPT_DIR/typegen.sh" || { echo "Type generation failed"; exit 1; }
 fi
 
-# version comparison checks
-case $PKG_NAME in
-  "cloud-shell")
-    echo "Publishing only Cloud Shell pkg via tagged release"
-    publish "Cloud Shell" ${CLOUD_SHELL_DIR} ${PKG_V}
+# --------------------------
+# 根据 TAG 发布
+# --------------------------
+case "$PKG_NAME" in
+  "shell")
+    echo "Publishing only Shell pkg via tagged release"
+    publish "Shell" "$SHELL_DIR" "$PKG_V"
     ;;
   "creators")
     echo "Publishing only Creators pkg via tagged release"
-    publish "Extension creator" ${CREATORS_DIR} ${PKG_V}
+    publish "Extension creator" "$CREATORS_DIR" "$PKG_V"
     ;;
   *)
-    echo "something went wrong with the tagging name => TAG: ${TAG} , PKG_NAME: ${PKG_NAME}. Admissable names are 'cloud-shell' and 'creators'"
+    echo "Something went wrong with the tagging name => TAG: ${TAG}, PKG_NAME: ${PKG_NAME}. Admissible names are 'shell' and 'creators'"
     exit 1
     ;;
 esac