@poveste/shared 0.18.3 → 0.19.0

package/dist/types/command.d.ts

@@ -1,4 +1,3 @@
-import type { RouteLocationNormalizedLoaded } from 'vue-router';
 import type { Prompt } from './prompt.js';
 import type { Story, Variant } from './story.js';
 export interface CommonCommandOptions {
@@ -21,8 +20,24 @@ export interface ClientCommandOptions extends CommonCommandOptions {
  * A command that can be executed from the search bar.
  */
 export type ClientCommand = Command & ClientCommandOptions;
+/**
+ * The route the book is on, as a command sees it. The app passes its
+ * `vue-router` route, and this names the fields a command reads rather than
+ * importing the router's type: this package depends on no router, so that import
+ * failed a consumer's type check under `skipLibCheck: false`, in a Solid or
+ * Svelte project most of all (#1199).
+ */
+export interface ClientCommandRoute {
+    path: string;
+    fullPath: string;
+    hash: string;
+    name: string | symbol | null | undefined;
+    params: Record<string, string | string[]>;
+    query: Record<string, string | null | (string | null)[]>;
+    meta: Record<PropertyKey, unknown>;
+}
 export interface ClientCommandContext {
-    route: RouteLocationNormalizedLoaded;
+    route: ClientCommandRoute;
     /**
      * The story the route names, or undefined on any route that names none — the
      * home page, or a story id that is not loaded. Declared non-optional here

package/dist/types/config.d.ts

@@ -16,6 +16,39 @@ export interface ResponsivePreset {
     width: number;
     height?: number | null;
 }
+/**
+ * What the story preview opens at. Each value is applied on every load, for a
+ * reader with stored settings too, until that reader changes the setting in the
+ * toolbar; from then on theirs wins.
+ */
+export interface PreviewConfig {
+    /**
+     * A CSS color. Match a `color` from `backgroundPresets` to also highlight that
+     * entry in the dropdown.
+     *
+     * @default 'transparent'
+     */
+    backgroundColor?: string;
+    /**
+     * In pixels. `null` sizes the preview to the available space. Set it with
+     * `responsiveHeight` to open at one of `responsivePresets`.
+     *
+     * @default 720
+     */
+    responsiveWidth?: number | null;
+    /**
+     * In pixels. `null` sizes the preview to the available space.
+     *
+     * @default null
+     */
+    responsiveHeight?: number | null;
+    /** Swap the width and height. @default false */
+    rotate?: boolean;
+    /** Show a checkerboard behind the story. @default false */
+    checkerboard?: boolean;
+    /** @default 'ltr' */
+    textDirection?: 'ltr' | 'rtl';
+}
 export interface BackgroundPreset {
     label: string;
     color: string;
@@ -156,11 +189,11 @@ export interface PovesteConfig {
         lang?: string;
     };
     /**
-     * Setup file exporting a default function executed when setting up each story preview.
+     * Setup file loaded with every story. Import custom CSS files from it, and export
+     * the setup function your framework's plugin reads, such as `setupVue`. A default
+     * export is not called.
      *
-     * Import custom CSS files from this file.
-     *
-     * Example: `'/src/poveste-setup.ts'`
+     * Example: `'/src/poveste.setup.ts'`
      */
     setupFile?: string | {
         /**
@@ -194,13 +227,18 @@ export interface PovesteConfig {
      * Background color of the story preview.
      */
     backgroundPresets?: BackgroundPreset[];
+    /**
+     * What the story preview opens at, before the reader changes it in the toolbar.
+     * Each field mirrors the toolbar setting of the same name.
+     */
+    preview?: PreviewConfig;
     /**
      * 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.
+     * Still honoured where it is set. When `preview.backgroundColor` is set too,
+     * that one wins.
      *
-     * @default 'transparent'
+     * @deprecated use `preview.backgroundColor` instead
      */
     defaultBackgroundColor?: string;
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@poveste/shared",
   "type": "module",
-  "version": "0.18.3",
+  "version": "0.19.0",
   "description": "Shared utilities for Poveste",
   "author": {
     "name": "Sorin Gitlan",
@@ -39,7 +39,7 @@
     "vite": "^8.0.0"
   },
   "dependencies": {
-    "@poveste/vendors": "^0.18.3",
+    "@poveste/vendors": "^0.19.0",
     "@types/fs-extra": "^11.0.4",
     "chokidar": "^5.0.0",
     "markdown-it": "^15.0.2",