vitepress-openapi 0.1.17 → 0.1.19

package/src/composables/usePlayground.ts

@@ -197,6 +197,19 @@ export function usePlayground() {
     operationData.playground.parameterValues.value[parameterName] = parsedValue
   }
 
+  function setSecurityValue(schemeId: string, value: any) {
+    if (!operationData || !schemeId) {
+      return
+    }
+
+    // Replace the object reference so the watcher always fires,
+    // even when the value for this key hasn't changed.
+    operationData.security.securityValues.value = {
+      ...operationData.security.securityValues.value,
+      [schemeId]: value,
+    }
+  }
+
   return {
     loading,
     response,
@@ -206,6 +219,7 @@ export function usePlayground() {
     submitRequest,
     cleanupImageUrls,
     setParameterValue,
+    setSecurityValue,
     hasOperationData: !!operationData,
   }
 }

package/src/composables/useSidebar.ts

@@ -6,6 +6,7 @@ import { parseOpenapi } from '../lib/parser/parseOpenapi'
 import { cleanSidebarItems } from '../lib/sidebar/cleanSidebarItems'
 import { generateSidebarItemsByPaths } from '../lib/sidebar/generateSidebarItemsByPaths'
 import { createOpenApiSpec } from '../lib/spec/createOpenApiSpec'
+import { minifyHtml } from '../lib/utils/minifyHtml'
 
 type MethodAliases = Record<string, string>
 
@@ -111,10 +112,12 @@ export function useSidebar({
   const _globalItemTemplate: SidebarItemTemplateFn = sidebarItemTemplate || (({ method, path, title }) => {
     const resolvedMethod = methodAliases[method] || method.toUpperCase()
     const displayText = title || path
-    return `<span class="OASidebarItem group/oaOperationLink">
+    return minifyHtml(`
+      <span class="OASidebarItem group/oaOperationLink">
         <span class="OASidebarItem-badge OAMethodBadge--${method.toLowerCase()}">${resolvedMethod}</span>
         <span class="OASidebarItem-text text">${displayText}</span>
-      </span>`
+      </span>
+    `)
   })
 
   const _globalGroupTemplate: SidebarGroupTemplateFn = sidebarGroupTemplate || defaultGroupTemplate

package/src/composables/useTheme.ts

@@ -153,6 +153,7 @@ export interface ServerConfig {
 
 export interface StorageConfig {
   prefix?: string
+  persistAuth?: boolean
 }
 
 export interface OperationLinkConfig {
@@ -235,6 +236,7 @@ export const DEFAULT_OPERATION_SLOTS: OperationSlot[] = [
 
 export const DEFAULT_BASE_URL = 'http://localhost'
 export const DEFAULT_STORAGE_PREFIX = '--oa'
+export const DEFAULT_STORAGE_PERSIST_AUTH = true
 
 export const availableLanguages: LanguageConfig[] = [
   {
@@ -385,6 +387,7 @@ const defaultValues = {
   },
   storage: {
     prefix: DEFAULT_STORAGE_PREFIX,
+    persistAuth: DEFAULT_STORAGE_PERSIST_AUTH,
   },
   markdown: {
     operationLink: {
@@ -481,6 +484,7 @@ const themeConfig: UseThemeConfig = {
   },
   storage: {
     prefix: defaultValues.storage.prefix,
+    persistAuth: defaultValues.storage.persistAuth,
   },
   markdown: {
     operationLink: {
@@ -1099,6 +1103,13 @@ export function useTheme(initialConfig: PartialUseThemeConfig = {}) {
     if (config.prefix !== undefined) {
       storage.prefix = config.prefix
     }
+    if (config.persistAuth !== undefined) {
+      storage.persistAuth = config.persistAuth
+    }
+  }
+
+  function getStoragePersistAuth(): boolean {
+    return themeConfig?.storage?.persistAuth ?? DEFAULT_STORAGE_PERSIST_AUTH
   }
 
   return {
@@ -1179,6 +1190,7 @@ export function useTheme(initialConfig: PartialUseThemeConfig = {}) {
     setMarkdownConfig,
     getOperationLinkConfig,
     getStoragePrefix,
+    getStoragePersistAuth,
     setStorageConfig,
   }
 }

package/src/index.ts

@@ -9,6 +9,7 @@ export {
 export { usePaths } from './composables/usePaths'
 export { useSidebar } from './composables/useSidebar'
 export { createOpenApiSpec, type OpenApiSpecInstance } from './lib/spec/createOpenApiSpec'
+export { minifyHtml } from './lib/utils/minifyHtml'
 export { parseSpec } from './lib/utils/parseSpec'
 
 export const httpVerbs: readonly OpenAPIV3.HttpMethods[] = ['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'] as const

package/src/lib/operation/operationData.ts

@@ -10,6 +10,7 @@ export interface OperationData {
   operationId: string
   security: {
     selectedSchemeId: Ref<string>
+    securityValues: Ref<Record<string, any>>
   }
   playground: {
     request: Ref<OARequest>
@@ -44,6 +45,7 @@ export function initOperationData({
     operationId: operation.operationId,
     security: {
       selectedSchemeId: ref(operation.securityUi?.some(s => s.id === defaultSecurityScheme) ? defaultSecurityScheme : firstSecurityScheme),
+      securityValues: ref({}),
     },
     playground: {
       request: ref(request || {} as OARequest),

package/src/lib/sidebar/ensureGroupTextSlashPrefix.ts

@@ -9,7 +9,7 @@ export function ensureGroupTextSlashPrefix(items: OASidebarItem[]): OASidebarIte
       item.items = ensureGroupTextSlashPrefix(item.items)
 
       item.text = item.text?.startsWith('/') ? item.text : `/${item.text}`
-    } else if (item.text && !item.isOperation && !item.text.startsWith('/') && !item.text.includes('<span')) {
+    } else if (item.text && !item.isOperation && !item.text.startsWith('/') && !item.text.includes('<')) {
       item.text = `/${item.text}`
     }
 

package/src/lib/utils/minifyHtml.ts

@@ -0,0 +1,9 @@
+const WHITESPACE_REGEX = /\s+/g
+
+/**
+ * Minifies a string of HTML by replacing multiple whitespace characters with a single space
+ * and trimming the result. This helps prevent hydration mismatches in VitePress.
+ */
+export function minifyHtml(html: string): string {
+  return html.replace(WHITESPACE_REGEX, ' ').trim()
+}