GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 15:31:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Move internal Preview types into pacagek

Browse Source
This commit is contained in:
Tom Coleman 2022-11-28 09:57:58 +11:00
parent a9ca2bcb98
commit 6189d76fda
4 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
code/lib/preview-api/src/modules/preview-web/PreviewWithSelection.tsx
View File

@ -24,7 +24,6 @@ import type {
Globals, Globals,
ModuleImportFn, ModuleImportFn,
StoryIndex, StoryIndex,
PreparedStorySpecifier,
ProjectAnnotations, ProjectAnnotations,
StoryId, StoryId,
ViewMode, ViewMode,
@ -39,6 +38,7 @@ import { TemplateDocsRender } from './render/TemplateDocsRender';
import { StandaloneDocsRender } from './render/StandaloneDocsRender'; import { StandaloneDocsRender } from './render/StandaloneDocsRender';
import type { Selection, SelectionStore } from './SelectionStore'; import type { Selection, SelectionStore } from './SelectionStore';
import type { View } from './View'; import type { View } from './View';
import type { StorySpecifier } from '../store/StoryIndexStore';
const globalWindow = globalThis; const globalWindow = globalThis;
@ -447,7 +447,7 @@ export class PreviewWithSelection<TFramework extends Renderer> extends Preview<T
this.channel.emit(STORY_MISSING); this.channel.emit(STORY_MISSING);
} }
renderStoryLoadingException(storySpecifier: PreparedStorySpecifier, err: Error) { renderStoryLoadingException(storySpecifier: StorySpecifier, err: Error) {
// logger.error(`Unable to load story '${storySpecifier}':`); // logger.error(`Unable to load story '${storySpecifier}':`);
logger.error(err); logger.error(err);
this.view.showErrorDisplay(err); this.view.showErrorDisplay(err);

5
code/lib/preview-api/src/modules/preview-web/SelectionStore.ts
View File

@ -1,7 +1,8 @@
import type { PreparedStorySpecifier, ViewMode, Args, StoryId } from '@storybook/types'; import type { ViewMode, Args, StoryId } from '@storybook/types';
import type { StorySpecifier } from '../store/StoryIndexStore';
export interface SelectionSpecifier { export interface SelectionSpecifier {
storySpecifier: PreparedStorySpecifier; storySpecifier: StorySpecifier;
viewMode: ViewMode; viewMode: ViewMode;
args?: Args; args?: Args;
globals?: Args; globals?: Args;

7
code/lib/preview-api/src/modules/store/StoryIndexStore.ts
View File

@ -3,11 +3,14 @@ import type {
IndexEntry, IndexEntry,
Path, Path,
StoryIndex, StoryIndex,
PreparedStorySpecifier,
StoryId, StoryId,
StoryName,
ComponentTitle,
} from '@storybook/types'; } from '@storybook/types';
import memoize from 'memoizerific'; import memoize from 'memoizerific';
export type StorySpecifier = StoryId | { name: StoryName; title: ComponentTitle } | '*';
const getImportPathMap = memoize(1)((entries: StoryIndex['entries']) => const getImportPathMap = memoize(1)((entries: StoryIndex['entries']) =>
Object.values(entries).reduce((acc, entry) => { Object.values(entries).reduce((acc, entry) => {
acc[entry.importPath] = acc[entry.importPath] || entry; acc[entry.importPath] = acc[entry.importPath] || entry;
@ -22,7 +25,7 @@ export class StoryIndexStore {
this.entries = entries; this.entries = entries;
} }
entryFromSpecifier(specifier: PreparedStorySpecifier) { entryFromSpecifier(specifier: StorySpecifier) {
const entries = Object.values(this.entries); const entries = Object.values(this.entries);
if (specifier === '*') { if (specifier === '*') {
// '*' means select the first entry. If there is none, we have no selection. // '*' means select the first entry. If there is none, we have no selection.

7
code/lib/types/src/modules/story.ts
View File

@ -1,4 +1,3 @@
/* eslint-disable @typescript-eslint/naming-convention */
import type { SynchronousPromise } from 'synchronous-promise'; import type { SynchronousPromise } from 'synchronous-promise';
import type { Renderer, ProjectAnnotations as CsfProjectAnnotations } from '@storybook/csf'; import type { Renderer, ProjectAnnotations as CsfProjectAnnotations } from '@storybook/csf';
@ -21,10 +20,6 @@ import type {
StrictGlobalTypes, StrictGlobalTypes,
} from './csf'; } from './csf';
// Internal to preview, exported until preview package consolidation
export type Store_PromiseLike<T> = Promise<T> | SynchronousPromise<T>;
export type PreparedStorySpecifier = StoryId | { name: StoryName; title: ComponentTitle } | '*';
// Store Types // Store Types
export interface WebRenderer extends Renderer { export interface WebRenderer extends Renderer {
canvasElement: HTMLElement; canvasElement: HTMLElement;
@ -32,7 +27,7 @@ export interface WebRenderer extends Renderer {
export type ModuleExport = any; export type ModuleExport = any;
export type ModuleExports = Record<string, ModuleExport>; export type ModuleExports = Record<string, ModuleExport>;
export type ModuleImportFn = (path: Path) => Store_PromiseLike<ModuleExports>; export type ModuleImportFn = (path: Path) => Promise<ModuleExports>;
type MaybePromise<T> = Promise<T> | T; type MaybePromise<T> = Promise<T> | T;
export type TeardownRenderToCanvas = () => MaybePromise<void>; export type TeardownRenderToCanvas = () => MaybePromise<void>;