@poveste/plugin-vue 0.3.2 → 0.4.0

package/dist/bundled/client/app/host.js

@@ -1,12 +1,13 @@
-import { provideRenderContext as e } from "./render-context.js";
-import { registerGlobalComponents as t } from "./global-components.js";
-import { RouterLinkStub as n } from "./RouterLinkStub.js";
-import { Suspense as r, createApp as i, defineComponent as a, h as o } from "vue";
-import { getSetupHook as s } from "@poveste/shared";
-import * as c from "virtual:$poveste-generated-global-setup";
-import * as l from "virtual:$poveste-setup";
+import { VUE_SETUP_HOOK_NAMES as e } from "../../setup-hooks.js";
+import { provideRenderContext as t } from "./render-context.js";
+import { registerGlobalComponents as n } from "./global-components.js";
+import { RouterLinkStub as r } from "./RouterLinkStub.js";
+import { Suspense as i, createApp as a, defineComponent as o, h as s } from "vue";
+import { getSetupHook as c } from "@poveste/shared";
+import * as l from "virtual:$poveste-generated-global-setup";
+import * as u from "virtual:$poveste-setup";
 //#region src/client/app/host.ts
-var u = a({
+var d = o({
 	name: "PreviewHostRoot",
 	props: {
 		story: {
@@ -18,59 +19,59 @@ var u = a({
 			required: !0
 		}
 	},
-	setup(t) {
-		return e(t.renderContext), () => o(t.story.file.component, { story: t.story });
+	setup(e) {
+		return t(e.renderContext), () => s(e.story.file.component, { story: e.story });
 	}
 });
-function d(e) {
-	let a = null, s = null;
+function f(e) {
+	let t = null, o = null;
 	async function c() {
 		let c = [];
-		s = document.createElement("div"), e.el.appendChild(s), a = i({
+		o = document.createElement("div"), e.el.appendChild(o), t = a({
 			name: e.name,
 			render: () => {
-				let t = o(u, {
+				let t = s(d, {
 					story: e.getStory(),
 					renderContext: e.renderContext
 				});
 				for (let n of c) {
 					let r = t;
-					t = o(n, {
+					t = s(n, {
 						story: e.getStory(),
 						variant: e.getVariant()
 					}, () => r);
 				}
-				return e.wrapInDiv && (t = o("div", t)), o(r, {}, t);
+				return e.wrapInDiv && (t = s("div", t)), s(i, {}, t);
 			}
-		}), t(a), a.component("RouterLink", n), await f({
-			app: a,
+		}), n(t), t.component("RouterLink", r), await p({
+			app: t,
 			story: e.getStory(),
 			variant: e.getVariant(),
 			addWrapper: (e) => {
 				c.unshift(e);
 			}
-		}), a.mount(s);
+		}), t.mount(o);
 	}
 	function l() {
-		a?.unmount(), a = null, s &&= (s.parentNode?.removeChild(s), null);
+		t?.unmount(), t = null, o &&= (o.parentNode?.removeChild(o), null);
 	}
-	function d() {
-		a?._instance?.proxy?.$forceUpdate();
+	function u() {
+		t?._instance?.proxy?.$forceUpdate();
 	}
 	return {
 		mount: c,
 		unmount: l,
-		forceUpdate: d
+		forceUpdate: u
 	};
 }
-async function f(e) {
-	let t = s(c, "setupVue3");
-	t && await t(e);
-	let n = s(l, "setupVue3");
-	if (n && await n(e), typeof e.variant?.setupApp == "function") {
-		let t = e.variant.setupApp;
-		await t(e);
+async function p(t) {
+	let n = c(l, e);
+	n && await n(t);
+	let r = c(u, e);
+	if (r && await r(t), typeof t.variant?.setupApp == "function") {
+		let e = t.variant.setupApp;
+		await e(t);
 	}
 }
 //#endregion
-export { d as createPreviewHost };
+export { f as createPreviewHost };

package/dist/bundled/client/server/run.js

@@ -1,43 +1,44 @@
-import e from "./Story.js";
-import t from "./Variant.js";
-import { createApp as n, h as r } from "vue";
-import { getSetupHook as i } from "@poveste/shared";
-import * as a from "virtual:$poveste-generated-global-setup";
-import * as o from "virtual:$poveste-setup";
+import { VUE_SETUP_HOOK_NAMES as e } from "../../setup-hooks.js";
+import t from "./Story.js";
+import n from "./Variant.js";
+import { createApp as r, h as i } from "vue";
+import { getSetupHook as a } from "@poveste/shared";
+import * as o from "virtual:$poveste-generated-global-setup";
+import * as s from "virtual:$poveste-setup";
 //#region src/client/server/run.ts
-async function s({ file: s, storyData: c, el: l }) {
-	let { default: u } = await import(/* @vite-ignore */
+async function c({ file: c, storyData: l, el: u }) {
+	let { default: d } = await import(/* @vite-ignore */
 		/* @vite-ignore */
-		s.moduleId
-	), d = n({
+		c.moduleId
+	), f = r({
 		provide: {
 			addStory(e) {
-				c.push(e);
+				l.push(e);
 			},
-			hstStoryFile: s
+			hstStoryFile: c
 		},
 		render() {
-			return r(u);
+			return i(d);
 		}
 	});
-	d.component("Story", e), d.component("Variant", t);
-	let f = {
-		app: d,
+	f.component("Story", t), f.component("Variant", n);
+	let p = {
+		app: f,
 		story: null,
 		variant: null,
 		addWrapper: () => {}
-	}, p = i(a, "setupVue3");
-	p && await p(f);
-	let m = i(o, "setupVue3");
-	if (m && await m(f), d.mount(l), u.doc) {
+	}, m = a(o, e);
+	m && await m(p);
+	let h = a(s, e);
+	if (h && await h(p), f.mount(u), d.doc) {
 		let e = document.createElement("div");
-		e.innerHTML = u.doc;
+		e.innerHTML = d.doc;
 		let t = e.textContent;
-		c.forEach((e) => {
+		l.forEach((e) => {
 			e.docsText = t;
 		});
 	}
-	d.unmount();
+	f.unmount();
 }
 //#endregion
-export { s as run };
+export { c as run };

package/dist/bundled/setup-hooks.js

@@ -0,0 +1,4 @@
+//#region src/setup-hooks.ts
+var e = ["setupVue3", "setupVue"];
+//#endregion
+export { e as VUE_SETUP_HOOK_NAMES };

package/dist/helpers.d.ts

@@ -7,4 +7,11 @@ export interface Vue3StorySetupApi {
     addWrapper: (wrapper: Component) => void;
 }
 export type Vue3StorySetupHandler = (api: Vue3StorySetupApi) => Promise<void> | void;
-export declare function defineSetupVue3(handler: Vue3StorySetupHandler): Vue3StorySetupHandler;
+export declare function defineSetupVue(handler: Vue3StorySetupHandler): Vue3StorySetupHandler;
+/**
+ * @deprecated Renamed to {@link defineSetupVue}, and rename the exported hook
+ * from `setupVue3` to `setupVue` at the same time. Both spellings work for the
+ * whole of 0.x; the numbered pair is a candidate for removal at 1.0, which is
+ * the only release allowed to drop them (#135).
+ */
+export declare const defineSetupVue3: typeof defineSetupVue;

package/dist/helpers.js

@@ -1,3 +1,10 @@
-export function defineSetupVue3(handler) {
+export function defineSetupVue(handler) {
     return handler;
 }
+/**
+ * @deprecated Renamed to {@link defineSetupVue}, and rename the exported hook
+ * from `setupVue3` to `setupVue` at the same time. Both spellings work for the
+ * whole of 0.x; the numbered pair is a candidate for removal at 1.0, which is
+ * the only release allowed to drop them (#135).
+ */
+export const defineSetupVue3 = defineSetupVue;

package/dist/index.node.js

@@ -1,4 +1,5 @@
 import generateStoryCommand from './commands/generate-story.server.js';
+import { VUE_SETUP_HOOK_NAMES } from './setup-hooks.js';
 import { listComponentFiles } from './util/list-components.js';
 export function HstVue() {
     return {
@@ -35,7 +36,7 @@ export function HstVue() {
         supportPlugin: {
             id: 'vue3',
             moduleName: '@poveste/plugin-vue',
-            setupFn: 'setupVue3',
+            setupFn: VUE_SETUP_HOOK_NAMES,
             importStoriesPrepend: `import { defineAsyncComponent as defineAsyncComponentVue3 } from 'vue'`,
             importStoryComponent: (file, index) => `const Comp${index} = defineAsyncComponentVue3(() => import(${JSON.stringify(file.moduleId)}))`,
         },

package/dist/setup-hooks.d.ts

@@ -0,0 +1,12 @@
+/**
+ * The names a Vue setup file may export, most established first.
+ *
+ * `setupVue3` is what users have written in `poveste.setup.ts` since histoire,
+ * so it can never be removed without a major. `setupVue` is the unnumbered name
+ * new docs use — added as an alias rather than a rename, which is the only way
+ * to introduce it without breaking every existing setup file (#135).
+ *
+ * Order is load-bearing: `getSetupHook` runs the first one present, so a file
+ * that already exports `setupVue3` behaves exactly as before.
+ */
+export declare const VUE_SETUP_HOOK_NAMES: string[];

package/dist/setup-hooks.js

@@ -0,0 +1,12 @@
+/**
+ * The names a Vue setup file may export, most established first.
+ *
+ * `setupVue3` is what users have written in `poveste.setup.ts` since histoire,
+ * so it can never be removed without a major. `setupVue` is the unnumbered name
+ * new docs use — added as an alias rather than a rename, which is the only way
+ * to introduce it without breaking every existing setup file (#135).
+ *
+ * Order is load-bearing: `getSetupHook` runs the first one present, so a file
+ * that already exports `setupVue3` behaves exactly as before.
+ */
+export const VUE_SETUP_HOOK_NAMES = ['setupVue3', 'setupVue'];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@poveste/plugin-vue",
   "type": "module",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "Poveste plugin for Vue.js support",
   "author": {
     "name": "Sorin Gitlan"
@@ -44,16 +44,16 @@
   "types": "dist/index.node.d.ts",
   "peerDependencies": {
     "vue": "^3.5.26",
-    "poveste": "^0.3.2"
+    "poveste": "^0.4.0"
   },
   "dependencies": {
     "change-case": "^5.4.4",
     "globby": "^14.0.2",
     "launch-editor": "^2.9.1",
     "pathe": "^1.1.2",
-    "@poveste/shared": "^0.3.2",
-    "@poveste/vendors": "^0.3.2",
-    "@poveste/controls": "^0.3.2"
+    "@poveste/controls": "^0.4.0",
+    "@poveste/vendors": "^0.4.0",
+    "@poveste/shared": "^0.4.0"
   },
   "devDependencies": {
     "@types/node": "^22.10.1",
@@ -62,7 +62,7 @@
     "vite": "^8.2.0",
     "vitest": "^4.1.10",
     "vue": "^3.5.26",
-    "poveste": "0.3.2"
+    "poveste": "0.4.0"
   },
   "scripts": {
     "build": "rimraf dist && vite build && tsc -d -P tsconfig.build.json && pnpm run build:types",

package/src/client/app/host.ts

@@ -13,6 +13,7 @@ import {
   h,
   Suspense,
 } from 'vue'
+import { VUE_SETUP_HOOK_NAMES } from '../../setup-hooks.js'
 import { registerGlobalComponents } from './global-components.js'
 import { provideRenderContext } from './render-context.js'
 import { RouterLinkStub } from './RouterLinkStub'
@@ -124,12 +125,12 @@ export function createPreviewHost(options: PreviewHostOptions) {
 }
 
 async function runSetupHooks(setupApi: Vue3StorySetupApi) {
-  const generatedSetupFn = getSetupHook<Vue3StorySetupHandler>(generatedSetup, 'setupVue3')
+  const generatedSetupFn = getSetupHook<Vue3StorySetupHandler>(generatedSetup, VUE_SETUP_HOOK_NAMES)
   if (generatedSetupFn) {
     await generatedSetupFn(setupApi)
   }
 
-  const setupFn = getSetupHook<Vue3StorySetupHandler>(setup, 'setupVue3')
+  const setupFn = getSetupHook<Vue3StorySetupHandler>(setup, VUE_SETUP_HOOK_NAMES)
   if (setupFn) {
     await setupFn(setupApi)
   }

package/src/client/server/run.ts

@@ -6,6 +6,7 @@ import * as generatedSetup from 'virtual:$poveste-generated-global-setup'
 // @ts-expect-error virtual module id
 import * as setup from 'virtual:$poveste-setup'
 import { createApp, h } from 'vue'
+import { VUE_SETUP_HOOK_NAMES } from '../../setup-hooks.js'
 import Story from './Story'
 import Variant from './Variant'
 
@@ -37,12 +38,12 @@ export async function run({ file, storyData, el }: ServerRunPayload) {
     addWrapper: () => { /* noop */ },
   }
 
-  const generatedSetupFn = getSetupHook<Vue3StorySetupHandler>(generatedSetup, 'setupVue3')
+  const generatedSetupFn = getSetupHook<Vue3StorySetupHandler>(generatedSetup, VUE_SETUP_HOOK_NAMES)
   if (generatedSetupFn) {
     await generatedSetupFn(setupApi)
   }
 
-  const setupFn = getSetupHook<Vue3StorySetupHandler>(setup, 'setupVue3')
+  const setupFn = getSetupHook<Vue3StorySetupHandler>(setup, VUE_SETUP_HOOK_NAMES)
   if (setupFn) {
     await setupFn(setupApi)
   }

package/src/helpers.ts

@@ -10,6 +10,14 @@ export interface Vue3StorySetupApi {
 
 export type Vue3StorySetupHandler = (api: Vue3StorySetupApi) => Promise<void> | void
 
-export function defineSetupVue3(handler: Vue3StorySetupHandler): Vue3StorySetupHandler {
+export function defineSetupVue(handler: Vue3StorySetupHandler): Vue3StorySetupHandler {
   return handler
 }
+
+/**
+ * @deprecated Renamed to {@link defineSetupVue}, and rename the exported hook
+ * from `setupVue3` to `setupVue` at the same time. Both spellings work for the
+ * whole of 0.x; the numbered pair is a candidate for removal at 1.0, which is
+ * the only release allowed to drop them (#135).
+ */
+export const defineSetupVue3 = defineSetupVue

package/src/index.node.ts

@@ -1,6 +1,7 @@
 import type { Plugin } from 'poveste'
 
 import generateStoryCommand from './commands/generate-story.server.js'
+import { VUE_SETUP_HOOK_NAMES } from './setup-hooks.js'
 import { listComponentFiles } from './util/list-components.js'
 
 export function HstVue(): Plugin {
@@ -41,7 +42,7 @@ export function HstVue(): Plugin {
     supportPlugin: {
       id: 'vue3',
       moduleName: '@poveste/plugin-vue',
-      setupFn: 'setupVue3',
+      setupFn: VUE_SETUP_HOOK_NAMES,
       importStoriesPrepend: `import { defineAsyncComponent as defineAsyncComponentVue3 } from 'vue'`,
       importStoryComponent: (file, index) => `const Comp${index} = defineAsyncComponentVue3(() => import(${JSON.stringify(file.moduleId)}))`,
     },

package/src/setup-hooks.ts

@@ -0,0 +1,12 @@
+/**
+ * The names a Vue setup file may export, most established first.
+ *
+ * `setupVue3` is what users have written in `poveste.setup.ts` since histoire,
+ * so it can never be removed without a major. `setupVue` is the unnumbered name
+ * new docs use — added as an alias rather than a rename, which is the only way
+ * to introduce it without breaking every existing setup file (#135).
+ *
+ * Order is load-bearing: `getSetupHook` runs the first one present, so a file
+ * that already exports `setupVue3` behaves exactly as before.
+ */
+export const VUE_SETUP_HOOK_NAMES = ['setupVue3', 'setupVue']