@poveste/shared 0.6.1 → 0.8.0

package/src/types/config.ts

@@ -1,288 +0,0 @@
-import type MarkdownIt from 'markdown-it'
-import type { UseHeadInput } from 'unhead/types'
-import type {
-  UserConfig as ViteConfig,
-  ConfigEnv as ViteConfigEnv,
-} from 'vite'
-import type { Plugin } from './plugin.js'
-import type { ServerTreeFile, StoryProps } from './story.js'
-
-export interface SupportMatchPattern {
-  id: string
-  patterns: string[]
-  pluginIds: string[]
-}
-
-export type CustomizableColors = 'primary' | 'gray'
-export type ColorKeys = '50' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900'
-export type GrayColorKeys = ColorKeys | '750' | '850' | '950'
-
-export interface ResponsivePreset {
-  label: string
-  width: number
-  height?: number
-}
-
-export interface BackgroundPreset {
-  label: string
-  color: string
-  contrastColor?: string
-}
-
-export interface TreeGroupConfig {
-  title: string
-  id?: string
-  include?: (file: ServerTreeFile) => boolean
-}
-
-/**
- * @deprecated Use `PovesteConfig` instead. Kept for drop-in compat with histoire.
- */
-export type HistoireConfig = PovesteConfig
-
-export interface PovesteConfig {
-  plugins: Plugin[]
-  /**
-   * Output directory.
-   */
-  outDir: string
-  /**
-   * Glob patterns for story files to include.
-   */
-  storyMatch: string[]
-  /**
-   * Glob patterns to ignore files while searching for story files.
-   * Added to the defaults (`node_modules`, `dist`), not a replacement for them.
-   */
-  storyIgnored: string[]
-  /**
-   * Patterns to match stories to support plugins automatically.
-   */
-  supportMatch: SupportMatchPattern[]
-  /**
-   * Master switch for CSS isolation between Poveste chrome and user stories.
-   * When true (default), user CSS imported via poveste.setup is scoped to story
-   * containers, chrome CSS is scoped away from them, and grid items render
-   * in iframes. Set to false to restore pre-1.0 behavior. See guide/css.md.
-   */
-  isolateStyles?: boolean
-  /**
-   * CSS files loaded into the main app (not into stories). Wrapped in
-   * @layer poveste-user-globals — lower priority than chrome.
-   * Use for design tokens or anything intentionally global.
-   */
-  globalStyles?: string[]
-  /**
-   * How to generate the story tree.
-   */
-  tree: {
-    /**
-     * Use `'title'` to create the path from the title of the story, using `/` as the separator.
-     *
-     * Use `'path'` use the real folder structure on your computer.
-     */
-    file?: 'title' | 'path' | ((file: ServerTreeFile) => string[])
-    order?: 'asc' | ((a: string, b: string) => number)
-    groups?: TreeGroupConfig[]
-  }
-  /**
-   * Customize the look of the histoire book.
-   */
-  theme: {
-    /**
-     * Main page title. For example: 'Acme Inc.'
-     */
-    title?: string
-    /**
-     * Custom logo files. Should be import paths (processed by Vite).
-     *
-     * Example: `'/src/assets/my-logo.svg'`
-     */
-    logo?: {
-      /**
-       * Square logo without text.
-       */
-      square?: string
-      /**
-       * Full logo for light theme.
-       */
-      light?: string
-      /**
-       * Full logo for dark theme.
-       */
-      dark?: string
-    }
-    /**
-     * Href to the favicon file (**not** processed by Vite). Put the file in the `public` directory.
-     *
-     * Example: `'/favicon.ico'`
-     */
-    favicon?: string
-    /**
-     * Customize the colors. Each color should be an object with shades as keys.
-     *
-     * Example: ```{ primary: { 50: '#eef2ff', 100: '#e0e7ff', ..., 900: '#312e81' } }```
-     *
-     * You can import `defaultColors` from `'poveste'` to use predefined colors or you can create your own colors from scratch.
-     */
-    colors?: {
-      [key in CustomizableColors]?: key extends 'gray' ? {
-        [key in GrayColorKeys]?: string
-      } : {
-        [key in ColorKeys]?: string
-      }
-    }
-    /**
-     * Add a link to the main logo
-     */
-    logoHref?: string
-    /**
-     * Default color scheme for the app.
-     */
-    defaultColorScheme?: 'light' | 'dark' | 'auto'
-    /**
-     * Hides the dark mode button in the toolbar.
-     */
-    hideColorSchemeSwitch?: boolean
-    /**
-     * Enable persistence of the color scheme in the browser.
-     */
-    storeColorScheme?: boolean
-    /**
-     * Class added to the story preview when dark mode is enabled.
-     */
-    darkClass?: string
-  }
-  /**
-   * Setup file exporting a default function executed when setting up each story preview.
-   *
-   * Import custom CSS files from this file.
-   *
-   * Example: `'/src/poveste-setup.ts'`
-   */
-  setupFile?: string | {
-    /**
-     * Only loaded in the browser client.
-     */
-    browser: string
-  } | {
-    /**
-     * Only loaded while collecting stories in the node server.
-     */
-    server: string
-  } | {
-    /**
-     * Only loaded in the browser client.
-     */
-    browser: string
-    /**
-     * Only loaded while collecting stories in the node server.
-     */
-    server: string
-  }
-  /**
-   * Setup code created by plugins
-   */
-  setupCode?: string[]
-  /**
-   * Predefined responsive sizes for story playgrounds.
-   */
-  responsivePresets?: ResponsivePreset[]
-  /**
-   * Background color of the story preview.
-   */
-  backgroundPresets?: BackgroundPreset[]
-  /**
-   * Initial background color used for story previews before the user picks one.
-   *
-   * Should match a `color` from `backgroundPresets` to also highlight the corresponding
-   * entry in the dropdown; any other value is still applied as a CSS color.
-   *
-   * @default 'transparent'
-   */
-  defaultBackgroundColor?: string
-  /**
-   * Automatically apply the current background preset's contrast color to the story preview text.
-   */
-  autoApplyContrastColor?: boolean
-  /**
-   * Extra `<head>` tags injected into the Poveste app and the story sandbox.
-   * Same input shape as Nuxt's `useHead`. Use for global stylesheets, web fonts,
-   * analytics snippets, or any meta tag that needs to apply in both contexts.
-   *
-   * Example: `head: { link: [{ rel: 'stylesheet', href: '...' }] }`
-   */
-  head?: UseHeadInput
-  /**
-   * Class added to the html root of the story preview when dark mode is enabled.
-   *
-   * Applied only when you set it. It has no default, so a book that configures
-   * `theme.darkClass` alone gets that one class on every render path rather
-   * than a second, different one (#126).
-   * @deprecated use `theme.darkClass` instead
-   */
-  sandboxDarkClass?: string
-  /**
-   * Default props for stories.
-   */
-  defaultStoryProps?: Omit<StoryProps, 'id' | 'setupApp' | 'title' | 'source'>
-  /**
-   * Customize the markdown-it renderer
-   */
-  markdown?: (md: MarkdownIt) => MarkdownIt | Promise<MarkdownIt>
-  /**
-   * Change the router mode.
-   * - history: use HTML history with cleaner URLs
-   * - hash: use hashtag hack in the URL to support more hosting services
-   */
-  routerMode?: 'history' | 'hash'
-  /**
-   * Vite config override
-   */
-  vite?: ViteConfig | ((config: ViteConfig, env: ViteConfigEnv) => void | ViteConfig | Promise<void | ViteConfig>)
-  /**
-   * Remove those plugins from the Vite configuration
-   */
-  viteIgnorePlugins?: string[]
-  /**
-   * Transpile dependencies when collecting stories on Node.js
-   */
-  viteNodeInlineDeps?: (string | RegExp)[]
-  /**
-   * Determine the transform method of modules
-   */
-  viteNodeTransformMode?: {
-    /**
-     * Use SSR transform pipeline for the specified files.
-     * Vite plugins will receive `ssr: true` flag when processing those files.
-     *
-     * @default [/\.([cm]?[jt]sx?|json)$/]
-     */
-    ssr?: RegExp[]
-    /**
-     * First do a normal transform pipeline (targeting browser),
-     * then then do a SSR rewrite to run the code in Node.
-     * Vite plugins will receive `ssr: false` flag when processing those files.
-     *
-     * @default other than `ssr`
-     */
-    web?: RegExp[]
-  }
-  /**
-   * Maximum number of threads used to collect stories.
-   * By default based on available number of cores.
-   */
-  collectMaxThreads?: number
-  /**
-   * Build options
-   */
-  build?: {
-    /**
-     * By default all dependencies in `node_modules` are bundled into a single 'vendors' file.
-     * You can use this option to exclude some dependencies from this file.
-     */
-    excludeFromVendorsChunk?: (string | RegExp)[]
-  }
-}
-
-export type ConfigMode = 'build' | 'dev'

package/src/types/index.ts

@@ -1,5 +0,0 @@
-export * from './command.js'
-export * from './config.js'
-export * from './plugin.js'
-export * from './prompt.js'
-export * from './story.js'

package/src/types/plugin.ts

@@ -1,135 +0,0 @@
-import type chokidar from 'chokidar'
-import type fs from 'fs-extra'
-import type path from 'pathe'
-import type pc from 'picocolors'
-import type { InlineConfig as ViteInlineConfig, Plugin as VitePlugin } from 'vite'
-import type { Awaitable } from '../type-utils.js'
-import type {
-  PluginCommand,
-} from './command.js'
-import type {
-  ConfigMode,
-  PovesteConfig,
-} from './config.js'
-import type {
-  ServerStory,
-  ServerStoryFile,
-  ServerVariant,
-} from './story.js'
-
-export interface SupportPlugin {
-  id: string
-  moduleName: string
-  setupFn: string | string[]
-  importStoriesPrepend?: string
-  importStoryComponent: (file: ServerStoryFile, index: number) => string
-}
-
-export interface FinalSupportPlugin extends SupportPlugin {
-  // For now, no additional properties
-}
-
-export interface ModuleLoader {
-  clearCache: () => void
-  loadModule: (file: string) => Promise<any>
-  destroy: () => void
-}
-
-export interface PluginApiBase {
-  colors: typeof pc
-  path: typeof path
-  fs: typeof fs
-  moduleLoader: ModuleLoader
-
-  readonly pluginTempDir: string
-
-  log: (...msg) => void
-  warn: (...msg) => void
-  error: (...msg) => void
-
-  getStories: () => ServerStory[]
-  addStoryFile: (file: string) => void
-
-  getConfig: () => PovesteConfig
-}
-
-export interface PluginApiDev extends PluginApiBase {
-  watcher: typeof chokidar
-}
-
-export type ChangeViteConfigCallback = (config: ViteInlineConfig) => Awaitable<void>
-export type BuildEndCallback = () => Awaitable<void>
-export type PreviewStoryCallback = (payload: { file: string, story: ServerStory, variant: ServerVariant, url: string }) => Awaitable<void>
-
-export interface PluginApiBuild extends PluginApiBase {
-  changeViteConfigCallbacks: ChangeViteConfigCallback[]
-  buildEndCallbacks: BuildEndCallback[]
-  previewStoryCallbacks: PreviewStoryCallback[]
-
-  changeViteConfig: (cb: ChangeViteConfigCallback) => void
-  onBuildEnd: (cb: BuildEndCallback) => void
-  onPreviewStory: (cb: PreviewStoryCallback) => void
-}
-
-export interface PluginApiDevEvent extends PluginApiBase {
-  event: string
-  payload: any
-}
-
-export interface Plugin {
-  /**
-   * Name of the plugin
-   */
-  name: string
-  /**
-   * Modify histoire default config. The hook can either mutate the passed config or
-   * return a partial config object that will be deeply merged into the existing
-   * config. User config will have higher priority than default config.
-   *
-   * Note: User plugins are resolved before running this hook so injecting other
-   * plugins inside  the `config` hook will have no effect.
-   */
-  defaultConfig?: (defaultConfig: PovesteConfig, mode: ConfigMode) => Partial<PovesteConfig> | null | void | Promise<Partial<PovesteConfig> | null | void>
-  /**
-   * Modify histoire config. The hook can either mutate the passed config or
-   * return a partial config object that will be deeply merged into the existing
-   * config.
-   *
-   * Note: User plugins are resolved before running this hook so injecting other
-   * plugins inside  the `config` hook will have no effect.
-   */
-  config?: (config: PovesteConfig, mode: ConfigMode) => Partial<PovesteConfig> | null | void | Promise<Partial<PovesteConfig> | null | void>
-  /**
-   * Use this hook to read and store the final resolved histoire config.
-   */
-  configResolved?: (config: PovesteConfig) => Awaitable<void>
-  /**
-   * Use this hook to do processing during development. The `onCleanup` hook
-   * should handle cleanup tasks when development server is closed.
-   */
-  onDev?: (api: PluginApiDev, onCleanup: (cb: () => Awaitable<void>) => void) => Awaitable<void>
-  /**
-   * Use this hook to do processing during production build.
-   */
-  onBuild?: (api: PluginApiBuild) => Awaitable<void>
-  /**
-   * Use this hook to do processing when preview is started.
-   */
-  onPreview?: () => Awaitable<void>
-  /**
-   * This plugin exposes a support plugin (example: Vue, Svelte, etc.)
-   */
-  supportPlugin?: SupportPlugin
-  /**
-   * This plugin exposes commands that can be executed from the search bar in development mode.
-   */
-  commands?: PluginCommand[]
-  /**
-   * Handle a custom event from the client in development mode.
-   */
-  onDevEvent?: (api: PluginApiDevEvent) => Awaitable<any>
-  /**
-   * Use this hook to manipulate Vite plugins before they are passed to Vite.
-   */
-  vitePlugins?: (plugins: VitePlugin[]) => Awaitable<void>
-}

package/src/types/prompt.ts

@@ -1,25 +0,0 @@
-import type { Awaitable } from '../type-utils.js'
-
-export interface PromptBase<TValue> {
-  field: string
-  label: string
-  required?: boolean
-  defaultValue?: TValue | ((answers: Record<string, any>) => TValue)
-}
-
-export interface TextPrompt extends PromptBase<string> {
-  type: 'text'
-}
-
-export type SelectPromptOption = string | { value: string, label: string }
-
-export interface SelectPrompt extends PromptBase<string> {
-  type: 'select'
-  options: SelectPromptOption[] | ((search: string, answers: Record<string, any>) => Awaitable<SelectPromptOption[]>)
-}
-
-// No type parameter: both members fix their value type to `string` via
-// `PromptBase<string>`, so the `<TValue = any>` this used to carry never
-// reached anything and no caller ever passed one.
-export type Prompt = TextPrompt
-  | SelectPrompt

package/src/types/story.ts

@@ -1,221 +0,0 @@
-export interface StoryFile {
-  id: string
-  supportPluginId: string
-  component: any
-  story: Story
-  path: string[]
-  filePath: string
-  docsFilePath?: string
-  source: () => Promise<{ default: string }>
-}
-
-export type StoryLayout = {
-  type: 'single'
-  iframe?: boolean
-  /**
-   * Give every render of this story a fresh sandbox document instead of
-   * reusing a warm one. Style isolation is the same either way; this is for
-   * stories that leave JS state behind — patched globals, leaked timers —
-   * that the next occupant of the realm must not see.
-   */
-  isolate?: boolean
-} | {
-  type: 'grid'
-  width?: number | string
-  iframeGrid?: boolean
-  /** See the single layout's `isolate`. */
-  isolate?: boolean
-}
-
-export interface CommonProps {
-  id?: string
-  title?: string
-  icon?: string
-  iconColor?: string
-}
-
-export interface InheritedProps {
-  setupApp?: (payload: any) => unknown
-  source?: string
-  responsiveDisabled?: boolean
-  autoPropsDisabled?: boolean
-}
-
-export interface VariantProps extends CommonProps, InheritedProps {
-  // No additional properties
-}
-
-export interface StoryProps extends CommonProps, InheritedProps {
-  group?: string
-  layout?: StoryLayout
-  docsOnly?: boolean
-}
-
-export interface CommonMeta {}
-
-export interface StoryMeta extends CommonMeta {
-  /**
-   * When set, overrides the global Story Options visibility for this story.
-   * `true` forces the right pane visible; `false` forces it hidden.
-   * `undefined` (default) defers to the global layout setting.
-   */
-  storyOptions?: boolean
-}
-
-export interface Story {
-  id: string
-  title: string
-  group?: string
-  variants: Variant[]
-  layout?: StoryLayout
-  icon?: string
-  iconColor?: string
-  docsOnly?: boolean
-  file?: StoryFile
-  lastSelectedVariant?: Variant
-  slots?: () => any
-  meta?: StoryMeta
-}
-
-export interface VariantMeta extends CommonMeta {}
-
-export interface Variant {
-  id: string
-  title: string
-  icon?: string
-  iconColor?: string
-  setupApp?: (payload: any) => unknown
-  slots?: () => { default: any, controls: any, source: any }
-  state: any
-  source?: string
-  responsiveDisabled?: boolean
-  autoPropsDisabled?: boolean
-  configReady?: boolean
-  previewReady?: boolean
-  meta?: VariantMeta
-}
-
-export interface PropDefinition {
-  name: string
-  types?: string[]
-  required?: boolean
-  default?: any
-}
-
-export interface AutoPropComponentDefinition {
-  name: string
-  index: number
-  props: PropDefinition[]
-}
-
-/* SERVER */
-
-export interface ServerStoryFile {
-  id: string
-  /**
-   * Absolute path
-   */
-  path: string
-  /**
-   * Relative path
-   */
-  relativePath: string
-  /**
-   * File name without extension
-   */
-  fileName: string
-  /**
-   * Support plugin (Vue, Svelte, etc.)
-   */
-  supportPluginId: string
-  /**
-   * Generated path for tree UI
-   */
-  treePath?: string[]
-  /**
-   * Use the module id in imports to allow HMR
-   */
-  moduleId: string
-  /**
-   * Resolved story data from story file execution
-   */
-  story?: ServerStory
-  /**
-   * Data sent to user tree config functions
-   */
-  treeFile?: ServerTreeFile
-  /**
-   * Is virtual module
-   */
-  virtual?: boolean
-  /**
-   * Virtual module code
-   */
-  moduleCode?: string
-  /**
-   * Related markdown docs
-   */
-  markdownFile?: ServerMarkdownFile
-}
-
-export interface ServerMarkdownFile {
-  id: string
-  relativePath: string
-  absolutePath: string
-  isRelatedToStory: boolean
-  frontmatter?: any
-  html?: string
-  content?: string
-  storyFile?: ServerStoryFile
-}
-
-export interface ServerStory {
-  id: string
-  title: string
-  group?: string
-  variants: ServerVariant[]
-  layout?: StoryLayout
-  icon?: string
-  iconColor?: string
-  docsOnly?: boolean
-  docsText?: string
-  meta?: StoryMeta
-}
-
-export interface ServerVariant {
-  id: string
-  title: string
-  icon?: string
-  iconColor?: string
-  meta?: VariantMeta
-}
-
-export interface ServerTreeFile {
-  title: string
-  path: string
-}
-
-export interface ServerTreeLeaf {
-  title: string
-  index: number
-}
-
-export interface ServerTreeFolder {
-  title: string
-  children: (ServerTreeFolder | ServerTreeLeaf)[]
-}
-
-export interface ServerTreeGroup {
-  group: true
-  id: string
-  title: string
-  children: (ServerTreeFolder | ServerTreeLeaf)[]
-}
-
-export type ServerTree = (ServerTreeGroup | ServerTreeFolder | ServerTreeLeaf)[]
-
-export interface ServerRunPayload {
-  file: ServerStoryFile
-  storyData: ServerStory[]
-  el: HTMLElement
-}