@caido/sdk-frontend 0.41.1-beta.4 → 0.41.1-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caido/sdk-frontend",
3
- "version": "0.41.1-beta.4",
3
+ "version": "0.41.1-beta.5",
4
4
  "description": "Typing for the Caido Frontend SDK",
5
5
  "author": "Caido Labs Inc. <dev@caido.io>",
6
6
  "license": "MIT",
@@ -21,12 +21,35 @@ export type Editor = {
21
21
  * Focus the editor.
22
22
  */
23
23
  focus: () => void;
24
+ /**
25
+ * Get the editor view.
26
+ * @returns The CodeMirror {@link https://codemirror.net/docs/ref/#view.EditorView EditorView}.
27
+ */
28
+ getEditorView: () => EditorView;
24
29
  };
25
30
  export type HTTPRequestEditor = {
31
+ /**
32
+ * Get the editor element.
33
+ * Append this to your DOM to display the editor.
34
+ * @returns The editor element.
35
+ */
26
36
  getElement: () => HTMLElement;
37
+ /**
38
+ * Get the editor view.
39
+ * @returns The CodeMirror {@link https://codemirror.net/docs/ref/#view.EditorView EditorView}.
40
+ */
27
41
  getEditorView: () => EditorView;
28
42
  };
29
43
  export type HTTPResponseEditor = {
44
+ /**
45
+ * Get the editor element.
46
+ * Append this to your DOM to display the editor.
47
+ * @returns The editor element.
48
+ */
30
49
  getElement: () => HTMLElement;
50
+ /**
51
+ * Get the editor view.
52
+ * @returns The CodeMirror {@link https://codemirror.net/docs/ref/#view.EditorView EditorView}.
53
+ */
31
54
  getEditorView: () => EditorView;
32
55
  };
@@ -81,6 +81,7 @@ type SettingsMenuItem = {
81
81
  label: string;
82
82
  /**
83
83
  * The path that the user will be navigated to when the menu item is clicked
84
+ * The path must start with "/settings/".
84
85
  */
85
86
  path: string;
86
87
  /**