@storybook/react-native 6.5.6-alpha.1 → 7.0.0-alpha.0

package/dist/index.d.ts

@@ -1,19 +1,178 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { Theme } from '@storybook/react-native-theming';
 export { Theme, darkTheme, theme } from '@storybook/react-native-theming';
-import * as _storybook_core_client from '@storybook/core-client';
-import { StoryApi } from '@storybook/addons';
-export { ArgTypes, Args, Parameters, StoryContext } from '@storybook/addons';
-import { ClientApi } from '@storybook/client-api';
+import { C as C$1 } from './ClientApi-05c010e0.js';
 import { ReactElement, ComponentType, JSXElementConstructor, ComponentProps, ReactNode } from 'react';
-import { Args, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations } from '@storybook/csf';
+import { Renderer as Renderer$1, Args as Args$1, ComponentAnnotations, AnnotatedStoryFn, StoryAnnotations } from '@storybook/csf';
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+interface SBBaseType {
+    required?: boolean;
+    raw?: string;
+}
+type SBScalarType = SBBaseType & {
+    name: 'boolean' | 'string' | 'number' | 'function' | 'symbol';
+};
+type SBArrayType = SBBaseType & {
+    name: 'array';
+    value: SBType;
+};
+type SBObjectType = SBBaseType & {
+    name: 'object';
+    value: Record<string, SBType>;
+};
+type SBEnumType = SBBaseType & {
+    name: 'enum';
+    value: (string | number)[];
+};
+type SBIntersectionType = SBBaseType & {
+    name: 'intersection';
+    value: SBType[];
+};
+type SBUnionType = SBBaseType & {
+    name: 'union';
+    value: SBType[];
+};
+type SBOtherType = SBBaseType & {
+    name: 'other';
+    value: string;
+};
+type SBType = SBScalarType | SBEnumType | SBArrayType | SBObjectType | SBIntersectionType | SBUnionType | SBOtherType;
+
+type StoryId = string;
+type ComponentId = string;
+type ComponentTitle = string;
+type StoryName$1 = string;
+/** @deprecated */
+type StoryKind$1 = ComponentTitle;
+type Tag = string;
+interface StoryIdentifier {
+    componentId: ComponentId;
+    title: ComponentTitle;
+    /** @deprecated */
+    kind: ComponentTitle;
+    id: StoryId;
+    name: StoryName$1;
+    /** @deprecated */
+    story: StoryName$1;
+    tags: Tag[];
+}
+interface Parameters {
+    [name: string]: any;
+}
+type ConditionalTest = {
+    truthy?: boolean;
+} | {
+    exists: boolean;
+} | {
+    eq: any;
+} | {
+    neq: any;
+};
+type ConditionalValue = {
+    arg: string;
+} | {
+    global: string;
+};
+type Conditional = ConditionalValue & ConditionalTest;
+interface InputType {
+    name?: string;
+    description?: string;
+    defaultValue?: any;
+    type?: SBType | SBScalarType['name'];
+    if?: Conditional;
+    [key: string]: any;
+}
+interface StrictInputType extends InputType {
+    name: string;
+    type?: SBType;
+}
+interface Args {
+    [name: string]: any;
+}
+type ArgTypes<TArgs = Args> = {
+    [name in keyof TArgs]: InputType;
+};
+type StrictArgTypes<TArgs = Args> = {
+    [name in keyof TArgs]: StrictInputType;
+};
+type Globals = {
+    [name: string]: any;
+};
+type Renderer = {
+    /** What is the type of the `component` annotation in this renderer? */
+    component: unknown;
+    /** What does the story function return in this renderer? */
+    storyResult: unknown;
+    /** What type of element does this renderer render to? */
+    canvasElement: unknown;
+    T?: unknown;
+};
+type StoryContextForEnhancers<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryIdentifier & {
+    component?: (TRenderer & {
+        T: any;
+    })['component'];
+    subcomponents?: Record<string, (TRenderer & {
+        T: any;
+    })['component']>;
+    parameters: Parameters;
+    initialArgs: TArgs;
+    argTypes: StrictArgTypes<TArgs>;
+};
+type StoryContextUpdate<TArgs = Args> = {
+    args?: TArgs;
+    globals?: Globals;
+    [key: string]: any;
+};
+type ViewMode$1 = 'story' | 'docs';
+type StoryContextForLoaders<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForEnhancers<TRenderer, TArgs> & Required<StoryContextUpdate<TArgs>> & {
+    hooks: unknown;
+    viewMode: ViewMode$1;
+    originalStoryFn: StoryFn$1<TRenderer>;
+};
+type LoaderFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContextForLoaders<TRenderer, TArgs>) => Promise<Record<string, any>>;
+type StoryContext<TRenderer extends Renderer = Renderer, TArgs = Args> = StoryContextForLoaders<TRenderer, TArgs> & {
+    loaded: Record<string, any>;
+    abortSignal: AbortSignal;
+    canvasElement: TRenderer['canvasElement'];
+};
+type PartialStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (update?: StoryContextUpdate<Partial<TArgs>>) => TRenderer['storyResult'];
+type LegacyStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (context: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
+type ArgsStoryFn<TRenderer extends Renderer = Renderer, TArgs = Args> = (args: TArgs, context: StoryContext<TRenderer, TArgs>) => (TRenderer & {
+    T: TArgs;
+})['storyResult'];
+type StoryFn$1<TRenderer extends Renderer = Renderer, TArgs = Args> = LegacyStoryFn<TRenderer, TArgs> | ArgsStoryFn<TRenderer, TArgs>;
+type DecoratorFunction<TRenderer extends Renderer = Renderer, TArgs = Args> = (fn: PartialStoryFn<TRenderer, TArgs>, c: StoryContext<TRenderer, TArgs>) => TRenderer['storyResult'];
+type Addon_ReturnTypeFramework<ReturnType> = {
+    component: any;
+    storyResult: ReturnType;
+    canvasElement: any;
+};
+type Addon_StoryFn<ReturnType = unknown> = StoryFn$1<Addon_ReturnTypeFramework<ReturnType>>;
+type Addon_DecoratorFunction<StoryFnReturnType = unknown> = DecoratorFunction<Addon_ReturnTypeFramework<StoryFnReturnType>>;
+type Addon_LoaderFunction = LoaderFunction<Addon_ReturnTypeFramework<unknown>>;
+type Addon_ClientApiReturnFn<StoryFnReturnType = unknown> = (...args: any[]) => Addon_StoryApi<StoryFnReturnType>;
+interface Addon_StoryApi<StoryFnReturnType = unknown> {
+    kind: StoryKind$1;
+    add: (storyName: StoryName$1, storyFn: Addon_StoryFn<StoryFnReturnType>, parameters?: Parameters) => Addon_StoryApi<StoryFnReturnType>;
+    addDecorator: (decorator: Addon_DecoratorFunction<StoryFnReturnType>) => Addon_StoryApi<StoryFnReturnType>;
+    addLoader: (decorator: Addon_LoaderFunction) => Addon_StoryApi<StoryFnReturnType>;
+    addParameters: (parameters: Parameters) => Addon_StoryApi<StoryFnReturnType>;
+    [k: string]: string | Addon_ClientApiReturnFn<StoryFnReturnType>;
+}
 
 type StoryFnReactReturnType = ReactElement<unknown>;
 
-type ReactNativeFramework = {
+interface ReactNativeFramework extends Renderer$1 {
     component: ComponentType<any>;
     storyResult: StoryFnReactReturnType;
-};
+}
 /**
  * For the common case where a component's stories are simple components that receives args as props:
  *
@@ -56,19 +215,19 @@ type ComponentStory<T extends keyof JSX.IntrinsicElements | JSXElementConstructo
  *
  * @see [Default export](https://storybook.js.org/docs/formats/component-story-format/#default-export)
  */
-type Meta<TArgs = Args> = ComponentAnnotations<ReactNativeFramework, TArgs>;
+type Meta<TArgs = Args$1> = ComponentAnnotations<ReactNativeFramework, 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)
  */
-type StoryFn<TArgs = Args> = AnnotatedStoryFn<ReactNativeFramework, TArgs>;
+type StoryFn<TArgs = Args$1> = AnnotatedStoryFn<ReactNativeFramework, 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)
  */
-type StoryObj<TArgs = Args> = StoryAnnotations<ReactNativeFramework, TArgs>;
+type StoryObj<TArgs = Args$1> = StoryAnnotations<ReactNativeFramework, TArgs>;
 /**
  * Story function that represents a CSFv2 component example.
  *
@@ -77,7 +236,7 @@ type StoryObj<TArgs = Args> = StoryAnnotations<ReactNativeFramework, TArgs>;
  * NOTE that in Storybook 7.0, this type will be renamed to `StoryFn` and replaced by the current `StoryObj` type.
  *
  */
-type Story<TArgs = Args> = StoryFn<TArgs>;
+type Story<TArgs = Args$1> = StoryFn<TArgs>;
 
 type StoryKind = string;
 type StoryName = string;
@@ -111,18 +270,25 @@ type Params = {
     theme: DeepPartial<Theme>;
 };
 
-declare const configure: (loadable: _storybook_core_client.Loadable, m: NodeModule) => void;
+declare global {
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare const configure: (loadable: any, m: {
+    hot?: {
+        accept?: () => void;
+    };
+}) => void;
 
-type C = ClientApi<ReactNativeFramework>;
-declare const setAddon: C['setAddon'];
+type C = C$1<ReactNativeFramework>;
 declare const addDecorator: C['addDecorator'];
 declare const addParameters: C['addParameters'];
 declare const addArgsEnhancer: C['addArgsEnhancer'];
 declare const addArgTypesEnhancer: C['addArgTypesEnhancer'];
-declare const clearDecorators: C['clearDecorators'];
-declare const getStorybook: C['getStorybook'];
 declare const raw: C['raw'];
-declare const storiesOf: (kind: string, _module: NodeModule) => StoryApi<ReactNode>;
+declare const storiesOf: (kind: string, _module: NodeModule) => Addon_StoryApi<ReactNode>;
 declare const getStorybookUI: (params?: Partial<Params>) => () => react_jsx_runtime.JSX.Element;
 
-export { ComponentMeta, ComponentStory, ComponentStoryFn, ComponentStoryObj, Meta, ReactNativeFramework, Story, StoryFn, StoryFnReactReturnType, StoryObj, addArgTypesEnhancer, addArgsEnhancer, addDecorator, addParameters, clearDecorators, configure, getStorybook, getStorybookUI, raw, setAddon, storiesOf };
+export { ArgTypes, Args, ComponentMeta, ComponentStory, ComponentStoryFn, ComponentStoryObj, Meta, Parameters, ReactNativeFramework, Story, StoryContext, StoryFn, StoryFnReactReturnType, StoryObj, addArgTypesEnhancer, addArgsEnhancer, addDecorator, addParameters, configure, getStorybookUI, raw, storiesOf };