UNPKG

5.22 kBTypeScriptView Raw
1declare enum events {
2 CHANNEL_WS_DISCONNECT = "channelWSDisconnect",
3 CHANNEL_CREATED = "channelCreated",
4 CONFIG_ERROR = "configError",
5 STORY_INDEX_INVALIDATED = "storyIndexInvalidated",
6 STORY_SPECIFIED = "storySpecified",
7 SET_CONFIG = "setConfig",
8 SET_STORIES = "setStories",
9 SET_INDEX = "setIndex",
10 SET_CURRENT_STORY = "setCurrentStory",
11 CURRENT_STORY_WAS_SET = "currentStoryWasSet",
12 FORCE_RE_RENDER = "forceReRender",
13 FORCE_REMOUNT = "forceRemount",
14 PRELOAD_ENTRIES = "preloadStories",
15 STORY_PREPARED = "storyPrepared",
16 DOCS_PREPARED = "docsPrepared",
17 STORY_CHANGED = "storyChanged",
18 STORY_UNCHANGED = "storyUnchanged",
19 STORY_RENDERED = "storyRendered",
20 STORY_MISSING = "storyMissing",
21 STORY_ERRORED = "storyErrored",
22 STORY_THREW_EXCEPTION = "storyThrewException",
23 STORY_RENDER_PHASE_CHANGED = "storyRenderPhaseChanged",
24 PLAY_FUNCTION_THREW_EXCEPTION = "playFunctionThrewException",
25 UNHANDLED_ERRORS_WHILE_PLAYING = "unhandledErrorsWhilePlaying",
26 UPDATE_STORY_ARGS = "updateStoryArgs",
27 STORY_ARGS_UPDATED = "storyArgsUpdated",
28 RESET_STORY_ARGS = "resetStoryArgs",
29 SET_GLOBALS = "setGlobals",
30 UPDATE_GLOBALS = "updateGlobals",
31 GLOBALS_UPDATED = "globalsUpdated",
32 REGISTER_SUBSCRIPTION = "registerSubscription",
33 PREVIEW_KEYDOWN = "previewKeydown",
34 PREVIEW_BUILDER_PROGRESS = "preview_builder_progress",
35 SELECT_STORY = "selectStory",
36 STORIES_COLLAPSE_ALL = "storiesCollapseAll",
37 STORIES_EXPAND_ALL = "storiesExpandAll",
38 DOCS_RENDERED = "docsRendered",
39 SHARED_STATE_CHANGED = "sharedStateChanged",
40 SHARED_STATE_SET = "sharedStateSet",
41 NAVIGATE_URL = "navigateUrl",
42 UPDATE_QUERY_PARAMS = "updateQueryParams",
43 REQUEST_WHATS_NEW_DATA = "requestWhatsNewData",
44 RESULT_WHATS_NEW_DATA = "resultWhatsNewData",
45 SET_WHATS_NEW_CACHE = "setWhatsNewCache",
46 TOGGLE_WHATS_NEW_NOTIFICATIONS = "toggleWhatsNewNotifications",
47 TELEMETRY_ERROR = "telemetryError"
48}
49
50declare const CHANNEL_WS_DISCONNECT: events;
51declare const CHANNEL_CREATED: events;
52declare const CONFIG_ERROR: events;
53declare const CURRENT_STORY_WAS_SET: events;
54declare const DOCS_PREPARED: events;
55declare const DOCS_RENDERED: events;
56declare const FORCE_RE_RENDER: events;
57declare const FORCE_REMOUNT: events;
58declare const GLOBALS_UPDATED: events;
59declare const NAVIGATE_URL: events;
60declare const PLAY_FUNCTION_THREW_EXCEPTION: events;
61declare const UNHANDLED_ERRORS_WHILE_PLAYING: events;
62declare const PRELOAD_ENTRIES: events;
63declare const PREVIEW_BUILDER_PROGRESS: events;
64declare const PREVIEW_KEYDOWN: events;
65declare const REGISTER_SUBSCRIPTION: events;
66declare const RESET_STORY_ARGS: events;
67declare const SELECT_STORY: events;
68declare const SET_CONFIG: events;
69declare const SET_CURRENT_STORY: events;
70declare const SET_GLOBALS: events;
71declare const SET_INDEX: events;
72declare const SET_STORIES: events;
73declare const SHARED_STATE_CHANGED: events;
74declare const SHARED_STATE_SET: events;
75declare const STORIES_COLLAPSE_ALL: events;
76declare const STORIES_EXPAND_ALL: events;
77declare const STORY_ARGS_UPDATED: events;
78declare const STORY_CHANGED: events;
79declare const STORY_ERRORED: events;
80declare const STORY_INDEX_INVALIDATED: events;
81declare const STORY_MISSING: events;
82declare const STORY_PREPARED: events;
83declare const STORY_RENDER_PHASE_CHANGED: events;
84declare const STORY_RENDERED: events;
85declare const STORY_SPECIFIED: events;
86declare const STORY_THREW_EXCEPTION: events;
87declare const STORY_UNCHANGED: events;
88declare const UPDATE_GLOBALS: events;
89declare const UPDATE_QUERY_PARAMS: events;
90declare const UPDATE_STORY_ARGS: events;
91declare const REQUEST_WHATS_NEW_DATA: events;
92declare const RESULT_WHATS_NEW_DATA: events;
93declare const SET_WHATS_NEW_CACHE: events;
94declare const TOGGLE_WHATS_NEW_NOTIFICATIONS: events;
95declare const TELEMETRY_ERROR: events;
96interface WhatsNewCache {
97 lastDismissedPost?: string;
98 lastReadPost?: string;
99}
100type WhatsNewData = {
101 status: 'SUCCESS';
102 title: string;
103 url: string;
104 blogUrl?: string;
105 publishedAt: string;
106 excerpt: string;
107 postIsRead: boolean;
108 showNotification: boolean;
109 disableWhatsNewNotifications: boolean;
110} | {
111 status: 'ERROR';
112};
113
114export { CHANNEL_CREATED, CHANNEL_WS_DISCONNECT, CONFIG_ERROR, CURRENT_STORY_WAS_SET, DOCS_PREPARED, DOCS_RENDERED, FORCE_REMOUNT, FORCE_RE_RENDER, GLOBALS_UPDATED, NAVIGATE_URL, PLAY_FUNCTION_THREW_EXCEPTION, PRELOAD_ENTRIES, PREVIEW_BUILDER_PROGRESS, PREVIEW_KEYDOWN, REGISTER_SUBSCRIPTION, REQUEST_WHATS_NEW_DATA, RESET_STORY_ARGS, RESULT_WHATS_NEW_DATA, SELECT_STORY, SET_CONFIG, SET_CURRENT_STORY, SET_GLOBALS, SET_INDEX, SET_STORIES, SET_WHATS_NEW_CACHE, SHARED_STATE_CHANGED, SHARED_STATE_SET, STORIES_COLLAPSE_ALL, STORIES_EXPAND_ALL, STORY_ARGS_UPDATED, STORY_CHANGED, STORY_ERRORED, STORY_INDEX_INVALIDATED, STORY_MISSING, STORY_PREPARED, STORY_RENDERED, STORY_RENDER_PHASE_CHANGED, STORY_SPECIFIED, STORY_THREW_EXCEPTION, STORY_UNCHANGED, TELEMETRY_ERROR, TOGGLE_WHATS_NEW_NOTIFICATIONS, UNHANDLED_ERRORS_WHILE_PLAYING, UPDATE_GLOBALS, UPDATE_QUERY_PARAMS, UPDATE_STORY_ARGS, WhatsNewCache, WhatsNewData, events as default };