@poveste/plugin-svelte 0.18.3 → 0.19.0

package/dist/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,3 @@
+# Third-party notices
+
+@poveste/plugin-svelte bundles no third-party code into its `dist`.

package/dist/collect/Story.js

@@ -1 +1 @@
-import{addStoryContext as e,addVariantContext as t,collectStoryContext as n,storyFileContext as r}from"../contexts.js";import"svelte/internal/disclose-version";import"svelte/internal/flags/legacy";import*as i from"svelte/internal/client";function a(a,o){i.push(o,!1);let s=i.prop(o,`title`,8,null),c=i.prop(o,`id`,8,null),l=i.prop(o,`group`,8,null),u=i.prop(o,`layout`,8,null),d=i.prop(o,`icon`,8,null),f=i.prop(o,`iconColor`,8,null),p=i.prop(o,`docsOnly`,8,!1),m=i.prop(o,`autoPropsDisabled`,8,null),h=i.prop(o,`initState`,8,null),g=e.getOptional(),_=r.getOptional(),v=c()??_?.id,y=s()??_?.fileName;if(!v||y===void 0)throw Error("[poveste] a <Story> collected outside a story file needs an `id` and a `title`");let b={id:v,title:y,group:l(),layout:u(),icon:d(),iconColor:f(),docsOnly:p(),autoPropsDisabled:m(),variants:[]};g?.(b);let x=h()?h()():{};n.set(b),t.set(e=>{b.variants.push(e)}),i.init();var S=i.comment(),C=i.first_child(S);i.slot(C,o,`default`,{get state(){return x}},null),i.append(a,S),i.pop()}export{a as default};
+import{addStoryContext as e,addVariantContext as t,collectStoryContext as n,storyFileContext as r}from"../contexts.js";import"svelte/internal/disclose-version";import"svelte/internal/flags/legacy";import*as i from"svelte/internal/client";function a(a,o){i.push(o,!1);let s=i.prop(o,`title`,8,null),c=i.prop(o,`id`,8,null),l=i.prop(o,`group`,8,null),u=i.prop(o,`layout`,8,null),d=i.prop(o,`icon`,8,null),f=i.prop(o,`iconColor`,8,null),p=i.prop(o,`docsOnly`,8,!1),m=i.prop(o,`autoPropsDisabled`,8,null),h=i.prop(o,`initState`,8,null),g=i.prop(o,`meta`,8,null),_=e.getOptional(),v=r.getOptional(),y=c()??v?.id,b=s()??v?.fileName;if(!y||b===void 0)throw Error("[poveste] a <Story> collected outside a story file needs an `id` and a `title`");let x={id:y,title:b,group:l(),layout:u(),icon:d(),iconColor:f(),docsOnly:p(),autoPropsDisabled:m(),...g()?{meta:g()}:{},variants:[]};_?.(x);let S=h()?h()():{};n.set(x),t.set(e=>{x.variants.push(e)}),i.init();var C=i.comment(),w=i.first_child(C);i.slot(w,o,`default`,{get state(){return S}},null),i.append(a,C),i.pop()}export{a as default};

package/dist/collect/Story.svelte

@@ -10,6 +10,7 @@
   export let docsOnly = false
   export let autoPropsDisabled = null
   export let initState = null
+  export let meta = null
 
   const addStory = addStoryContext.getOptional()
   const file = storyFileContext.getOptional()
@@ -36,6 +37,8 @@
     // only to an implicit variant (#466). Left undefined when unset, or the
     // collector's `??=` merge could never apply `defaultStoryProps`.
     autoPropsDisabled,
+    // Was dropped: a story's `meta.storyOptions` did nothing in a Svelte book (#1206).
+    ...meta ? { meta } : {},
     variants: [],
   }
 

package/dist/collect/Variant.js

@@ -1 +1 @@
-import{addVariantContext as e,collectStoryContext as t}from"../contexts.js";import"svelte/internal/disclose-version";import"svelte/internal/flags/legacy";import*as n from"svelte/internal/client";function r(r,i){n.push(i,!1);let a=n.prop(i,`title`,8,`untitled`),o=n.prop(i,`id`,8,null),s=n.prop(i,`icon`,8,null),c=n.prop(i,`iconColor`,8,null),l=n.prop(i,`autoPropsDisabled`,8,!1);n.prop(i,`initState`,8,null);let u=t.get(`<Variant>`);e.get(`<Variant>`)({id:o()??`${u.id}-${u.variants.length}`,title:a(),icon:s(),iconColor:c(),autoPropsDisabled:l()}),n.init(),n.pop()}export{r as default};
+import{addVariantContext as e,collectStoryContext as t}from"../contexts.js";import"svelte/internal/disclose-version";import"svelte/internal/flags/legacy";import*as n from"svelte/internal/client";function r(r,i){n.push(i,!1);let a=n.prop(i,`title`,8,`untitled`),o=n.prop(i,`id`,8,null),s=n.prop(i,`icon`,8,null),c=n.prop(i,`iconColor`,8,null),l=n.prop(i,`autoPropsDisabled`,8,!1);n.prop(i,`initState`,8,null);let u=n.prop(i,`meta`,8,null),d=t.get(`<Variant>`);e.get(`<Variant>`)({id:o()??`${d.id}-${d.variants.length}`,title:a(),icon:s(),iconColor:c(),autoPropsDisabled:l(),...u()?{meta:u()}:{}}),n.init(),n.pop()}export{r as default};

package/dist/collect/Variant.svelte

@@ -13,6 +13,7 @@
   // (the compiler's suggestion) would make passing one an error.
   // svelte-ignore export_let_unused
   export let initState = null
+  export let meta = null
 
   // Asked for before anything reads them, so a missing `<Story>` is reported
   // once and the same way whether or not the variant carries an `id`. Reading
@@ -27,6 +28,8 @@
     icon,
     iconColor,
     autoPropsDisabled,
+    // Was dropped, as a story's was (#1260).
+    ...meta ? { meta } : {},
   }
 
   addVariant(variant)

package/dist/collect/hst.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The `Hst` a story is collected with.
+ *
+ * Collection reads a story's structure, so `Story` and `Variant` are the two
+ * members that do anything. A story can still hold a builtin control in its
+ * default slot, which collection renders to find the variants: every other
+ * capitalised member is a component that renders nothing. With two members and
+ * no more, `<Hst.Select>` there was `undefined(...)`, and one story stopped the
+ * book's build (#925).
+ *
+ * Any name, not the list of controls: importing `@poveste/controls` here would
+ * load every control into the collection worker to learn their names. A name
+ * that is no control is caught where the story renders, in that story alone.
+ */
+export declare function collectHst(): Record<string, unknown>;

package/dist/collect/hst.js

@@ -0,0 +1 @@
+import e from"../client/Stub.js";import t from"./Story.svelte";import n from"./Variant.svelte";function r(){return new Proxy({Story:t,Variant:n},{get:(t,n)=>t[n]??(typeof n==`string`&&/^[A-Z]/.test(n)?e:void 0)})}export{r as collectHst};

package/dist/collect/index.js

@@ -1 +1 @@
-import{addStoryContext as e,storyFileContext as t}from"../contexts.js";import{callSetupFunctions as n,mountSvelteComponent as r}from"../util/svelte.js";import i from"./Story.svelte";import a from"./Variant.svelte";import*as o from"virtual:$poveste-generated-global-setup";import*as s from"virtual:$poveste-setup";import{tick as c}from"svelte";async function l({file:l,el:u,storyData:d}){let{default:f}=await import(/* @vite-ignore */l.moduleId),p=await r(f,{target:u,props:{Hst:{Story:i,Variant:a}},context:new Map([[e.key,e=>{d.push(e)}],[t.key,l]])},`client`),m={app:p.app,story:void 0,variant:void 0};if(await n(o,s,m),await c(),!d[0]){p.destroy();return}d[0].variants.length||d[0].variants.push({id:`_default`,title:`default`}),p.destroy()}export{l as run};
+import{addStoryContext as e,storyFileContext as t}from"../contexts.js";import{callSetupFunctions as n,mountSvelteComponent as r}from"../util/svelte.js";import{collectHst as i}from"./hst.js";import*as a from"virtual:$poveste-generated-global-setup";import*as o from"virtual:$poveste-setup";import{tick as s}from"svelte";async function c({file:c,el:l,storyData:u}){let{default:d}=await import(/* @vite-ignore */c.moduleId),f=await r(d,{target:l,props:{Hst:i()},context:new Map([[e.key,e=>{u.push(e)}],[t.key,c]])},`client`),p={app:f.app,story:void 0,variant:void 0};if(await n(a,o,p),await s(),!u[0]){f.destroy();return}u[0].variants.length||u[0].variants.push({id:`_default`,title:`default`}),f.destroy()}export{c as run};

package/dist/helpers.d.ts

@@ -1,5 +1,5 @@
 import type { HstControlOption } from '@poveste/controls';
-import type { Story, StoryProps, Variant, VariantProps } from '@poveste/shared';
+import type { Story, StoryMeta, StoryProps, Variant, VariantMeta, VariantProps } from '@poveste/shared';
 import type { Component, Snippet } from 'svelte';
 export interface SvelteStorySetupApi {
     app: any;
@@ -44,8 +44,12 @@ type WithState<P> = Omit<P, 'source'> & {
     source?: string | ((state: StoryState) => string);
 };
 export interface Hst {
-    Story: Component<WithState<WithChildren<StoryProps>>>;
-    Variant: Component<WithState<WithChildren<VariantProps>>>;
+    Story: Component<WithState<WithChildren<StoryProps>> & {
+        meta?: StoryMeta;
+    }>;
+    Variant: Component<WithState<WithChildren<VariantProps>> & {
+        meta?: VariantMeta;
+    }>;
     Button: Component<WithChildren<Record<string, any>>>;
     ButtonGroup: Component<{
         value?: string;
@@ -88,7 +92,7 @@ export interface Hst {
     }>;
     Radio: Component<{
         value?: string;
-        options: HstControlOption[];
+        options: Record<string, string> | (string | HstControlOption)[];
         title?: string;
     }>;
     Color: Component<{

package/dist/util/auto-props-vite.js

@@ -1,9 +1,7 @@
 import { readFile } from 'node:fs/promises';
 import { transformStoryAutoProps } from './auto-props.js';
 import { extractPropDefs } from './props.js';
-// Cheaper than a parse, and unlike a filename pattern it cannot go blind when a
-// project narrows `storyMatch`.
-const RENDERS_A_STORY = '<Hst.Story';
+import { isSvelteStory } from './story-source.js';
 const IMPORTS_A_COMPONENT = /from\s*['"][^'"]*\.svelte['"]/;
 /** Runs before `vite-plugin-svelte`: after it compiles there is nothing left to rewrite (#233). */
 export function svelteAutoProps() {
@@ -11,7 +9,7 @@ export function svelteAutoProps() {
         name: 'poveste:svelte-auto-props',
         enforce: 'pre',
         async transform(code, id) {
-            if (!id.replace(/\?.*$/s, '').endsWith('.svelte') || !code.includes(RENDERS_A_STORY) || !IMPORTS_A_COMPONENT.test(code)) {
+            if (!isSvelteStory(id, code) || !IMPORTS_A_COMPONENT.test(code)) {
                 return undefined;
             }
             const result = await transformStoryAutoProps(code, async (specifier) => {

package/dist/util/kit-assets.d.ts

@@ -6,6 +6,11 @@
  * `kit.files.assets`, and poveste drops that plugin through `viteIgnorePlugins`
  * — so a book served none of a Kit project's `static/`, in dev or in the build
  * (#463). This restores the one value that went with it.
+ *
+ * Kit 2 only. Kit 3 sets `publicDir` from a plugin poveste keeps, out of the
+ * `files.assets` given to `sveltekit()`. Answering `static` here as well put
+ * that in the config poveste resolves, and a `theme.favicon` in a custom assets
+ * directory was reported missing (#1212).
  */
 export declare function svelteKitAssetsDir(cwd: string): Promise<string | undefined>;
 export declare function declaresKit(cwd: string): boolean;

package/dist/util/kit-assets.js

@@ -1,4 +1,5 @@
 import { existsSync, readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
 import { pathToFileURL } from 'node:url';
 import { isAbsolute, join } from 'pathe';
 /**
@@ -9,9 +10,14 @@ import { isAbsolute, join } from 'pathe';
  * `kit.files.assets`, and poveste drops that plugin through `viteIgnorePlugins`
  * — so a book served none of a Kit project's `static/`, in dev or in the build
  * (#463). This restores the one value that went with it.
+ *
+ * Kit 2 only. Kit 3 sets `publicDir` from a plugin poveste keeps, out of the
+ * `files.assets` given to `sveltekit()`. Answering `static` here as well put
+ * that in the config poveste resolves, and a `theme.favicon` in a custom assets
+ * directory was reported missing (#1212).
  */
 export async function svelteKitAssetsDir(cwd) {
-    if (!declaresKit(cwd)) {
+    if (!declaresKit(cwd) || installedKitMajor(cwd) >= 3) {
         return undefined;
     }
     const assets = await configuredAssetsDir(cwd) ?? 'static';
@@ -31,6 +37,16 @@ export function declaresKit(cwd) {
         return false;
     }
 }
+// 0 when Kit is declared and not installed, which leaves the Kit 2 answer.
+function installedKitMajor(cwd) {
+    try {
+        const manifestPath = createRequire(join(cwd, 'package.json')).resolve('@sveltejs/kit/package.json');
+        return Number.parseInt(JSON.parse(readFileSync(manifestPath, 'utf8')).version) || 0;
+    }
+    catch {
+        return 0;
+    }
+}
 // Kit reads this from `svelte.config.js` and defaults it to `static`. Reading it
 // rather than assuming the default is what makes a project that moved its assets
 // work; a config that will not load is not this plugin's failure to report, so

package/dist/util/kit-sync.d.ts

@@ -6,5 +6,8 @@
  *
  * Returns why it could not run, for the caller to report; a failed sync is the
  * project's to fix, and the book may still start without it.
+ *
+ * Bounded, because it blocks startup: a Kit config that never settles kept
+ * `spawnSync` waiting with nothing printed, and the book never started (#1211).
  */
-export declare function syncSvelteKit(cwd: string): string | undefined;
+export declare function syncSvelteKit(cwd: string, timeoutMs?: number): string | undefined;

package/dist/util/kit-sync.js

@@ -12,8 +12,11 @@ import { declaresKit } from './kit-assets.js';
  *
  * Returns why it could not run, for the caller to report; a failed sync is the
  * project's to fix, and the book may still start without it.
+ *
+ * Bounded, because it blocks startup: a Kit config that never settles kept
+ * `spawnSync` waiting with nothing printed, and the book never started (#1211).
  */
-export function syncSvelteKit(cwd) {
+export function syncSvelteKit(cwd, timeoutMs = 60_000) {
     if (!declaresKit(cwd)) {
         return undefined;
     }
@@ -26,6 +29,9 @@ export function syncSvelteKit(cwd) {
     catch {
         return '@sveltejs/kit is declared but could not be resolved from the project';
     }
-    const result = spawnSync(process.execPath, [cli, 'sync'], { cwd, encoding: 'utf8' });
+    const result = spawnSync(process.execPath, [cli, 'sync'], { cwd, encoding: 'utf8', timeout: timeoutMs });
+    if (Reflect.get(result.error ?? {}, 'code') === 'ETIMEDOUT') {
+        return `\`svelte-kit sync\` in ${cwd} did not finish within ${timeoutMs / 1000}s and was stopped. A Kit or Vite config that never settles does this, and it would hang \`vite dev\` the same way`;
+    }
     return result.status === 0 ? undefined : (result.stderr || result.error?.message || `exited with ${result.status}`).trim();
 }

package/dist/util/story-hmr.d.ts

@@ -1,8 +1,9 @@
 export declare function disableStoryComponentHmr(): {
     name: string;
     apply: "serve";
-    handleHotUpdate({ file, server }: {
+    handleHotUpdate({ file, read, server }: {
         file: string;
+        read: () => string | Promise<string>;
         server: {
             ws: {
                 send: (payload: {
@@ -10,7 +11,7 @@ export declare function disableStoryComponentHmr(): {
                 }) => void;
             };
         };
-    }): never[] | undefined;
+    }): Promise<never[] | undefined>;
     configResolved(config: {
         readonly plugins: readonly unknown[];
     }): void;

package/dist/util/story-hmr.js

@@ -1,4 +1,4 @@
-const storyFileRE = /\.story\.svelte$/;
+import { isSvelteStory } from './story-source.js';
 export function disableStoryComponentHmr() {
     return {
         name: 'poveste:svelte-story-hmr',
@@ -6,8 +6,8 @@ export function disableStoryComponentHmr() {
         // With component HMR off, nothing in the sandbox takes the updated story module:
         // the edit was collected and never shown until a manual reload (#1178). A reload
         // shows it, as for Solid, at the cost of whatever was set in the panel.
-        handleHotUpdate({ file, server }) {
-            if (!storyFileRE.test(file)) {
+        async handleHotUpdate({ file, read, server }) {
+            if (!file.endsWith('.svelte') || !isSvelteStory(file, await read())) {
                 return undefined;
             }
             server.ws.send({ type: 'full-reload' });
@@ -25,7 +25,7 @@ export function disableStoryComponentHmr() {
                 const originalDynamicCompileOptions = options.dynamicCompileOptions;
                 options.dynamicCompileOptions = async (data) => {
                     const result = await originalDynamicCompileOptions?.(data);
-                    if (!storyFileRE.test(data.filename)) {
+                    if (!isSvelteStory(data.filename, data.code)) {
                         return result;
                     }
                     return {

package/dist/util/story-source.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Whether a module is a Svelte story, by what it renders.
+ *
+ * Not by its name: `storyMatch` is the book's to narrow or replace, so
+ * `src/stories/Button.svelte` is a story where the config says so, and a
+ * `.story.svelte` pattern here does not follow it (#472, #474). Cheaper than a
+ * parse, and one predicate for both Vite plugins that need to know.
+ */
+export declare function isSvelteStory(id: string, code: string): boolean;

package/dist/util/story-source.js

@@ -0,0 +1,12 @@
+const RENDERS_A_STORY = '<Hst.Story';
+/**
+ * Whether a module is a Svelte story, by what it renders.
+ *
+ * Not by its name: `storyMatch` is the book's to narrow or replace, so
+ * `src/stories/Button.svelte` is a story where the config says so, and a
+ * `.story.svelte` pattern here does not follow it (#472, #474). Cheaper than a
+ * parse, and one predicate for both Vite plugins that need to know.
+ */
+export function isSvelteStory(id, code) {
+    return id.replace(/\?.*$/s, '').endsWith('.svelte') && code.includes(RENDERS_A_STORY);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@poveste/plugin-svelte",
   "type": "module",
-  "version": "0.18.3",
+  "version": "0.19.0",
   "description": "Poveste plugin for Svelte 5 and SvelteKit support",
   "author": {
     "name": "Sorin Gitlan",
@@ -46,7 +46,11 @@
       "types": "./dist/client/auto-props.d.ts",
       "default": "./dist/client/auto-props.js"
     },
-    ".": "./dist/index.node.js",
+    ".": {
+      "types": "./dist/index.node.d.ts",
+      "node": "./dist/index.node.js",
+      "default": "./dist/index.js"
+    },
     "./*": "./*"
   },
   "main": "./dist/index.node.js",
@@ -65,7 +69,7 @@
   "peerDependencies": {
     "@sveltejs/kit": "^2.53.0 || ^3.0.0",
     "@sveltejs/vite-plugin-svelte": "^7.3.0",
-    "poveste": "^0.18.3",
+    "poveste": "^0.19.0",
     "svelte": "^5.46.4"
   },
   "peerDependenciesMeta": {
@@ -74,9 +78,9 @@
     }
   },
   "dependencies": {
-    "@poveste/controls": "^0.18.3",
-    "@poveste/shared": "^0.18.3",
-    "@poveste/vendors": "^0.18.3",
+    "@poveste/controls": "^0.19.0",
+    "@poveste/shared": "^0.19.0",
+    "@poveste/vendors": "^0.19.0",
     "change-case": "^5.4.4",
     "ignore": "^7.0.10",
     "launch-editor": "^2.9.1",
@@ -89,7 +93,7 @@
     "concurrently": "^10.0.5",
     "fs-extra": "^11.4.1",
     "jsdom": "^30.1.1",
-    "poveste": "0.18.3",
+    "poveste": "0.19.0",
     "svelte": "5.57.1",
     "svelte-preprocess": "^6.0.5",
     "typescript": "6.0.3",