UNPKG

1.59 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 v: number;
9 stories?: StoriesRaw;
10}>;
11export interface SubAPI {
12 findRef: (source: string) => ComposedRef;
13 setRef: (id: string, data: SetRefData, ready?: boolean) => void;
14 updateRef: (id: string, ref: ComposedRefUpdate) => void;
15 getRefs: () => Refs;
16 checkRef: (ref: SetRefData) => Promise<void>;
17 changeRefVersion: (id: string, url: string) => void;
18 changeRefState: (id: string, ready: boolean) => void;
19}
20export declare type StoryMapper = (ref: ComposedRef, story: StoryInput) => StoryInput;
21export interface ComposedRef {
22 id: string;
23 title?: string;
24 url: string;
25 type?: 'auto-inject' | 'unknown' | 'lazy' | 'server-checked';
26 expanded?: boolean;
27 stories: StoriesHash;
28 versions?: Versions;
29 loginUrl?: string;
30 version?: string;
31 ready?: boolean;
32 error?: any;
33}
34export declare type ComposedRefUpdate = Partial<Pick<ComposedRef, 'title' | 'type' | 'expanded' | 'stories' | 'versions' | 'loginUrl' | 'version' | 'ready' | 'error'>>;
35export declare type Refs = Record<string, ComposedRef>;
36export declare type RefId = string;
37export declare type RefUrl = string;
38export declare const getSourceType: (source: string, refId: string) => string[];
39export declare const defaultStoryMapper: StoryMapper;
40export declare const init: ModuleFn;
41export {};