@storybook/react 7.0.0-alpha.2 → 7.0.0-alpha.23

package/dist/types/docs/lib/inspection/index.d.ts

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './inspectValue';

package/dist/types/docs/lib/inspection/inspectValue.d.ts

@@ -1,2 +0,0 @@
-import { InspectionResult } from './types';
-export declare function inspectValue(value: string): InspectionResult;

package/dist/types/docs/lib/inspection/types.d.ts

@@ -1,50 +0,0 @@
-export declare enum InspectionType {
-    IDENTIFIER = "Identifier",
-    LITERAL = "Literal",
-    OBJECT = "Object",
-    ARRAY = "Array",
-    FUNCTION = "Function",
-    CLASS = "Class",
-    ELEMENT = "Element",
-    UNKNOWN = "Unknown"
-}
-export interface InspectionInferedType {
-    type: InspectionType;
-}
-export interface InspectionIdentifier extends InspectionInferedType {
-    type: InspectionType.IDENTIFIER;
-    identifier: string;
-}
-export interface InspectionLiteral extends InspectionInferedType {
-    type: InspectionType.LITERAL;
-}
-export interface InspectionObject extends InspectionInferedType {
-    type: InspectionType.OBJECT;
-    depth: number;
-}
-export interface InspectionArray extends InspectionInferedType {
-    type: InspectionType.ARRAY;
-    depth: number;
-}
-export interface InspectionClass extends InspectionInferedType {
-    type: InspectionType.CLASS;
-    identifier: string;
-}
-export interface InspectionFunction extends InspectionInferedType {
-    type: InspectionType.FUNCTION;
-    identifier?: string;
-    params: any[];
-    hasParams: boolean;
-}
-export interface InspectionElement extends InspectionInferedType {
-    type: InspectionType.ELEMENT;
-    identifier?: string;
-}
-export interface InspectionUnknown extends InspectionInferedType {
-    type: InspectionType.UNKNOWN;
-}
-export declare type InspectionIdentifiableInferedType = InspectionIdentifier | InspectionClass | InspectionFunction | InspectionElement;
-export interface InspectionResult {
-    inferredType: InspectionInferedType;
-    ast?: any;
-}

package/dist/types/docs/lib/isHtmlTag.d.ts

@@ -1 +0,0 @@
-export declare function isHtmlTag(tagName: string): boolean;

package/dist/types/docs/propTypes/createType.d.ts

@@ -1,2 +0,0 @@
-import type { ExtractedProp, PropType } from '@storybook/docs-tools';
-export declare function createType(extractedProp: ExtractedProp): PropType;

package/dist/types/docs/propTypes/generateFuncSignature.d.ts

@@ -1,4 +0,0 @@
-import { ExtractedJsDocParam, ExtractedJsDocReturns } from '@storybook/docs-tools';
-export declare function generateFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string;
-export declare function generateShortFuncSignature(params: ExtractedJsDocParam[], returns: ExtractedJsDocReturns): string;
-export declare function toMultilineSignature(signature: string): string;

package/dist/types/docs/propTypes/handleProp.d.ts

@@ -1,5 +0,0 @@
-import { PropDef, ExtractedProp } from '@storybook/docs-tools';
-declare type Component = any;
-export declare function enhancePropTypesProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef;
-export declare function enhancePropTypesProps(extractedProps: ExtractedProp[], component: Component): PropDef[];
-export {};

package/dist/types/docs/propTypes/rawDefaultPropResolvers.d.ts

@@ -1 +0,0 @@
-export declare const rawDefaultPropTypeResolvers: import("../lib/defaultValues").TypeResolvers;

package/dist/types/docs/propTypes/sortProps.d.ts

@@ -1,4 +0,0 @@
-import { PropDef } from '@storybook/docs-tools';
-declare type Component = any;
-export declare function keepOriginalDefinitionOrder(extractedProps: PropDef[], component: Component): PropDef[];
-export {};

package/dist/types/docs/react-argtypes.stories.d.ts

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

package/dist/types/docs/typeScript/handleProp.d.ts

@@ -1,3 +0,0 @@
-import { PropDef, ExtractedProp } from '@storybook/docs-tools';
-export declare function enhanceTypeScriptProp(extractedProp: ExtractedProp, rawDefaultProp?: any): PropDef;
-export declare function enhanceTypeScriptProps(extractedProps: ExtractedProp[]): PropDef[];

package/dist/types/index.d.ts

@@ -1,4 +0,0 @@
-export type { DecoratorFn } from './preview';
-export { storiesOf, setAddon, addDecorator, addParameters, configure, getStorybook, raw, forceReRender, } from './preview';
-export * from './testing';
-export * from './preview/types-6-3';

package/dist/types/preview/config.d.ts

@@ -1 +0,0 @@
-export { render, renderToDOM } from './render';

package/dist/types/preview/globals.d.ts

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

package/dist/types/preview/index.d.ts

@@ -1,25 +0,0 @@
-/// <reference types="webpack-env" />
-/// <reference types="node" />
-import { ClientStoryApi, Loadable } from '@storybook/addons';
-import './globals';
-import { IStorybookSection } from './types';
-import { ReactFramework } from './types-6-0';
-interface ClientApi extends ClientStoryApi<ReactFramework['storyResult']> {
-    setAddon(addon: any): void;
-    configure(loader: Loadable, module: NodeModule): void;
-    getStorybook(): IStorybookSection[];
-    clearDecorators(): void;
-    forceReRender(): void;
-    raw: () => any;
-}
-export declare const storiesOf: ClientApi['storiesOf'];
-export declare const configure: ClientApi['configure'];
-export declare const addDecorator: ClientApi['addDecorator'];
-export declare type DecoratorFn = Parameters<typeof addDecorator>[0];
-export declare const addParameters: ClientApi['addParameters'];
-export declare const clearDecorators: ClientApi['clearDecorators'];
-export declare const setAddon: ClientApi['setAddon'];
-export declare const forceReRender: ClientApi['forceReRender'];
-export declare const getStorybook: ClientApi['getStorybook'];
-export declare const raw: ClientApi['raw'];
-export {};

package/dist/types/preview/render.d.ts

@@ -1,5 +0,0 @@
-import type { RenderContext } from '@storybook/store';
-import { ArgsStoryFn } from '@storybook/csf';
-import { ReactFramework } from './types-6-0';
-export declare const render: ArgsStoryFn<ReactFramework>;
-export declare function renderToDOM({ storyContext, unboundStoryFn, showMain, showException, forceRemount, }: RenderContext<ReactFramework>, domElement: HTMLElement): Promise<void>;

package/dist/types/preview/types-6-0.d.ts

@@ -1,35 +0,0 @@
-import type { ComponentType } from 'react';
-import type { Args, ComponentAnnotations, StoryAnnotations, AnnotatedStoryFn } from '@storybook/csf';
-import type { StoryFnReactReturnType } from './types';
-export type { Args, ArgTypes, Parameters, StoryContext } from '@storybook/csf';
-export declare type ReactFramework = {
-    component: ComponentType<any>;
-    storyResult: StoryFnReactReturnType;
-};
-/**
- * Metadata to configure the stories for a component.
- *
- * @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
- */
-export declare type Meta<TArgs = Args> = ComponentAnnotations<ReactFramework, TArgs>;
-/**
- * Story function that represents a CSFv2 component example.
- *
- * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
- */
-export declare type StoryFn<TArgs = Args> = AnnotatedStoryFn<ReactFramework, TArgs>;
-/**
- * Story function that represents a CSFv3 component example.
- *
- * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
- */
-export declare type StoryObj<TArgs = Args> = StoryAnnotations<ReactFramework, TArgs>;
-/**
- * Story function that represents a CSFv2 component example.
- *
- * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
- *
- * NOTE that in Storybook 7.0, this type will be renamed to `StoryFn` and replaced by the current `StoryObj` type.
- *
- */
-export declare type Story<TArgs = Args> = StoryFn<TArgs>;

package/dist/types/preview/types-6-3.d.ts

@@ -1,40 +0,0 @@
-import { ComponentProps, JSXElementConstructor } from 'react';
-import type { StoryFn, StoryObj, Story, Meta } from './types-6-0';
-export * from './types-6-0';
-/**
- * For the common case where a component's stories are simple components that receives args as props:
- *
- * ```tsx
- * export default { ... } as ComponentMeta<typeof Button>;
- * ```
- */
-export declare type ComponentMeta<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = Meta<ComponentProps<T>>;
-/**
- * For the common case where a (CSFv2) story is a simple component that receives args as props:
- *
- * ```tsx
- * const Template: ComponentStory<typeof Button> = (args) => <Button {...args} />
- * ```
- */
-export declare type ComponentStoryFn<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = StoryFn<ComponentProps<T>>;
-/**
- * For the common case where a (CSFv3) story is a simple component that receives args as props:
- *
- * ```tsx
- * const MyStory: ComponentStory<typeof Button> = {
- *   args: { buttonArg1: 'val' },
- * }
- * ```
- */
-export declare type ComponentStoryObj<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = StoryObj<ComponentProps<T>>;
-/**
- * For the common case where a (CSFv2) story is a simple component that receives args as props:
- *
- * ```tsx
- * const Template: ComponentStory<typeof Button> = (args) => <Button {...args} />
- * ```
- *
- * NOTE: this is an alias for `ComponentStoryFn`.
- * In Storybook v7, `ComponentStory` will alias `ComponentStoryObj`
- */
-export declare type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = Story<ComponentProps<T>>;

package/dist/types/preview/types-7-0.d.ts

@@ -1,21 +0,0 @@
-import type { JSXElementConstructor } from 'react';
-import type { Args } from '@storybook/csf';
-import type { StoryObj } from './types-6-0';
-import type { ComponentStoryObj } from './types-6-3';
-export type { StoryFn, StoryObj, Meta } from './types-6-0';
-export type { ComponentStoryFn, ComponentStoryObj, ComponentMeta } from './types-6-3';
-/**
- * Story function that represents a CSFv3 component example.
- *
- * @see [Named Story exports](https://storybook.js.org/docs/formats/component-story-format/#named-story-exports)
- */
-export declare type Story<TArgs = Args> = StoryObj<TArgs>;
-/**
- * For the common case where a (CSFv3) story is a simple component that receives args as props:
- *
- * ```tsx
- * const MyStory: ComponentStory<typeof Button> = {
- *   args: { buttonArg1: 'val' },
- * }
- * ```
- */ export declare type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructor<any>> = ComponentStoryObj<T>;

package/dist/types/preview/types.d.ts

@@ -1,16 +0,0 @@
-import { ReactElement } from 'react';
-export type { RenderContext } from '@storybook/store';
-export type { StoryContext } from '@storybook/csf';
-export interface ShowErrorArgs {
-    title: string;
-    description: string;
-}
-export declare type StoryFnReactReturnType = ReactElement<unknown>;
-export interface IStorybookStory {
-    name: string;
-    render: (context: any) => any;
-}
-export interface IStorybookSection {
-    kind: string;
-    stories: IStorybookStory[];
-}

package/dist/types/testing/index.d.ts

@@ -1,84 +0,0 @@
-import { CSFExports, ComposedStory, StoriesWithPartialProps } from '@storybook/store';
-import { ProjectAnnotations, Args } from '@storybook/csf';
-import type { Meta, ReactFramework } from '../preview/types-6-0';
-/** Function that sets the globalConfig of your storybook. The global config is the preview module of your .storybook folder.
- *
- * It should be run a single time, so that your global config (e.g. decorators) is applied to your stories when using `composeStories` or `composeStory`.
- *
- * Example:
- *```jsx
- * // setup.js (for jest)
- * import { setProjectAnnotations } from '@storybook/react';
- * import * as projectAnnotations from './.storybook/preview';
- *
- * setProjectAnnotations(projectAnnotations);
- *```
- *
- * @param projectAnnotations - e.g. (import * as projectAnnotations from '../.storybook/preview')
- */
-export declare function setProjectAnnotations(projectAnnotations: ProjectAnnotations<ReactFramework> | ProjectAnnotations<ReactFramework>[]): void;
-/** Preserved for users migrating from `@storybook/testing-react`.
- *
- * @deprecated Use setProjectAnnotations instead
- */
-export declare function setGlobalConfig(projectAnnotations: ProjectAnnotations<ReactFramework> | ProjectAnnotations<ReactFramework>[]): void;
-/**
- * Function that will receive a story along with meta (e.g. a default export from a .stories file)
- * and optionally projectAnnotations e.g. (import * from '../.storybook/preview)
- * and will return a composed component that has all args/parameters/decorators/etc combined and applied to it.
- *
- *
- * It's very useful for reusing a story in scenarios outside of Storybook like unit testing.
- *
- * Example:
- *```jsx
- * import { render } from '@testing-library/react';
- * import { composeStory } from '@storybook/react';
- * import Meta, { Primary as PrimaryStory } from './Button.stories';
- *
- * const Primary = composeStory(PrimaryStory, Meta);
- *
- * test('renders primary button with Hello World', () => {
- *   const { getByText } = render(<Primary>Hello world</Primary>);
- *   expect(getByText(/Hello world/i)).not.toBeNull();
- * });
- *```
- *
- * @param story
- * @param componentAnnotations - e.g. (import Meta from './Button.stories')
- * @param [projectAnnotations] - e.g. (import * as projectAnnotations from '../.storybook/preview') this can be applied automatically if you use `setProjectAnnotations` in your setup files.
- * @param [exportsName] - in case your story does not contain a name and you want it to have a name.
- */
-export declare function composeStory<TArgs = Args>(story: ComposedStory<ReactFramework, TArgs>, componentAnnotations: Meta<TArgs | any>, projectAnnotations?: ProjectAnnotations<ReactFramework>, exportsName?: string): {
-    (extraArgs: Partial<TArgs>): import("../preview/types").StoryFnReactReturnType;
-    storyName: string;
-    args: Args;
-    play: import("@storybook/store").ComposedStoryPlayFn;
-    parameters: import("@storybook/store").Parameters;
-};
-/**
- * Function that will receive a stories import (e.g. `import * as stories from './Button.stories'`)
- * and optionally projectAnnotations (e.g. `import * from '../.storybook/preview`)
- * and will return an object containing all the stories passed, but now as a composed component that has all args/parameters/decorators/etc combined and applied to it.
- *
- *
- * It's very useful for reusing stories in scenarios outside of Storybook like unit testing.
- *
- * Example:
- *```jsx
- * import { render } from '@testing-library/react';
- * import { composeStories } from '@storybook/react';
- * import * as stories from './Button.stories';
- *
- * const { Primary, Secondary } = composeStories(stories);
- *
- * test('renders primary button with Hello World', () => {
- *   const { getByText } = render(<Primary>Hello world</Primary>);
- *   expect(getByText(/Hello world/i)).not.toBeNull();
- * });
- *```
- *
- * @param csfExports - e.g. (import * as stories from './Button.stories')
- * @param [projectAnnotations] - e.g. (import * as projectAnnotations from '../.storybook/preview') this can be applied automatically if you use `setProjectAnnotations` in your setup files.
- */
-export declare function composeStories<TModule extends CSFExports<ReactFramework>>(csfExports: TModule, projectAnnotations?: ProjectAnnotations<ReactFramework>): Omit<StoriesWithPartialProps<ReactFramework, TModule>, keyof CSFExports<import("@storybook/csf").AnyFramework>>;