@histoire/shared 0.8.4 → 0.9.2

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './codegen/index.js';
 export * from './types.js';
 export * from './state.js';
+export * from './type-utils.js';

package/dist/index.js

@@ -1,3 +1,4 @@
 export * from './codegen/index.js';
 export * from './types.js';
 export * from './state.js';
+export * from './type-utils.js';

package/dist/type-utils.d.ts

@@ -0,0 +1 @@
+export declare type Awaitable<T> = Promise<T> | T;

package/dist/type-utils.js

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -1,6 +1,6 @@
 export interface StoryFile {
     id: string;
-    framework: string;
+    supportPluginId: string;
     component: any;
     story: Story;
     path: string[];
@@ -12,6 +12,25 @@ export declare type StoryLayout = {
     type: 'grid';
     width?: number | string;
 };
+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 {
+}
+export interface StoryProps extends CommonProps, InheritedProps {
+    group?: string;
+    layout?: StoryLayout;
+    docsOnly?: boolean;
+}
 export interface Story {
     id: string;
     title: string;
@@ -23,7 +42,7 @@ export interface Story {
     docsOnly?: boolean;
     file?: StoryFile;
     lastSelectedVariant?: Variant;
-    slots?: () => Readonly<any>;
+    slots?: () => any;
 }
 export interface Variant {
     id: string;
@@ -31,7 +50,10 @@ export interface Variant {
     icon?: string;
     iconColor?: string;
     setupApp?: (payload: any) => unknown;
-    slots?: () => Readonly<any>;
+    slots?: () => {
+        default: any;
+        controls: any;
+    };
     state: any;
     source?: string;
     responsiveDisabled?: boolean;
@@ -60,6 +82,10 @@ export interface ServerStoryFile {
      * File name without extension
      */
     fileName: string;
+    /**
+     * Support plugin (Vue, Svelte, etc.)
+     */
+    supportPluginId: string;
     /**
      * Generated path for tree UI
      */
@@ -123,3 +149,12 @@ export interface ServerRunPayload {
     storyData: ServerStory[];
     el: HTMLElement;
 }
+export interface SupportPlugin {
+    id: string;
+    moduleName: string;
+    setupFn: string;
+    importStoriesPrepend?: string;
+    importStoryComponent: (file: ServerStoryFile, index: number) => string;
+}
+export interface FinalSupportPlugin extends SupportPlugin {
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@histoire/shared",
-  "version": "0.8.4",
+  "version": "0.9.2",
   "description": "Shared utilities for Histoire",
   "license": "MIT",
   "author": {

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './codegen/index.js'
 export * from './types.js'
 export * from './state.js'
+export * from './type-utils.js'

package/src/type-utils.ts

@@ -0,0 +1 @@
+export type Awaitable<T> = Promise<T> | T

package/src/types.ts

@@ -1,6 +1,6 @@
 export interface StoryFile {
   id: string
-  framework: string
+  supportPluginId: string
   component: any
   story: Story
   path: string[]
@@ -14,6 +14,30 @@ export type StoryLayout = {
   width?: number | string
 }
 
+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 Story {
   id: string
   title: string
@@ -25,7 +49,7 @@ export interface Story {
   docsOnly?: boolean
   file?: StoryFile
   lastSelectedVariant?: Variant
-  slots?: () => Readonly<any>
+  slots?: () => any
 }
 
 export interface Variant {
@@ -34,7 +58,7 @@ export interface Variant {
   icon?: string
   iconColor?: string
   setupApp?: (payload: any) => unknown
-  slots?: () => Readonly<any>
+  slots?: () => { default: any, controls: any }
   state: any
   source?: string
   responsiveDisabled?: boolean
@@ -68,6 +92,10 @@ export interface ServerStoryFile {
    * File name without extension
    */
   fileName: string
+  /**
+   * Support plugin (Vue, Svelte, etc.)
+   */
+  supportPluginId: string
   /**
    * Generated path for tree UI
    */
@@ -139,3 +167,15 @@ export interface ServerRunPayload {
   storyData: ServerStory[]
   el: HTMLElement
 }
+
+export interface SupportPlugin {
+  id: string
+  moduleName: string
+  setupFn: string
+  importStoriesPrepend?: string
+  importStoryComponent: (file: ServerStoryFile, index: number) => string
+}
+
+export interface FinalSupportPlugin extends SupportPlugin {
+  // For now, no additional properties
+}

package/tsconfig.json

@@ -10,10 +10,6 @@
     "removeComments": false,
     "resolveJsonModule": true,
     "skipLibCheck": true,
-    "types": [
-      "node",
-      "@peeky/test"
-    ],
     "lib": [
       "ESNext",
       "DOM"