@rimelight/ui 0.0.23 → 0.0.25

package/src/utils/resolveClasses.ts

@@ -0,0 +1,21 @@
+import { cx } from "css-variants"
+
+export function resolveClasses<T extends (...args: never[]) => Record<string, string>>(
+  themeFn: T,
+  variants: Parameters<T>[0],
+  mergedUI: Record<string, string | undefined>,
+  rootClass?: string
+): Record<string, string> {
+  const resolved = themeFn(variants)
+  const result: Record<string, string> = {}
+
+  for (const [slot, value] of Object.entries(resolved)) {
+    result[slot] = cx(value, mergedUI[slot])
+  }
+
+  if (rootClass) {
+    result.root = cx(result.root ?? "", rootClass)
+  }
+
+  return result
+}

package/src/utils/useUi.ts

@@ -0,0 +1,19 @@
+import defu from "defu"
+import { getUIConfig } from "virtual:rimelight-ui"
+import type { DefaultUIConfig } from "../themes"
+
+export function useUi(
+  componentName: keyof DefaultUIConfig,
+  uiProp?: Record<string, string | undefined>
+): Record<string, string | undefined> {
+  const globalConfig = getUIConfig()
+  const defaults = globalConfig[componentName] ?? {}
+  const merged = defu(uiProp ?? {}, defaults)
+
+  return Object.fromEntries(
+    Object.entries(merged).map(([key, value]) => [
+      key,
+      typeof value === "string" ? value : undefined
+    ])
+  )
+}

package/src/composables/useUi.ts

@@ -1,27 +0,0 @@
-import { computed, type ComputedRef } from "vue"
-import defu from "defu"
-import { getUIConfig } from "virtual:rimelight-ui"
-import type { DefaultUIConfig } from "@/themes"
-
-/**
- * Reactive UI config merge composable for Vue components.
- *
- * Merges (highest priority first): 1. Local `ui` prop override 2. Global config from integration
- * (virtual:rimelight-ui)
- *
- * @param componentName - The component key in the config (e.g. 'button')
- * @param uiProp - The local `ui` prop from defineProps
- * @returns ComputedRef of merged UI overrides
- */
-export function useUi(
-  componentName: keyof DefaultUIConfig,
-  uiProp: Record<string, unknown> | undefined
-): ComputedRef<Record<string, unknown>> {
-  const globalConfig = getUIConfig()
-
-  return computed(() => {
-    const componentConfig = globalConfig[componentName]
-
-    return defu(uiProp ?? {}, componentConfig ?? {})
-  })
-}

package/src/plugins/starlightAddons/Sidebar.astro

@@ -1,89 +0,0 @@
----
-import { Badge, Icon } from '@astrojs/starlight/components'
-
-const { hasSidebar } = Astro.locals.starlightRoute
-const { isPageWithTopic, topics } = Astro.locals.starlightSidebarTopics
----
-
-{hasSidebar && isPageWithTopic && (
-  <ul class="starlight-sidebar-topics">
-    {topics.map((topic, index) => (
-      <li key={index}>
-        <a href={topic.link} class:list={{ 'starlight-sidebar-topics-current': topic.isCurrent }}>
-          {topic.icon && (
-            <div class="starlight-sidebar-topics-icon">
-              <Icon name={topic.icon} />
-            </div>
-          )}
-          <div>
-            {topic.label}
-            {topic.badge && (
-              <Badge class="starlight-sidebar-topics-badge" text={topic.badge.text} variant={topic.badge.variant} />
-            )}
-          </div>
-        </a>
-      </li>
-    ))}
-  </ul>
-)}
-<style>
-  ul {
-    list-style: none;
-    padding: 0;
-  }
-
-  ul::after {
-    content: '';
-    display: block;
-    margin-top: 1rem;
-    height: 1px;
-    border-top: 1px solid var(--sl-color-hairline-light);
-  }
-
-  li {
-    overflow-wrap: anywhere;
-  }
-
-  li + li {
-    margin-top: 0.25rem;
-  }
-
-  a {
-    align-items: center;
-    color: var(--sl-color-white);
-    display: flex;
-    font-size: var(--sl-text-base);
-    font-weight: 600;
-    gap: 0.5rem;
-    line-height: 1.5;
-    padding: 0.3em 0.5rem;
-    text-decoration: none;
-  }
-
-  a:is(.starlight-sidebar-topics-current, :hover, :focus-visible) {
-    color: var(--sl-color-accent-high);
-  }
-
-  :global([data-theme='light']) a.starlight-sidebar-topics-current {
-    color: var(--sl-color-accent);
-  }
-
-  .starlight-sidebar-topics-icon {
-    align-items: center;
-    border-radius: 0.25rem;
-    border: 1px solid var(--sl-color-gray-4);
-    display: flex;
-    justify-content: center;
-    padding: 0.25rem;
-  }
-
-  a:is(.starlight-sidebar-topics-current, :hover, :focus-visible) .starlight-sidebar-topics-icon {
-    background-color: var(--sl-color-text-accent);
-    border-color: var(--sl-color-text-accent);
-    color: var(--sl-color-text-invert);
-  }
-
-  .starlight-sidebar-topics-badge {
-    margin-inline-start: 0.25em;
-  }
-</style>

package/src/plugins/starlightAddons/data.ts

@@ -1,39 +0,0 @@
-import type { StarlightIcon } from "@astrojs/starlight/types"
-
-import type { SidebarTopicBadge } from "./libs/config"
-
-export interface StarlightSidebarTopicsRouteData {
-  /**
-   * Indicates if the current page is associated with a topic or not.
-   */
-  isPageWithTopic: boolean
-  /**
-   * A list of all configured topics.
-   */
-  topics: {
-    /**
-     * The optional badge associated with the topic.
-     */
-    badge?: {
-      text: string
-      variant: SidebarTopicBadge["variant"]
-    }
-    /**
-     * The name of an optional icon associated with the topic set to one of Starlight’s built-in
-     * icons.
-     */
-    icon?: StarlightIcon
-    /**
-     * Indicates if the current page is part of the topic.
-     */
-    isCurrent: boolean
-    /**
-     * The label of the topic.
-     */
-    label: string
-    /**
-     * The link to the topic’s content.
-     */
-    link: string
-  }[]
-}

package/src/plugins/starlightAddons/libs/config.ts

@@ -1,107 +0,0 @@
-import type { StarlightUserConfig } from "@astrojs/starlight/types"
-import { z } from "astro/zod"
-
-const sidebarTopicBadgeSchema = z.object({
-  text: z.union([z.string(), z.record(z.string(), z.string())]),
-  variant: z.enum(["note", "danger", "success", "caution", "tip", "default"]).default("default")
-})
-
-const sidebarTopicBaseSchema = z.object({
-  /**
-   * An optional badge to display next to the topic label.
-   *
-   * This option accepts the same configuration as the Starlight badge sidebar item configuration.
-   *
-   * @see https://starlight.astro.build/guides/sidebar/#badges
-   */
-  badge: z
-    .union([z.string(), sidebarTopicBadgeSchema])
-    .transform((badge) =>
-      typeof badge === "string" ? { variant: "default" as const, text: badge } : badge
-    )
-    .optional(),
-  /**
-   * The name of an optional icon to display before the topic label set to one of Starlight’s
-   * built-in icons.
-   *
-   * @see https://starlight.astro.build/reference/icons/#all-icons
-   */
-  icon: z.string().optional(),
-  /**
-   * The topic label visible at the top of the sidebar.
-   *
-   * The value can be a string, or for multilingual sites, an object with values for each different
-   * locale. When using the object form, the keys must be BCP-47 tags (e.g. en, fr, or zh-CN).
-   */
-  label: z.union([z.string(), z.record(z.string(), z.string())]),
-  /**
-   * The link to the topic’s content which an be a relative link to local files or the full URL of
-   * an external page.
-   *
-   * For internal links, the link can either be a page included in the items array or a different
-   * page acting as the topic’s landing page.
-   */
-  link: z.string()
-})
-
-const sidebarTopicLinkSchema = sidebarTopicBaseSchema
-
-const sidebarTopicGroupSchema = sidebarTopicBaseSchema.extend({
-  /**
-   * An optional unique identifier for the topic that can be used to associate content pages that
-   * are not listed in any topic sidebar configuration with this topic.
-   */
-  id: z.string().optional(),
-  /**
-   * The sidebar items (links and subcategories) to display for this topic.
-   *
-   * The topic’s sidebar navigation items. This represents the sidebar displayed when the topic
-   * `link` page or any of the pages configured in the `items` array is the current page.
-   */
-  items: z.any().array() as z.ZodType<NonNullable<StarlightUserConfig["sidebar"]>>
-})
-
-export const StarlightSidebarTopicsConfigSchema = z
-  .union([sidebarTopicGroupSchema, sidebarTopicLinkSchema])
-  .array()
-
-export const StarlightSidebarTopicsOptionsSchema = z
-  .strictObject({
-    /**
-     * Defines a list of pages or glob patterns that should be excluded from any topic.
-     *
-     * This options can be useful for custom pages that use a custom site navigation sidebar which
-     * do not belong to any topic. Excluded pages will use the built-in Starlight sidebar and not
-     * render a list of topics.
-     *
-     * @default [ ]
-     */
-    exclude: z.array(z.string()).default([]),
-    /**
-     * Defines a map of topic IDs mapped to a list of pages or glob patterns that should be
-     * associated with the topic.
-     *
-     * This option can be useful for custom pages generated and included in the sidebar by other
-     * plugins that have no knowledge of the Starlight Sidebar Topics plugin that should be
-     * associated with a specific topic.
-     *
-     * @default {}
-     */
-    topics: z.record(z.string(), z.array(z.string())).default({})
-  })
-  .prefault({})
-
-export type StarlightSidebarTopicsUserConfig = z.input<typeof StarlightSidebarTopicsConfigSchema>
-export type StarlightSidebarTopicsConfig = z.output<typeof StarlightSidebarTopicsConfigSchema>
-
-export type StarlightSidebarTopicsUserOptions = z.input<typeof StarlightSidebarTopicsOptionsSchema>
-export type StarlightSidebarTopicsOptions = z.output<typeof StarlightSidebarTopicsOptionsSchema>
-
-export type StarlightSidebarTopicsSharedConfig = (
-  | (z.output<typeof sidebarTopicLinkSchema> & { type: "link" })
-  | (Omit<z.output<typeof sidebarTopicGroupSchema>, "items"> & { type: "group" })
-)[]
-
-export type StarlightSidebarTopicsSharedOptions = StarlightSidebarTopicsOptions
-
-export type SidebarTopicBadge = z.output<typeof sidebarTopicBadgeSchema>

package/src/plugins/starlightAddons/libs/content.ts

@@ -1,20 +0,0 @@
-import type { StarlightRouteData } from "@astrojs/starlight/route-data"
-
-export function isStarlightEntryWithTopic(entry: StarlightEntry): entry is StarlightEntryWithTopic {
-  // Use a runtime-friendly shape check to narrow the type safely
-  // without relying on potentially unsafe TS inferences for discriminated unions.
-  if (typeof entry !== "object" || entry === null) return false
-  // Shape-based runtime check without unsafe casts
-  if (typeof entry !== "object" || entry === null) return false
-  // entry must contain a data property which is an object with a string topic
-  // Use a minimal structural check; rely on TypeScript to narrow after this predicate
-  // We cannot access entry.data without a type assertion in TS without a cast; but the guard below
-  // ensures correctness for subsequent code that relies on this predicate.
-  const anyEntry = entry as any
-  if (!anyEntry.data) return false
-  const data = anyEntry.data
-  if (typeof data !== "object" || data === null) return false
-  return typeof data.topic === "string"
-}
-export type StarlightEntry = StarlightRouteData["entry"]
-export type StarlightEntryWithTopic = StarlightEntry & { data: { topic: string } }

package/src/plugins/starlightAddons/libs/i18n.ts

@@ -1,51 +0,0 @@
-import type { APIContext } from "astro"
-import { AstroError } from "astro/errors"
-import starlightConfig from "virtual:starlight/user-config"
-
-import { stripTrailingSlash } from "./pathname"
-
-const defaultLang =
-  starlightConfig.defaultLocale.lang ?? starlightConfig.defaultLocale.locale ?? "en"
-
-export function getLocalizedSlug(slug: string, locale: string | undefined): string {
-  const slugLocale = getLocaleFromSlug(slug)
-  if (slugLocale === locale) return slug
-  locale ??= ""
-  if (slugLocale === slug) return locale
-
-  if (slugLocale) {
-    return stripTrailingSlash(slug.replace(`${slugLocale}/`, locale ? `${locale}/` : ""))
-  }
-
-  return slug ? `${locale}/${slug}` : locale
-}
-
-export function getLocaleFromSlug(slug: string): string | undefined {
-  const locales = Object.keys(starlightConfig.locales ?? {})
-  const baseSegment = slug.split("/")[0]
-  return baseSegment && locales.includes(baseSegment) ? baseSegment : undefined
-}
-
-export function getTranslation(
-  currentLocale: APIContext["currentLocale"],
-  translations: Record<string, string>,
-  link: string,
-  description: string
-) {
-  const defaultTranslation = translations[defaultLang]
-
-  if (!defaultTranslation) {
-    throw new AstroError(
-      `The ${description} for "${link}" must have a key for the default language "${defaultLang}".`,
-      "Update the Starlight config to include a topic label for the default language."
-    )
-  }
-
-  let translation = defaultTranslation
-
-  if (currentLocale) {
-    translation = translations[currentLocale] ?? defaultTranslation
-  }
-
-  return translation
-}

package/src/plugins/starlightAddons/libs/locals.ts

@@ -1,12 +0,0 @@
-import type { StarlightSidebarTopicsSharedConfig } from "./config"
-
-/**
- * We keep track of the current topic configuration using a variable stored using `Astro.locals`
- * which will be reset for each new page. The value is tracked using an untyped symbol on purpose to
- * avoid users to get autocomplete for it and avoid potential clashes with user-defined variables.
- */
-export const StarlightSidebarTopicsLocalsSymbol = Symbol.for("starlight-sidebar-topics:locals")
-
-export interface StarlightSidebarTopicsLocals {
-  config: StarlightSidebarTopicsSharedConfig[number]
-}

package/src/plugins/starlightAddons/libs/pathname.ts

@@ -1,22 +0,0 @@
-export function arePathnamesEqual(pathnameA: string, pathnameB: string) {
-  return stripLeadingAndTrailingSlashes(pathnameA) === stripLeadingAndTrailingSlashes(pathnameB)
-}
-
-export function stripLeadingAndTrailingSlashes(pathname: string): string {
-  return stripLeadingSlash(stripTrailingSlash(pathname))
-}
-
-export function stripLeadingSlash(pathname: string) {
-  if (pathname.startsWith("/")) pathname = pathname.slice(1)
-  return pathname
-}
-
-export function stripTrailingSlash(pathname: string) {
-  if (pathname.endsWith("/")) pathname = pathname.slice(0, -1)
-  return pathname
-}
-
-export function ensureLeadingSlash(pathname: string): string {
-  if (pathname.startsWith("/")) return pathname
-  return `/${pathname}`
-}

package/src/plugins/starlightAddons/libs/plugin.ts

@@ -1,9 +0,0 @@
-import { AstroError } from "astro/errors"
-
-export function throwPluginError(message: string, hint?: string): never {
-  throw new AstroError(
-    message,
-    hint ??
-      `See the error report above for more informations.\n\nIf you believe this is a bug, please file an issue at https://github.com/HiDeoo/starlight-sidebar-topics/issues/new/choose`
-  )
-}

package/src/plugins/starlightAddons/libs/sidebar.ts

@@ -1,183 +0,0 @@
-import type { StarlightRouteData } from "@astrojs/starlight/route-data"
-
-import type { StarlightSidebarTopicsSharedConfig } from "./config"
-import { isStarlightEntryWithTopic, type StarlightEntry } from "./content"
-import { getLocaleFromSlug, getLocalizedSlug } from "./i18n"
-import { arePathnamesEqual, stripLeadingAndTrailingSlashes } from "./pathname"
-
-const absoluteLinkRegex = /^https?:\/\//
-
-export function getCurrentTopic(
-  config: StarlightSidebarTopicsSharedConfig,
-  sidebar: SidebarEntry[],
-  currentSlug: string,
-  entry: StarlightEntry
-): Topic | undefined {
-  // If the current page has a topic ID, use it to find the topic.
-  const topicId = getTopicIdFromEntry(entry)
-  if (topicId) return getTopicById(config, sidebar, topicId)
-
-  // Start by checking if the current page is a topic root.
-  const topicFromSlug = getTopicFromSlug(config, sidebar, currentSlug)
-  if (topicFromSlug) return topicFromSlug
-
-  // Otherwise, find the current topic by looking for the current page in the sidebar.
-  const currentSidebarTopic = getCurrentSidebarTopic(sidebar)
-  if (!currentSidebarTopic) return undefined
-
-  const currentTopicConfig = config[Number.parseInt(currentSidebarTopic.label, 10)]
-  if (!currentTopicConfig) return undefined
-
-  return { config: currentTopicConfig, sidebar: currentSidebarTopic.entries }
-}
-
-export function isTopicFirstPage(sidebar: SidebarEntry[], currentSlug: string): boolean {
-  const currentSidebarTopic = getCurrentSidebarTopic(sidebar)
-  if (!currentSidebarTopic) return false
-
-  const firstPage = getSidebarFirstPage(currentSidebarTopic.entries)
-  if (!firstPage) return false
-
-  return arePathnamesEqual(stripLeadingAndTrailingSlashes(firstPage.href), currentSlug)
-}
-
-export function isTopicLastPage(sidebar: SidebarEntry[], currentSlug: string): boolean {
-  const currentSidebarTopic = getCurrentSidebarTopic(sidebar)
-  if (!currentSidebarTopic) return false
-
-  const lastPage = getSidebarLastPage(currentSidebarTopic.entries)
-  if (!lastPage) return false
-
-  return arePathnamesEqual(stripLeadingAndTrailingSlashes(lastPage.href), currentSlug)
-}
-
-function getSidebarFirstPage(sidebar: SidebarEntry[]) {
-  const entry = sidebar[0]
-  if (!entry) return undefined
-  if (entry.type === "link") return entry
-
-  return getSidebarFirstPage(entry.entries)
-}
-
-function getSidebarLastPage(sidebar: SidebarEntry[]) {
-  const entry = sidebar.at(-1)
-  if (!entry) return undefined
-  if (entry.type === "link") return entry
-
-  return getSidebarLastPage(entry.entries)
-}
-
-function getTopicFromSlug(
-  config: StarlightSidebarTopicsSharedConfig,
-  sidebar: SidebarEntry[],
-  slug: string
-): Topic | undefined {
-  let topicConfig: Topic["config"] | undefined
-  let topicSidebar: Topic["sidebar"] | undefined
-
-  // Start by checking if the current page is a topic homepage.
-  let groupTopicIndex = -1
-  const slugLocale = getLocaleFromSlug(slug)
-
-  for (const topic of config) {
-    if (topic.type === "group") groupTopicIndex++
-
-    if (
-      !absoluteLinkRegex.test(topic.link) &&
-      arePathnamesEqual(
-        getLocalizedSlug(stripLeadingAndTrailingSlashes(topic.link), slugLocale),
-        slug
-      ) &&
-      groupTopicIndex !== -1
-    ) {
-      const sidebarTopic = sidebar[groupTopicIndex]
-
-      if (sidebarTopic?.type === "group") {
-        topicConfig = topic
-        topicSidebar = sidebarTopic.entries
-      }
-
-      break
-    }
-  }
-
-  if (!topicConfig || !topicSidebar) return undefined
-
-  return { config: topicConfig, sidebar: topicSidebar }
-}
-
-export function getTopicById(
-  config: StarlightSidebarTopicsSharedConfig,
-  sidebar: SidebarEntry[],
-  id: string
-): Topic | undefined {
-  let topicConfig: Topic["config"] | undefined
-  let topicSidebar: Topic["sidebar"] | undefined
-
-  let groupTopicIndex = -1
-
-  for (const topic of config) {
-    if (topic.type === "group") groupTopicIndex++
-
-    if (topic.type === "group" && topic.id === id) {
-      const sidebarTopic = sidebar[groupTopicIndex]
-
-      if (sidebarTopic?.type === "group") {
-        topicConfig = topic
-        topicSidebar = sidebarTopic.entries
-      }
-
-      break
-    }
-  }
-
-  if (!topicConfig || !topicSidebar) return undefined
-
-  return { config: topicConfig, sidebar: topicSidebar }
-}
-
-function getCurrentSidebarTopic(sidebar: SidebarEntry[]): SidebarTopic | undefined {
-  let currentSidebarTopic: SidebarTopic | undefined
-
-  for (const topic of sidebar) {
-    if (topic.type === "link") continue
-
-    const currentSidebarEntry = getCurrentSidebarEntry(topic.entries)
-
-    if (currentSidebarEntry) {
-      currentSidebarTopic = topic
-      break
-    }
-  }
-
-  return currentSidebarTopic
-}
-
-function getCurrentSidebarEntry(sidebar: SidebarEntry[]): SidebarEntry | undefined {
-  return sidebar.find((entry) => {
-    if (entry.type === "link") {
-      return entry.isCurrent
-    }
-
-    return getCurrentSidebarEntry(entry.entries)
-  })
-}
-
-function getTopicIdFromEntry(entry: StarlightEntry): string | undefined {
-  if (isStarlightEntryWithTopic(entry)) {
-    return entry.data.topic
-  }
-  return undefined
-}
-
-type SidebarEntry = StarlightRouteData["sidebar"][number]
-
-interface SidebarTopic {
-  label: string
-  entries: SidebarEntry[]
-}
-
-export interface Topic {
-  config: StarlightSidebarTopicsSharedConfig[number]
-  sidebar: SidebarEntry[]
-}

package/src/plugins/starlightAddons/libs/vite.ts

@@ -1,46 +0,0 @@
-import type { ViteUserConfig } from "astro"
-
-import type {
-  StarlightSidebarTopicsConfig,
-  StarlightSidebarTopicsOptions,
-  StarlightSidebarTopicsSharedConfig
-} from "./config"
-
-export function vitePluginStarlightSidebarTopics(
-  config: StarlightSidebarTopicsConfig,
-  options: StarlightSidebarTopicsOptions
-): VitePlugin {
-  const sharedConfig: StarlightSidebarTopicsSharedConfig = config.map((topic) => {
-    if (!("items" in topic)) return { ...topic, type: "link" }
-    // Remove the items property without creating an unused binding
-    const topicWithoutItems: any = { ...topic }
-    delete topicWithoutItems.items
-    return { ...topicWithoutItems, type: "group" }
-  })
-
-  const modules: Record<string, string> = {
-    "virtual:starlight-sidebar-topics/config": `export default ${JSON.stringify(sharedConfig)}`,
-    "virtual:starlight-sidebar-topics/options": `export default ${JSON.stringify(options)}`
-  }
-
-  const moduleResolutionMap = Object.fromEntries(
-    Object.keys(modules).map((key) => [resolveVirtualModuleId(key), key])
-  ) as Record<string, string>
-
-  return {
-    name: "vite-plugin-starlight-sidebar-topics",
-    load(id) {
-      const moduleId = moduleResolutionMap[id]
-      return moduleId ? modules[moduleId] : undefined
-    },
-    resolveId(id) {
-      return id in modules ? resolveVirtualModuleId(id) : undefined
-    }
-  }
-}
-
-function resolveVirtualModuleId<TModuleId extends string>(id: TModuleId): `\0${TModuleId}` {
-  return `\0${id}`
-}
-
-type VitePlugin = NonNullable<ViteUserConfig["plugins"]>[number]

package/src/plugins/starlightAddons/locals.d.ts

@@ -1,14 +0,0 @@
-import type { StarlightLocals } from "@astrojs/starlight/types"
-import type { StarlightSidebarTopicsRouteData } from "./data"
-
-declare namespace App {
-  interface Locals extends StarlightLocals {
-    /**
-     * Starlight Sidebar Topics data.
-     *
-     * @see https://starlight-sidebar-topics.netlify.app/docs/guides/custom-topic-list/
-     */
-    starlightSidebarTopics: StarlightSidebarTopicsRouteData
-    starlightRoute: any
-  }
-}