@storybook/csf
Advanced tools
Comparing version 0.0.2--canary.9c0fda0.0 to 0.0.2--canary.a1972cb.0
@@ -19,3 +19,3 @@ import { SBType, SBScalarType } from './SBType'; | ||
}; | ||
export declare type InputType = { | ||
export interface InputType { | ||
name?: string; | ||
@@ -26,7 +26,7 @@ description?: string; | ||
[key: string]: any; | ||
}; | ||
export declare type StrictInputType = InputType & { | ||
} | ||
export interface StrictInputType extends InputType { | ||
name: string; | ||
type?: SBType; | ||
}; | ||
} | ||
export declare type Args = { | ||
@@ -50,7 +50,7 @@ [name: string]: any; | ||
}; | ||
export declare type Framework = { | ||
export declare type AnyFramework = { | ||
component: unknown; | ||
storyResult: unknown; | ||
}; | ||
export declare type StoryContextForEnhancers<TFramework extends Framework> = StoryIdentifier & { | ||
export declare type StoryContextForEnhancers<TFramework extends AnyFramework> = StoryIdentifier & { | ||
component?: TFramework['component']; | ||
@@ -62,12 +62,13 @@ subcomponents?: Record<string, TFramework['component']>; | ||
}; | ||
export declare type ArgsEnhancer<TFramework extends Framework> = (context: StoryContextForEnhancers<TFramework>) => Args; | ||
export declare type ArgTypesEnhancer<TFramework extends Framework> = ((context: StoryContextForEnhancers<TFramework>) => ArgTypes) & { | ||
export declare type ArgsEnhancer<TFramework extends AnyFramework> = (context: StoryContextForEnhancers<TFramework>) => Args; | ||
export declare type ArgTypesEnhancer<TFramework extends AnyFramework> = ((context: StoryContextForEnhancers<TFramework>) => StrictArgTypes) & { | ||
secondPass?: boolean; | ||
}; | ||
export declare type StoryContextUpdate = { | ||
args: Args; | ||
globals: Globals; | ||
args?: Args; | ||
globals?: Globals; | ||
[key: string]: any; | ||
}; | ||
export declare type ViewMode = 'story' | 'docs'; | ||
export declare type StoryContextForLoaders<TFramework extends Framework> = StoryContextForEnhancers<TFramework> & StoryContextUpdate & { | ||
export declare type StoryContextForLoaders<TFramework extends AnyFramework> = StoryContextForEnhancers<TFramework> & Required<StoryContextUpdate> & { | ||
hooks: unknown; | ||
@@ -77,13 +78,13 @@ viewMode: ViewMode; | ||
}; | ||
export declare type LoaderFunction<TFramework extends Framework> = (c: StoryContextForLoaders<TFramework>) => Promise<Record<string, any>>; | ||
export declare type StoryContext<TFramework extends Framework> = StoryContextForLoaders<TFramework> & { | ||
export declare type LoaderFunction<TFramework extends AnyFramework> = (c: StoryContextForLoaders<TFramework>) => Promise<Record<string, any>>; | ||
export declare type StoryContext<TFramework extends AnyFramework> = StoryContextForLoaders<TFramework> & { | ||
loaded: Record<string, any>; | ||
}; | ||
export declare type PartialStoryFn<TFramework extends Framework> = (p?: StoryContextUpdate) => TFramework['storyResult']; | ||
export declare type LegacyStoryFn<TFramework extends Framework> = (p?: StoryContext<TFramework>) => TFramework['storyResult']; | ||
export declare type ArgsStoryFn<TFramework extends Framework> = (a?: Args, p?: StoryContext<TFramework>) => TFramework['storyResult']; | ||
export declare type StoryFn<TFramework extends Framework> = LegacyStoryFn<TFramework> | ArgsStoryFn<TFramework>; | ||
export declare type DecoratorFunction<TFramework extends Framework> = (fn: PartialStoryFn<TFramework>, c: StoryContext<TFramework>) => TFramework['storyResult']; | ||
export declare type DecoratorApplicator<TFramework extends Framework> = (storyFn: LegacyStoryFn<TFramework>, decorators: DecoratorFunction<TFramework>[]) => LegacyStoryFn<TFramework>; | ||
export declare type BaseAnnotations<TFramework extends Framework, TArgs = Args> = { | ||
export declare type PartialStoryFn<TFramework extends AnyFramework> = (p?: StoryContextUpdate) => TFramework['storyResult']; | ||
export declare type LegacyStoryFn<TFramework extends AnyFramework> = (p?: StoryContext<TFramework>) => TFramework['storyResult']; | ||
export declare type ArgsStoryFn<TFramework extends AnyFramework> = (a?: Args, p?: StoryContext<TFramework>) => TFramework['storyResult']; | ||
export declare type StoryFn<TFramework extends AnyFramework> = LegacyStoryFn<TFramework> | ArgsStoryFn<TFramework>; | ||
export declare type DecoratorFunction<TFramework extends AnyFramework> = (fn: PartialStoryFn<TFramework>, c: StoryContext<TFramework>) => TFramework['storyResult']; | ||
export declare type DecoratorApplicator<TFramework extends AnyFramework> = (storyFn: LegacyStoryFn<TFramework>, decorators: DecoratorFunction<TFramework>[]) => LegacyStoryFn<TFramework>; | ||
export declare type BaseAnnotations<TFramework extends AnyFramework, TArgs = Args> = { | ||
decorators?: DecoratorFunction<TFramework>[]; | ||
@@ -97,3 +98,3 @@ parameters?: Parameters; | ||
}; | ||
export declare type GlobalAnnotations<TFramework extends Framework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & { | ||
export declare type GlobalAnnotations<TFramework extends AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & { | ||
argsEnhancers?: ArgsEnhancer<TFramework>[]; | ||
@@ -106,3 +107,3 @@ argTypesEnhancers?: ArgTypesEnhancer<TFramework>[]; | ||
declare type StoryDescriptor = string[] | RegExp; | ||
export declare type ComponentAnnotations<TFramework extends Framework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & { | ||
export declare type ComponentAnnotations<TFramework extends AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & { | ||
title?: ComponentTitle; | ||
@@ -115,3 +116,3 @@ id?: ComponentId; | ||
}; | ||
export declare type StoryAnnotations<TFramework extends Framework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & { | ||
export declare type StoryAnnotations<TFramework extends AnyFramework, TArgs = Args> = BaseAnnotations<TFramework, TArgs> & { | ||
name?: StoryName; | ||
@@ -121,3 +122,3 @@ storyName?: StoryName; | ||
}; | ||
declare type AnnotatedStoryFn<TFramework extends Framework, TArgs = Args> = StoryFn<TFramework> & StoryAnnotations<TFramework, TArgs>; | ||
export declare type StoryAnnotationsOrFn<TFramework extends Framework, TArgs = Args> = AnnotatedStoryFn<TFramework, TArgs> | StoryAnnotations<TFramework, TArgs>; | ||
declare type AnnotatedStoryFn<TFramework extends AnyFramework, TArgs = Args> = StoryFn<TFramework> & StoryAnnotations<TFramework, TArgs>; | ||
export declare type StoryAnnotationsOrFn<TFramework extends AnyFramework, TArgs = Args> = AnnotatedStoryFn<TFramework, TArgs> | StoryAnnotations<TFramework, TArgs>; |
{ | ||
"name": "@storybook/csf", | ||
"version": "0.0.2--canary.9c0fda0.0", | ||
"version": "0.0.2--canary.a1972cb.0", | ||
"description": "Component Story Format (CSF) utilities", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
26020
577