StoryStore-f7424ddf.d.ts 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. import * as _storybook_types from '@storybook/types';
  2. import { StoryId, StoryName, ComponentTitle, StoryIndex, IndexEntry, Path, Args, PreparedStory, Globals, GlobalTypes, Renderer, ModuleExports, CSFFile, NormalizedStoryAnnotations, NormalizedComponentAnnotations, NormalizedProjectAnnotations, ModuleExport, PreparedMeta, StoryContextForLoaders, ModuleImportFn, ProjectAnnotations, StoryContextForEnhancers, Parameters, StoryIndexV3, API_PreparedStoryIndex, BoundStory } from '@storybook/types';
  3. import { SynchronousPromise } from 'synchronous-promise';
  4. import { H as HooksContext } from './hooks-655fa363.js';
  5. type StorySpecifier = StoryId | {
  6. name: StoryName;
  7. title: ComponentTitle;
  8. } | '*';
  9. declare class StoryIndexStore {
  10. entries: StoryIndex['entries'];
  11. constructor({ entries }?: StoryIndex);
  12. entryFromSpecifier(specifier: StorySpecifier): IndexEntry | undefined;
  13. storyIdToEntry(storyId: StoryId): IndexEntry;
  14. importPathToEntry(importPath: Path): IndexEntry;
  15. }
  16. declare class ArgsStore {
  17. initialArgsByStoryId: Record<StoryId, Args>;
  18. argsByStoryId: Record<StoryId, Args>;
  19. get(storyId: StoryId): Args;
  20. setInitial(story: PreparedStory<any>): void;
  21. updateFromDelta(story: PreparedStory<any>, delta: Args): void;
  22. updateFromPersisted(story: PreparedStory<any>, persisted: Args): void;
  23. update(storyId: StoryId, argsUpdate: Partial<Args>): void;
  24. }
  25. declare class GlobalsStore {
  26. allowedGlobalNames: Set<string>;
  27. initialGlobals: Globals;
  28. globals: Globals;
  29. constructor({ globals, globalTypes, }: {
  30. globals?: Globals;
  31. globalTypes?: GlobalTypes;
  32. });
  33. set({ globals, globalTypes }: {
  34. globals?: Globals;
  35. globalTypes?: GlobalTypes;
  36. }): void;
  37. filterAllowedGlobals(globals: Globals): Globals;
  38. updateFromPersisted(persisted: Globals): void;
  39. get(): Globals;
  40. update(newGlobals: Globals): void;
  41. }
  42. declare function processCSFFile<TRenderer extends Renderer>(moduleExports: ModuleExports, importPath: Path, title: ComponentTitle): CSFFile<TRenderer>;
  43. declare function prepareStory<TRenderer extends Renderer>(storyAnnotations: NormalizedStoryAnnotations<TRenderer>, componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>): PreparedStory<TRenderer>;
  44. declare function prepareMeta<TRenderer extends Renderer>(componentAnnotations: NormalizedComponentAnnotations<TRenderer>, projectAnnotations: NormalizedProjectAnnotations<TRenderer>, moduleExport: ModuleExport): PreparedMeta<TRenderer>;
  45. declare function prepareContext<TRenderer extends Renderer, TContext extends Pick<StoryContextForLoaders<TRenderer>, 'args' | 'argTypes' | 'globals'>>(context: TContext): TContext & Pick<StoryContextForLoaders<TRenderer>, 'allArgs' | 'argsByTarget' | 'unmappedArgs'>;
  46. declare class StoryStore<TRenderer extends Renderer> {
  47. storyIndex?: StoryIndexStore;
  48. importFn?: ModuleImportFn;
  49. projectAnnotations?: NormalizedProjectAnnotations<TRenderer>;
  50. globals?: GlobalsStore;
  51. args: ArgsStore;
  52. hooks: Record<StoryId, HooksContext<TRenderer>>;
  53. cachedCSFFiles?: Record<Path, CSFFile<TRenderer>>;
  54. processCSFFileWithCache: typeof processCSFFile;
  55. prepareMetaWithCache: typeof prepareMeta;
  56. prepareStoryWithCache: typeof prepareStory;
  57. initializationPromise: SynchronousPromise<void>;
  58. resolveInitializationPromise: () => void;
  59. constructor();
  60. setProjectAnnotations(projectAnnotations: ProjectAnnotations<TRenderer>): void;
  61. initialize({ storyIndex, importFn, cache, }: {
  62. storyIndex?: StoryIndex;
  63. importFn: ModuleImportFn;
  64. cache?: boolean;
  65. }): Promise<void>;
  66. onStoriesChanged({ importFn, storyIndex, }: {
  67. importFn?: ModuleImportFn;
  68. storyIndex?: StoryIndex;
  69. }): Promise<void>;
  70. storyIdToEntry(storyId: StoryId): Promise<IndexEntry>;
  71. loadCSFFileByStoryId(storyId: StoryId): Promise<CSFFile<TRenderer>>;
  72. loadAllCSFFiles({ batchSize }?: {
  73. batchSize?: number | undefined;
  74. }): Promise<StoryStore<TRenderer>['cachedCSFFiles']>;
  75. cacheAllCSFFiles(): Promise<void>;
  76. preparedMetaFromCSFFile({ csfFile }: {
  77. csfFile: CSFFile<TRenderer>;
  78. }): PreparedMeta<TRenderer>;
  79. loadStory({ storyId }: {
  80. storyId: StoryId;
  81. }): Promise<PreparedStory<TRenderer>>;
  82. storyFromCSFFile({ storyId, csfFile, }: {
  83. storyId: StoryId;
  84. csfFile: CSFFile<TRenderer>;
  85. }): PreparedStory<TRenderer>;
  86. componentStoriesFromCSFFile({ csfFile, }: {
  87. csfFile: CSFFile<TRenderer>;
  88. }): PreparedStory<TRenderer>[];
  89. loadEntry(id: StoryId): Promise<{
  90. entryExports: ModuleExports;
  91. csfFiles: CSFFile<TRenderer>[];
  92. }>;
  93. getStoryContext(story: PreparedStory<TRenderer>, { forceInitialArgs }?: {
  94. forceInitialArgs?: boolean | undefined;
  95. }): Omit<StoryContextForLoaders, 'viewMode'>;
  96. cleanupStory(story: PreparedStory<TRenderer>): void;
  97. extract(options?: {
  98. includeDocsOnly?: boolean;
  99. }): Record<StoryId, StoryContextForEnhancers<TRenderer>>;
  100. getSetStoriesPayload(): {
  101. v: number;
  102. globals: _storybook_types.Globals;
  103. globalParameters: {};
  104. kindParameters: Parameters;
  105. stories: Record<string, StoryContextForEnhancers<TRenderer, _storybook_types.Args>>;
  106. };
  107. getStoriesJsonData: () => StoryIndexV3;
  108. getSetIndexPayload(): API_PreparedStoryIndex;
  109. raw(): BoundStory<TRenderer>[];
  110. fromId(storyId: StoryId): BoundStory<TRenderer> | null;
  111. }
  112. export { StoryStore as S, prepareMeta as a, processCSFFile as b, prepareContext as c, StorySpecifier as d, prepareStory as p };