@repobuddy/storybook 2.0.1 → 2.1.1

package/cjs/parameters/define_docs_param.d.ts

@@ -1,217 +0,0 @@
-import type { StoryContext } from '@storybook/react-vite';
-declare global {
-    namespace JSX {
-        interface Element {
-        }
-    }
-}
-export interface SourceProps {
-    /**
-     * Provides the source code to be rendered.
-     *
-     * This is useful when the story contains extra code that would be confusing in the docs.
-     *
-     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#code
-     */
-    code?: string | undefined;
-    /**
-     * Specifies whether the source code should be rendered in dark mode.
-     *
-     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#dark
-     */
-    dark?: boolean | undefined;
-    /**
-     * Specifies whether decorators should be excluded from the source code.
-     *
-     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#excludedecorators
-     *
-     * Note: Has no effect in React.
-     * @see https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#parameter-docssourceexcludedecorators-has-no-effect-in-react
-     */
-    excludeDecorators?: boolean | undefined;
-    /**
-     * Specifies the language of the source code.
-     *
-     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#language
-     */
-    language?: string | undefined;
-    /**
-     * A function to dynamically transform the source before being rendered,
-     * based on the original source and any story context necessary.
-     * The returned string is displayed as-is.
-     *
-     * If both code and transform are specified, transform will be ignored.
-     *
-     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#transform
-     */
-    transform?: ((code: string, storyContext: StoryContext) => string) | undefined;
-    /**
-     * Specifies how the source code is rendered.
-     *
-     * - auto: Same as dynamic, if the story's render function accepts args inputs and dynamic is supported by the framework in use; otherwise same as code
-     * - code: Renders the value of code prop, otherwise renders static story source
-     * - dynamic: Renders the story source with dynamically updated arg values
-     *
-     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#type
-     */
-    type?: 'auto' | 'code' | 'dynamic' | undefined;
-}
-export interface DocsParam {
-    docs: {
-        argTypes?: {
-            /**
-             * Specifies which controls to exclude from the args table.
-             * Any controls whose names match the regex or are part of the array will be left out.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes#exclude
-             */
-            exclude?: string[] | RegExp | undefined;
-            /**
-             * Specifies which controls to include in the args table.
-             * Any controls whose names don't match the regex or are not part of the array will be left out.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes#include
-             */
-            include?: string[] | RegExp | undefined;
-            /**
-             * Specifies how the arg types are sorted.
-             *
-             * - none: Unsorted, displayed in the same order the arg types are processed in
-             * - alpha: Sorted alphabetically, by the arg type's name
-             * - requiredFirst: Same as alpha, with any required arg types displayed first
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes#sort
-             */
-            sort?: 'alpha' | 'requiredFirst' | 'none' | undefined;
-        } | undefined;
-        description?: {
-            /**
-             * `docs.description.story` can be used to describe the story in doc.
-             */
-            story?: string | undefined;
-            /**
-             * `docs.description.component` can be used to describe the component in meta.
-             * It has no effect on the stories.
-             */
-            component?: string | undefined;
-        } | undefined;
-        /**
-         * Determines whether to show the code panel.
-         *
-         * @see https://storybook.js.org/docs/writing-docs/code-panel
-         */
-        codePanel?: boolean | undefined;
-        source?: SourceProps | undefined;
-        canvas?: {
-            /**
-             * Provides any additional custom actions to show in the bottom right corner.
-             * These are simple buttons that do anything you specify in the onClick function.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#additionalactions
-             */
-            additionalActions?: Array<{
-                title: string | JSX.Element;
-                className?: string;
-                onClick: () => void;
-                disabled?: boolean;
-            }> | undefined;
-            /**
-             * Provides HTML class(es) to the preview element, for custom styling.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#classname
-             */
-            className?: string | undefined;
-            /**
-             * Specifies how the canvas should layout the story.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#layout
-             */
-            layout?: 'centered' | 'padded' | 'fullscreen' | undefined;
-            /**
-             * Specifies the initial state of the source panel.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#sourcestate
-             */
-            sourceState?: 'hidden' | 'shown' | 'none' | undefined;
-            /**
-             * Determines whether to render a toolbar containing tools to interact with the story.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#withtoolbar
-             */
-            withToolbar?: boolean | undefined;
-        } | undefined;
-        controls?: {
-            /**
-             * Specifies which controls to exclude from the args table.
-             * Any controls whose names match the regex or are part of the array will be left out.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls#exclude
-             */
-            exclude?: string[] | RegExp | undefined;
-            /**
-             * Specifies which controls to include in the args table.
-             * Any controls whose names don't match the regex or are not part of the array will be left out.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls#include
-             */
-            include?: string[] | RegExp | undefined;
-            /**
-             *
-             * Specifies how the controls are sorted.
-             *
-             * - none: Unsorted, displayed in the same order the controls are processed in
-             * - alpha: Sorted alphabetically, by the arg type's name
-             * - requiredFirst: Same as alpha, with any required controls displayed first
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls#sort
-             */
-            sort?: 'alpha' | 'requiredFirst' | 'none' | undefined;
-        } | undefined;
-        story?: {
-            /**
-             * Specifies whether the story should be autoplayed.
-             *
-             * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-story#autoplay
-             */
-            autoplay?: boolean | undefined;
-            /**
-             * Set a minimum height (note for an iframe this is the actual height) when rendering a story in an iframe or inline.
-             * This overrides parameters.docs.story.iframeHeight for iframes.
-             */
-            height?: string | undefined;
-            /**
-             * Determines whether the story is rendered inline (in the same browser frame as the other docs content) or in an iframe.
-             */
-            inline?: boolean | undefined;
-        } | undefined;
-        [k: string]: unknown;
-    };
-}
-/**
- * Defines docs parameters for Storybook stories.
- *
- * @param docs - Configuration for docs parameters including options for:
- * - Controls display and sorting
- * - Story rendering (autoplay, height, inline vs iframe)
- * - And other docs-related settings
- * @returns An object containing the docs parameter configuration
- *
- * @example
- * ```ts
- * import { defineDocsParam } from '@repobuddy/storybook'
- *
- * export default {
- *   parameters: defineDocsParam({
- *     controls: {
- *       sort: 'alpha',
- *       exclude: ['internal*']
- *     },
- *     story: {
- *       inline: true,
- *       height: '400px'
- *     }
- *   })
- * }
- * ```
- */
-export declare function defineDocsParam(docs: DocsParam['docs']): DocsParam['docs'];

package/cjs/parameters/define_docs_param.js

@@ -1,11 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defineDocsParam = defineDocsParam;
-function defineDocsParam(docs) {
-  return {
-    docs
-  };
-}

package/cjs/parameters/define_layout_param.d.ts

@@ -1,20 +0,0 @@
-export interface LayoutParam {
-    layout: 'padded' | 'fullscreen' | 'centered';
-}
-/**
- * Helper function to define the layout parameter for a story
- *
- * @see https://storybook.js.org/docs/api/parameters#layout
- *
- * @param layout - The layout type to use ('padded', 'fullscreen', or 'centered')
- * @returns An object containing the layout parameter
- * @example
- * ```ts
- * export const MyStory = {
- *   parameters: defineLayoutParam('centered')
- * }
- * ```
- */
-export declare const defineLayoutParam: (layout: LayoutParam["layout"]) => {
-    layout: "centered" | "padded" | "fullscreen";
-};

package/cjs/parameters/define_layout_param.js

@@ -1,10 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defineLayoutParam = void 0;
-const defineLayoutParam = layout => ({
-  layout
-});
-exports.defineLayoutParam = defineLayoutParam;

package/cjs/parameters/define_parameters.d.ts

@@ -1,39 +0,0 @@
-import type { BackgroundsParam, GlobalApiBackgroundsParam } from './define_backgrounds_param.js';
-import type { DocsParam } from './define_docs_param.js';
-import type { LayoutParam } from './define_layout_param.js';
-import type { TestParam } from './define_test_param.js';
-import type { ViewportParam } from './define_viewport_param.js';
-import type { StorySortParam } from './story_sort.js';
-export type StorybookBuiltInParams = Partial<BackgroundsParam | GlobalApiBackgroundsParam> & Partial<DocsParam> & Partial<LayoutParam> & Partial<TestParam> & Partial<ViewportParam> & {
-    options?: StorySortParam & Record<string, any>;
-} & Record<string, any>;
-/**
- * Defines parameters for Storybook stories, combining built-in parameters with custom ones.
- *
- * @param parameters - Configuration object containing both built-in Storybook parameters and custom parameters
- * @returns The combined parameters object
- *
- * @example
- * ```ts
- * import { defineParameters } from '@repobuddy/storybook'
- *
- * export default {
- *   parameters: defineParameters({
- *     // Built-in parameters
- *     layout: 'centered',
- *     backgrounds: {
- *       default: 'light',
- *       values: [
- *         { name: 'light', value: '#ffffff' },
- *         { name: 'dark', value: '#333333' }
- *       ]
- *     },
- *     // Custom parameters
- *     myCustomParam: {
- *       someValue: true
- *     }
- *   })
- * }
- * ```
- */
-export declare function defineParameters<P extends Record<string, any>>(param: P & StorybookBuiltInParams, ...rest: Array<StorybookBuiltInParams>): any;

package/cjs/parameters/define_parameters.js

@@ -1,9 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defineParameters = defineParameters;
-function defineParameters(param, ...rest) {
-  return rest.reduce((acc, param2) => Object.assign(acc, param2), param);
-}

package/cjs/parameters/define_test_param.d.ts

@@ -1,34 +0,0 @@
-export interface TestParam {
-    test: {
-        clearMocks?: boolean | undefined;
-        mockReset?: boolean | undefined;
-        restoreMocks?: boolean | undefined;
-        dangerouslyIgnoreUnhandledErrors?: boolean | undefined;
-        [k: string]: unknown;
-    };
-}
-/**
- * Defines test parameters for Storybook stories.
- *
- * @see https://storybook.js.org/docs/api/parameters#test
- *
- * @param test - Configuration for test parameters
- * @returns An object containing the test parameter configuration
- *
- * @example
- * defineTestParam({
- *   clearMocks: true,
- *   mockReset: true,
- *   restoreMocks: true,
- *   dangerouslyIgnoreUnhandledErrors: true
- * })
- */
-export declare function defineTestParam(test: TestParam['test']): {
-    test: {
-        [k: string]: unknown;
-        clearMocks?: boolean | undefined;
-        mockReset?: boolean | undefined;
-        restoreMocks?: boolean | undefined;
-        dangerouslyIgnoreUnhandledErrors?: boolean | undefined;
-    };
-};

package/cjs/parameters/define_test_param.js

@@ -1,11 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defineTestParam = defineTestParam;
-function defineTestParam(test) {
-  return {
-    test
-  };
-}

package/cjs/parameters/define_viewport_param.d.ts

@@ -1,78 +0,0 @@
-export interface ViewportParam {
-    viewport: {
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#viewports
-         */
-        viewports?: Record<string, Viewport> | undefined;
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#defaultorientation
-         */
-        defaultOrientation?: 'landscape' | 'portrait' | undefined;
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#defaultviewport
-         */
-        defaultViewport?: string | undefined;
-        /**
-         * Disables the viewport parameter.
-         * @deprecated Use `disabled` instead.
-         */
-        disable?: boolean | undefined;
-        [k: string]: unknown;
-    };
-}
-export interface Viewport {
-    name: string;
-    styles: {
-        width: string;
-        height: string;
-    };
-    type: 'mobile' | 'tablet' | 'desktop';
-}
-export interface GlobalApiViewportParam {
-    viewport: {
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#viewports
-         */
-        options?: Record<string, Viewport> | undefined;
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#defaultviewport
-         */
-        defaultViewport?: string | undefined;
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#defaultorientation
-         */
-        defaultOrientation?: 'landscape' | 'portrait' | undefined;
-        /**
-         * @see https://storybook.js.org/docs/essentials/viewport#disable
-         */
-        disabled?: boolean | undefined;
-    };
-}
-/**
- * Defines viewport parameters for Storybook stories.
- *
- * @see https://storybook.js.org/docs/api/parameters#viewport
- *
- * @param viewport - Configuration for viewport parameters including:
- * - viewports: Custom viewport definitions
- * - defaultViewport: The default viewport to use
- * - defaultOrientation: Default orientation (landscape/portrait)
- * - disabled: Whether viewport controls are disabled
- * @returns An object containing the viewport parameter configuration
- *
- * @example
- * ```ts
- * defineViewportParam({
- *   viewports: {
- *     mobile: {
- *       name: 'Mobile',
- *       styles: { width: '320px', height: '568px' },
- *       type: 'mobile'
- *     }
- *   },
- *   defaultViewport: 'mobile',
- *   defaultOrientation: 'portrait'
- * })
- * ```
- */
-export declare function defineViewportParam(viewport: ViewportParam['viewport'] | GlobalApiViewportParam['viewport']): ViewportParam;

package/cjs/parameters/define_viewport_param.js

@@ -1,11 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defineViewportParam = defineViewportParam;
-function defineViewportParam(viewport) {
-  return {
-    viewport
-  };
-}

package/cjs/parameters/story_sort.d.ts

@@ -1,27 +0,0 @@
-type StorySortConfig = {
-    includeNames?: boolean;
-    locales?: string;
-    method?: 'alphabetical' | 'alphabetical-by-kind' | 'custom';
-    order?: string[];
-    [k: string]: unknown;
-};
-type Story = {
-    id: string;
-    importPath: string;
-    name: string;
-    title: string;
-};
-type StorySortFn = (a: Story, b: Story) => number;
-/**
- * Interface for story sorting parameters in Storybook.
- * Used to define how stories should be sorted in the navigation sidebar.
- */
-export interface StorySortParam {
-    /**
-     * Configuration for story sorting. Can be either:
-     * - A StorySortConfig object specifying sort method and options
-     * - A custom sorting function that takes two stories and returns their sort order
-     */
-    storySort: StorySortConfig | StorySortFn;
-}
-export {};

package/cjs/parameters/story_sort.js

@@ -1 +0,0 @@
-"use strict";

package/cjs/storybook-addon-tag-badges/index.d.ts

@@ -1,2 +0,0 @@
-export * from './tag_badges.js';
-export type * from './types.js';

package/cjs/storybook-addon-tag-badges/index.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _tag_badges = require("./tag_badges.js");
-Object.keys(_tag_badges).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  if (key in exports && exports[key] === _tag_badges[key]) return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _tag_badges[key];
-    }
-  });
-});

package/cjs/storybook-addon-tag-badges/tag_badges.d.ts

@@ -1,41 +0,0 @@
-import { type TagBadgeParameters } from 'storybook-addon-tag-badges/manager-helpers';
-type TagBadgeParameter = TagBadgeParameters[0];
-/**
- * Type representing the names of predefined tags used in Storybook stories.
- */
-export type TagNames = 'editor' | 'new' | 'beta' | 'props' | 'deprecated' | 'outdated' | 'danger' | 'todo' | 'code-only' | 'snapshot' | 'unit' | 'integration' | 'keyboard' | 'internal';
-/**
- * Configuration for story tag badges that appear in the Storybook sidebar.
- * Each badge is associated with a specific tag and displays an emoji with a tooltip.
- *
- * The badges help visually identify stories with certain characteristics:
- * - ✏️ Editor - Stories with live editor
- * - 🆕 New - Recently added stories
- * - 🅱️ Beta - Stories for features in beta
- * - 🪦 Deprecated - Stories for deprecated features
- * - ⚠️ Outdated - Stories that need updating
- * - 🚨 Danger - Stories demonstrating dangerous patterns
- * - 📋 Todo - Stories marked as todo/incomplete
- * - 📝 Code Only - Stories without visual examples
- * - 📸 Snapshot - Stories with snapshot tests
- * - 🧪 Unit - Stories with unit tests
- * - 🔗 Integration - Stories with integration tests
- *
- * Also includes the default version badge from `storybook-addon-tag-badges`.
- */
-export declare const editorBadge: TagBadgeParameter;
-export declare const newBadge: TagBadgeParameter;
-export declare const betaBadge: TagBadgeParameter;
-export declare const propsBadge: TagBadgeParameter;
-export declare const deprecatedBadge: TagBadgeParameter;
-export declare const outdatedBadge: TagBadgeParameter;
-export declare const dangerBadge: TagBadgeParameter;
-export declare const todoBadge: TagBadgeParameter;
-export declare const codeOnlyBadge: TagBadgeParameter;
-export declare const snapshotBadge: TagBadgeParameter;
-export declare const unitBadge: TagBadgeParameter;
-export declare const integrationBadge: TagBadgeParameter;
-export declare const keyboardBadge: TagBadgeParameter;
-export declare const internalBadge: TagBadgeParameter;
-export declare const tagBadges: TagBadgeParameters;
-export {};