Update roamAlphaAPI types (#45)

* chore(types): update roamAlphaAPI

* chore(types): refine type definitions and improve consistency

* .

* chore(types): simplify SidebarAction types and update SidebarWindowInput structure

* 0.85.4

Author: mdroidian

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "roamjs-components",
   "description": "Expansive toolset, utilities, & components for developing RoamJS extensions.",
-  "version": "0.85.3",
+  "version": "0.85.4",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {

package.json

@@ -107,10 +107,31 @@ declare global {
           update: WriteAction;
           move: WriteAction;
           delete: WriteAction;
+          reorderBlocks: (args: {
+            location: { "parent-uid": string };
+            blocks: string[];
+          }) => Promise<void>;
         };
         fast: {
           q: (query: string, ...params: unknown[]) => unknown[][];
         };
+        async: {
+          q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;
+          pull: (
+            selector: string,
+            id: number | string | [string, string]
+          ) => Promise<PullBlock>;
+          pull_many: (
+            pattern: string,
+            eids: string[][]
+          ) => Promise<PullBlock[]>;
+          fast: {
+            q: (query: string, ...params: unknown[]) => Promise<unknown[][]>;
+          };
+        };
+        backend: {
+          q: (query: string, ...params: unknown[]) => unknown[][];
+        };
         page: {
           create: WriteAction;
           update: WriteAction;
@@ -120,7 +141,7 @@ declare global {
           selector: string,
           id: number | string | [string, string]
         ) => PullBlock;
-        pull_many: (pattern: string, eid: string[][]) => PullBlock[];
+        pull_many: (pattern: string, eids: string[][]) => PullBlock[];
         q: (query: string, ...params: unknown[]) => unknown[][];
         removePullWatch: (
           pullPattern: string,
@@ -143,11 +164,12 @@ declare global {
           close: () => Promise<void>;
           getWindows: () => SidebarWindow[];
           addWindow: SidebarAction;
-          setWindowOrder: (action: {
-            window: SidebarWindowInput & { order: number };
-          }) => Promise<void>;
+          setWindowOrder: SidebarAction;
           collapseWindow: SidebarAction;
-          pinWindow: SidebarAction;
+          pinWindow: (action: {
+            window: SidebarWindowInput;
+            "pin-to-top?"?: boolean;
+          }) => Promise<void>;
           expandWindow: SidebarAction;
           removeWindow: SidebarAction;
           unpinWindow: SidebarAction;
@@ -156,6 +178,8 @@ declare global {
           addCommand: (action: {
             label: string;
             callback: () => void;
+            "disable-hotkey"?: boolean;
+            "default-hotkey"?: string | string[];
           }) => Promise<void>;
           removeCommand: (action: { label: string }) => Promise<void>;
         };
@@ -173,6 +197,56 @@ declare global {
           }) => void;
           removeCommand: (action: { label: string }) => void;
         };
+        individualMultiselect: {
+          getSelectedUids: () => string[];
+        };
+        msContextMenu: {
+          addCommand: (action: {
+            label: string;
+            callback: () => void;
+            "display-conditional"?: () => boolean;
+          }) => void;
+          removeCommand: (action: { label: string }) => void;
+        };
+        filters: {
+          addGlobalFilter: (args: {
+            title: string;
+            type: "includes" | "removes";
+          }) => Promise<void>;
+          removeGlobalFilter: (args: {
+            title: string;
+            type: "includes" | "removes";
+          }) => Promise<void>;
+          getGlobalFilters: () => { includes: string[]; removes: string[] };
+          getPageFilters: (args: {
+            page: { uid?: string; title?: string };
+          }) => {
+            includes: string[];
+            removes: string[];
+          };
+          getPageLinkedRefsFilters: (args: {
+            page: { uid?: string; title?: string };
+          }) => {
+            includes: string[];
+            removes: string[];
+          };
+          getSidebarWindowFilters: (args: { window: SidebarWindowInput }) => {
+            includes: string[];
+            removes: string[];
+          };
+          setPageFilters: (args: {
+            page: { uid?: string; title?: string };
+            filters: { includes?: string[]; removes?: string[] };
+          }) => Promise<void>;
+          setPageLinkedRefsFilters: (args: {
+            page: { uid?: string; title?: string };
+            filters: { includes?: string[]; removes?: string[] };
+          }) => Promise<void>;
+          setSidebarWindowFilters: (args: {
+            window: SidebarWindowInput;
+            filters: { includes?: string[]; removes?: string[] };
+          }) => Promise<void>;
+        };
         getFocusedBlock: () => null | {
           "window-id": string;
           "block-uid": string;
@@ -181,15 +255,36 @@ declare global {
           renderBlock: (args: {
             uid: string;
             el: HTMLElement;
-            zoomPath?: boolean;
+            "zoom-path?"?: boolean;
+            // "open?"?: boolean; Not available yet in the API
           }) => null;
           renderPage: (args: {
             uid: string;
             el: HTMLElement;
-            hideMentions?: boolean;
+            "hide-mentions?"?: boolean;
           }) => null;
+          renderSearch: (args: {
+            "search-query-str": string;
+            el: HTMLElement;
+            "closed?"?: boolean;
+            "group-by-page?"?: boolean;
+            "hide-paths?"?: boolean;
+            "config-changed-callback"?: (config: unknown) => void;
+          }) => null;
+          // renderString: (args: { string: string; el: HTMLElement }) => null; Not available yet in the API
+          unmountNode: (args: { el: HTMLElement }) => void;
         };
         graphView: {
+          addCallback: (props: {
+            label: string;
+            callback: (context: {
+              cytoscape: unknown;
+              elements: unknown[];
+              type: "page" | "all-pages";
+            }) => void;
+            type?: "page" | "all-pages";
+          }) => Promise<void>;
+          removeCallback: (props: { label: string }) => Promise<void>;
           wholeGraph: {
             addCallback: (props: {
               label: string;
@@ -228,6 +323,20 @@ declare global {
         type: "hosted" | "offline";
         isEncrypted: boolean;
       };
+      file: {
+        upload: (args: {
+          file: File;
+          toast?: { hide: boolean };
+        }) => Promise<string>;
+        get: (args: { url: string }) => Promise<File>;
+        delete: (args: { url: string }) => Promise<void>;
+      };
+      user: {
+        uid: () => string | null;
+      };
+      constants: {
+        corsAnywhereProxyUrl: string;
+      };
     };
 
     // roamjs namespace should only be used for methods that must be accessed across extension scripts

src/types/index.ts

@@ -371,11 +371,12 @@ type SidebarWindowType =
   | SidebarBlockWindow
   | SidebarMentionsWindow
   | SidebarGraphWindow
-  | SidebarOutlineWindow;
+  | SidebarOutlineWindow
+  | SidebarSearchQueryWindow;
 
 export type SidebarWindowInput = {
-  "block-uid": string;
   type: SidebarWindowType["type"];
+  order?: number;
 };
 
 type SidebarBlockWindow = {
@@ -399,6 +400,11 @@ type SidebarGraphWindow = {
   "block-uid": string;
 };
 
+type SidebarSearchQueryWindow = {
+  type: "search-query";
+  "search-query-uid": string;
+};
+
 export type SidebarAction = (action: {
   window: SidebarWindowInput;
 }) => Promise<void>;