Templated datalog queries

package.json

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

src/components/FormDialog.tsx

@@ -25,7 +25,7 @@ import MenuItemSelect from "./MenuItemSelect";
 import PageInput from "./PageInput";
 import nanoid from "nanoid";
 import { getUids } from "../dom";
-import { InputTextNode, PullBlock } from "../types";
+import { InputTextNode } from "../types";
 import getFullTreeByParentUid from "../queries/getFullTreeByParentUid";
 import createPage from "../writes/createPage";
 import { createBlock } from "../writes";
@@ -174,7 +174,7 @@ const EmbedInput = ({
             window.roamAlphaAPI.pull(
               "[:block/order {:block/parents [:block/uid]}]",
               [":block/uid", blockUid]
-            ) as PullBlock;
+            );
           if (
             !(
               order === 0 &&

src/queries/getAllBlockUids.ts

@@ -1,6 +1,6 @@
 const getAllBlockUids = (): string[] =>
   window.roamAlphaAPI
-    .q(`[:find ?u :where [?e :block/uid ?u] [?e :block/string]]`)
-    .map((f) => f[0] as string);
+    .q<[string]>(`[:find ?u :where [?e :block/uid ?u] [?e :block/string]]`)
+    .map((f) => f[0]);
 
 export default getAllBlockUids;

src/queries/getAllBlockUidsAndTexts.ts

@@ -1,6 +1,8 @@
 const getAllBlockUidsAndTexts = (): { uid: string; text: string }[] =>
   window.roamAlphaAPI
-    .q(`[:find ?u ?s :where [?e :block/uid ?u] [?e :block/string ?s]]`)
-    .map((f) => ({ uid: f[0] as string, text: f[1] as string }));
+    .q<[string, string]>(
+      `[:find ?u ?s :where [?e :block/uid ?u] [?e :block/string ?s]]`
+    )
+    .map((f) => ({ uid: f[0], text: f[1] }));
 
 export default getAllBlockUidsAndTexts;

src/queries/getAllPageNames.ts

@@ -1,6 +1,6 @@
 const getAllPageNames = (): string[] =>
   window.roamAlphaAPI
-    .q("[:find ?s :where [?e :node/title ?s]]")
-    .map((b) => b[0] as string);
+    .q<[string]>("[:find ?s :where [?e :node/title ?s]]")
+    .map((b) => b[0]);
 
 export default getAllPageNames;

src/queries/getAttributeValueByBlockAndName.ts

@@ -1,4 +1,4 @@
-import { PullBlock } from "../types";
+import type { PullBlock } from "../types";
 import normalizePageTitle from "./normalizePageTitle";
 
 const getAttributeValueByBlockAndName = ({
@@ -9,13 +9,11 @@ const getAttributeValueByBlockAndName = ({
   uid: string;
 }) =>
   (
-    (
-      window.roamAlphaAPI.data.fast.q(
-        `[:find (pull ?b [:block/string]) :where [?a :node/title "${normalizePageTitle(
-          name
-        )}"] [?p :block/uid "${uid}"] [?b :block/refs ?a] [?b :block/parents ?p]]`
-      )?.[0]?.[0] as PullBlock
-    )?.[":block/string"] || ""
+    window.roamAlphaAPI.data.fast.q<[PullBlock]>(
+      `[:find (pull ?b [:block/string]) :where [?a :node/title "${normalizePageTitle(
+        name
+      )}"] [?p :block/uid "${uid}"] [?b :block/refs ?a] [?b :block/parents ?p]]`
+    )?.[0]?.[0]?.[":block/string"] || ""
   )
     .slice(name.length + 2)
     .trim();

src/queries/getBasicTreeByParentUid.ts

@@ -12,10 +12,10 @@ const sortBasicNodes = (c: PullBlock[]): RoamBasicNode[] =>
 const getBasicTreeByParentUid = (uid: string): RoamBasicNode[] =>
   sortBasicNodes(
     window.roamAlphaAPI.data.fast
-      .q(
+      .q<[PullBlock]>(
         `[:find (pull ?c [:block/string :block/uid :block/order {:block/children ...}]) :where [?b :block/uid "${uid}"] [?b :block/children ?c]]`
       )
-      .map((a) => a[0] as PullBlock)
+      .map((a) => a[0])
   );
 
 export default getBasicTreeByParentUid;

src/queries/getBlockUidAndTextIncludingText.ts

@@ -3,13 +3,13 @@ import { PullBlock } from "../types";
 const getBlockUidAndTextIncludingText = (
   t: string
 ): { uid: string; text: string }[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?block [:block/uid :block/string]) :where [?block :block/string ?contents] [(clojure.string/includes? ?contents  "${t}")]]`
-    ) as [PullBlock][]
-  ).map(([block]) => ({
-    uid: block[":block/uid"] || "",
-    text: block[":block/string"] || "",
-  }));
+    )
+    .map(([block]) => ({
+      uid: block[":block/uid"] || "",
+      text: block[":block/string"] || "",
+    }));
 
 export default getBlockUidAndTextIncludingText;

src/queries/getBlockUidByTextOnPage.ts

@@ -5,8 +5,8 @@ const getBlockUidByTextOnPage = ({
   text: string;
   title: string;
 }): string =>
-  (window.roamAlphaAPI.q(
+  window.roamAlphaAPI.q<[string]>(
     `[:find ?u :where [?b :block/page ?p] [?b :block/uid ?u] [?b :block/string "${text}"] [?p :node/title "${title}"]]`
-  )?.[0]?.[0] as string) || "";
+  )?.[0]?.[0] || "";
 
 export default getBlockUidByTextOnPage;

src/queries/getBlockUidsAndTextsReferencingPage.ts

@@ -4,15 +4,15 @@ import normalizePageTitle from "./normalizePageTitle";
 const getBlockUidsAndTextsReferencingPage = (
   title: string
 ): { uid: string; text: string }[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?r [:block/uid :block/string]) :where [?p :node/title "${normalizePageTitle(
         title
       )}"] [?r :block/refs ?p]]`
-    ) as [PullBlock][]
-  ).map(([node]) => ({
-    uid: node[":block/uid"] || "",
-    text: node[":block/string"] || "",
-  }));
+    )
+    .map(([node]) => ({
+      uid: node[":block/uid"] || "",
+      text: node[":block/string"] || "",
+    }));
 
 export default getBlockUidsAndTextsReferencingPage;

src/queries/getBlockUidsByPageTitle.ts

@@ -2,11 +2,11 @@ import normalizePageTitle from "./normalizePageTitle";
 
 const getBlockUidsByPageTitle = (title: string): string[] =>
   window.roamAlphaAPI
-    .q(
+    .q<[string]>(
       `[:find ?u :where  [?b :block/uid ?u] [?b :block/page ?e] [?e :node/title "${normalizePageTitle(
         title
       )}"]]`
     )
-    .map((b) => b[0] as string);
+    .map((b) => b[0]);
 
 export default getBlockUidsByPageTitle;

src/queries/getBlockUidsReferencingBlock.ts

@@ -1,10 +1,10 @@
 import { PullBlock } from "../types";
 
 const getBlockUidsReferencingBlock = (uid: string): string[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?r [:block/uid]) :where [?b :block/uid "${uid}"] [?r :block/refs ?b]]`
-    ) as [PullBlock][]
-  ).map((s) => s[0][":block/uid"] || "");
+    )
+    .map((s) => s[0][":block/uid"] || "");
 
 export default getBlockUidsReferencingBlock;

src/queries/getBlockUidsReferencingPage.ts

@@ -2,12 +2,12 @@ import { PullBlock } from "../types";
 import normalizePageTitle from "./normalizePageTitle";
 
 const getBlockUidsReferencingPage = (title: string): string[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?r [:block/uid]) :where [?p :node/title "${normalizePageTitle(
         title
       )}"] [?r :block/refs ?p]]`
-    ) as [PullBlock][]
-  ).map((s) => s[0][":block/uid"] || "");
+    )
+    .map((s) => s[0][":block/uid"] || "");
 
 export default getBlockUidsReferencingPage;

src/queries/getBlockUidsWithParentUid.ts

@@ -1,10 +1,8 @@
-
-
 const getBlockUidsWithParentUid = (uid: string): string[] =>
   window.roamAlphaAPI
-    .q(
+    .q<[string]>(
       `[:find ?u :where [?c :block/uid ?u] [?c :block/parents ?b] [?b :block/uid "${uid}"]]`
     )
-    .map((r) => r[0] as string);
+    .map((r) => r[0]);
 
 export default getBlockUidsWithParentUid;

src/queries/getDisplayNameByEmail.ts

@@ -1,6 +1,6 @@
 const getDisplayNameByEmail = (email: string): string =>
-  (window.roamAlphaAPI.q(
+  window.roamAlphaAPI.q<[string]>(
     `[:find ?name :where[?e :user/display-name ?name] [?e :user/email "${email}"]]`
-  )?.[0]?.[0] as string) || "";
+  )?.[0]?.[0] || "";
 
 export default getDisplayNameByEmail;

src/queries/getDisplayNameByUid.ts

@@ -1,6 +1,6 @@
 const getDisplayNameByUid = (uid: string): string =>
-  (window.roamAlphaAPI.q(
+  window.roamAlphaAPI.q<[string]>(
     `[:find ?s :where [?e :user/uid "${uid}"] [?e :user/display-page ?p] [?p :node/title ?s]]`
-  )?.[0]?.[0] as string) || "";
+  )?.[0]?.[0] || "";
 
 export default getDisplayNameByUid;

src/queries/getEditedUserEmailByBlockUid.ts

@@ -1,6 +1,6 @@
 const getEditedUserEmailByBlockUid = (blockUid: string): string =>
-  (window.roamAlphaAPI.q(
+  window.roamAlphaAPI.q<[string]>(
     `[:find ?e :where [?u :user/email ?e] [?b :edit/user ?u] [?b :block/uid "${blockUid}"]]`
-  )?.[0]?.[0] as string) || "";
+  )?.[0]?.[0] || "";
 
 export default getEditedUserEmailByBlockUid;

src/queries/getFirstChildTextByBlockUid.ts

@@ -1,8 +1,6 @@
-
-
 const getFirstChildTextByBlockUid = (blockUid: string): string =>
-  window.roamAlphaAPI.q(
+  window.roamAlphaAPI.q<[string]>(
     `[:find ?s :where [?c :block/string ?s] [?c :block/order 0] [?p :block/children ?c] [?p :block/uid "${blockUid}"]]`
-  )?.[0]?.[0] as string;
+  )?.[0]?.[0];
 
 export default getFirstChildTextByBlockUid;

src/queries/getLinkedPageTitlesUnderUid.ts

@@ -1,8 +1,8 @@
 const getLinkedPageTitlesUnderUid = (uid: string): string[] =>
   window.roamAlphaAPI
-    .q(
+    .q<[string]>(
       `[:find ?t :where [?r :node/title ?t] [?c :block/refs ?r] [?c :block/parents ?b] [?b :block/uid "${uid}"]]`
     )
-    .map((r) => r[0] as string);
+    .map((r) => r[0]);
 
 export default getLinkedPageTitlesUnderUid;

src/queries/getNthChildUidByBlockUid.ts

@@ -7,10 +7,8 @@ const getNthChildUidByBlockUid = ({
   blockUid: string;
   order: number;
 }): string =>
-  (
-    window.roamAlphaAPI.data.fast.q(
-      `[:find (pull ?c [:block/uid]) :where [?p :block/uid "${blockUid}"] [?p :block/children ?c] [?c :block/order ${order}] ]`
-    )?.[0]?.[0] as PullBlock
-  )?.[":block/uid"] || "";
+  window.roamAlphaAPI.data.fast.q<[PullBlock]>(
+    `[:find (pull ?c [:block/uid]) :where [?p :block/uid "${blockUid}"] [?p :block/children ?c] [?c :block/order ${order}] ]`
+  )?.[0]?.[0]?.[":block/uid"] || "";
 
 export default getNthChildUidByBlockUid;

src/queries/getOrderByBlockUid.ts

@@ -1,6 +1,6 @@
 const getOrderByBlockUid = (blockUid: string): number =>
-  window.roamAlphaAPI.q(
+  window.roamAlphaAPI.q<[number]>(
     `[:find ?o :where [?r :block/order ?o] [?r :block/uid "${blockUid}"]]`
-  )?.[0]?.[0] as number;
+  )?.[0]?.[0];
 
 export default getOrderByBlockUid;

src/queries/getPageTitleByBlockUid.ts

@@ -1,8 +1,6 @@
 const getPageTitleByBlockUid = (blockUid: string): string =>
-  (
-    window.roamAlphaAPI.q(
-      `[:find (pull ?p [:node/title]) :where [?e :block/uid "${blockUid}"] [?e :block/page ?p]]`
-    )?.[0]?.[0] as { title?: string }
-  )?.title || "";
+  window.roamAlphaAPI.q<[{ title: string }]>(
+    `[:find (pull ?p [:node/title]) :where [?e :block/uid "${blockUid}"] [?e :block/page ?p]]`
+  )?.[0]?.[0]?.title || "";
 
 export default getPageTitleByBlockUid;

src/queries/getPageTitleByPageUid.ts

@@ -1,11 +1,6 @@
-import { PullBlock } from "../types";
-
 export const getPageTitleByPageUid = (pageUid: string): string =>
-  (
-    window.roamAlphaAPI.pull(`[:node/title]`, [
-      ":block/uid",
-      pageUid,
-    ]) as PullBlock
-  )?.[":node/title"] || "";
+  window.roamAlphaAPI.pull(`[:node/title]`, [":block/uid", pageUid])?.[
+    ":node/title"
+  ] || "";
 
 export default getPageTitleByPageUid;

src/queries/getPageTitleReferencesByPageTitle.ts

@@ -1,13 +1,13 @@
-import { PullBlock } from "../types";
+import type { PullBlock } from "../types";
 import normalizePageTitle from "./normalizePageTitle";
 
 const getPageTitleReferencesByPageTitle = (title: string): string[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?b [:node/title]) :where [?r :node/title "${normalizePageTitle(
         title
       )}"] [?c :block/refs ?r] [?c :block/page ?b]]`
-    ) as [PullBlock][]
-  ).map((p) => p[0][":node/title"] as string);
+    )
+    .map((p) => p[0][":node/title"] || "");
 
 export default getPageTitleReferencesByPageTitle;

src/queries/getPageTitlesAndBlockUidsReferencingPage.ts

@@ -1,18 +1,18 @@
-import { PullBlock } from "../types";
+import type { PullBlock } from "../types";
 import normalizePageTitle from "./normalizePageTitle";
 
 const getPageTitlesAndBlockUidsReferencingPage = (
   pageName: string
 ): { title: string; uid: string }[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock, PullBlock]>(
       `[:find (pull ?pr [:node/title]) (pull ?r [:block/uid]) :where [?p :node/title "${normalizePageTitle(
         pageName
       )}"] [?r :block/refs ?p] [?r :block/page ?pr]]`
-    ) as [PullBlock, PullBlock][]
-  ).map(([pr, r]) => ({
-    title: pr?.[":node/title"] || "",
-    uid: r?.[":block/uid"] || "",
-  }));
+    )
+    .map(([pr, r]) => ({
+      title: pr[":node/title"] || "",
+      uid: r[":block/uid"] || "",
+    }));
 
 export default getPageTitlesAndBlockUidsReferencingPage;

src/queries/getPageTitlesAndUidsDirectlyReferencingPage.ts

@@ -4,15 +4,15 @@ import normalizePageTitle from "./normalizePageTitle";
 const getPageTitlesAndUidsDirectlyReferencingPage = (
   pageName: string
 ): { title: string; uid: string }[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?r [:node/title :block/uid]) :where [?p :node/title "${normalizePageTitle(
         pageName
       )}"] [?r :block/refs ?p]]`
-    ) as [PullBlock][]
-  ).map(([block]) => ({
-    title: block[":node/title"] || "",
-    uid: block[":block/uid"] || "",
-  }));
+    )
+    .map(([block]) => ({
+      title: block[":node/title"] || "",
+      uid: block[":block/uid"] || "",
+    }));
 
 export default getPageTitlesAndUidsDirectlyReferencingPage;

src/queries/getPageTitlesReferencingBlockUid.ts

@@ -1,10 +1,10 @@
-import { PullBlock } from "../types";
+import type { PullBlock } from "../types";
 
 const getPageTitlesReferencingBlockUid = (uid: string): string[] =>
-  (
-    window.roamAlphaAPI.data.fast.q(
+  window.roamAlphaAPI.data.fast
+    .q<[PullBlock]>(
       `[:find (pull ?p [:node/title]) :where [?r :block/uid "${uid}"] [?b :block/refs ?r] [?b :block/page ?p]]`
-    ) as [PullBlock][]
-  ).map((s) => s[0]?.[":node/title"] || "");
+    )
+    .map((s) => s[0]?.[":node/title"] || "");
 
 export default getPageTitlesReferencingBlockUid;