UNPKG

1.54 kBTypeScriptView Raw
1import { StoriesRaw, StoryInput, StoriesHash } from '../lib/stories';
2import { ModuleFn } from '../index';
3export interface SubState {
4 refs: Refs;
5}
6declare type Versions = Record<string, string>;
7export declare type SetRefData = Partial<Omit<ComposedRef, 'stories'> & {
8 stories?: StoriesRaw;
9}>;
10export interface SubAPI {
11 findRef: (source: string) => ComposedRef;
12 setRef: (id: string, data: SetRefData, ready?: boolean) => void;
13 updateRef: (id: string, ref: ComposedRefUpdate) => void;
14 getRefs: () => Refs;
15 checkRef: (ref: SetRefData) => Promise<void>;
16 changeRefVersion: (id: string, url: string) => void;
17 changeRefState: (id: string, ready: boolean) => void;
18}
19export declare type StoryMapper = (ref: ComposedRef, story: StoryInput) => StoryInput;
20export interface ComposedRef {
21 id: string;
22 title?: string;
23 url: string;
24 type?: 'auto-inject' | 'unknown' | 'lazy' | 'server-checked';
25 stories: StoriesHash;
26 versions?: Versions;
27 loginUrl?: string;
28 version?: string;
29 ready?: boolean;
30 error?: any;
31}
32export declare type ComposedRefUpdate = Partial<Pick<ComposedRef, 'title' | 'type' | 'stories' | 'versions' | 'loginUrl' | 'version' | 'ready' | 'error'>>;
33export declare type Refs = Record<string, ComposedRef>;
34export declare type RefId = string;
35export declare type RefUrl = string;
36export declare const getSourceType: (source: string, refId: string) => string[];
37export declare const defaultStoryMapper: StoryMapper;
38export declare const init: ModuleFn;
39export {};