index.d.ts 4.9 KB

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