Process custom fails (#101)

* zod parse custom command handler outputs to ensure they satisfy expected output

* 1.6.9

Author: dvargas92495

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "smartblocks",
-  "version": "1.6.8",
+  "version": "1.6.9",
   "description": "Create custom and programmable templates from within Roam!",
   "main": "./build/main.js",
   "scripts": {

package.json

@@ -44,6 +44,7 @@ import saveDailyConfig from "./utils/saveDailyConfig";
 import DailyConfigComponent from "./components/DailyConfigComponent";
 import { runDaily } from "./utils/scheduleNextDailyRun";
 import getFullTreeByParentUid from "roamjs-components/queries/getFullTreeByParentUid";
+import { zCommandOutput } from "./utils/zodTypes";
 
 const getLegacy42Setting = (name: string) => {
   const settings = Object.fromEntries(
@@ -280,7 +281,7 @@ export default runExtension(async ({ extensionAPI }) => {
               proccessBlockText,
               processBlock: proccessBlockWithSmartness,
             })(...args);
-            return result;
+            return zCommandOutput.parse(result);
           } catch (e) {
             console.error(e);
             return `Custom Command ${command} Failed: ${(e as Error).message}`;

src/index.ts

@@ -68,6 +68,8 @@ import getDailyConfig from "./getDailyConfig";
 import scheduleNextDailyRun from "./scheduleNextDailyRun";
 import apiPost from "roamjs-components/util/apiPost";
 import deleteBlock from "roamjs-components/writes/deleteBlock";
+import { zCommandOutput } from "./zodTypes";
+import { z } from "zod";
 
 type FormDialogProps = Parameters<typeof FormDialog>[0];
 const renderFormDialog = createOverlayRender<FormDialogProps>(
@@ -415,7 +417,7 @@ const outputTodoBlocks = (
     .map(getFormatter(format, createTagRegex("TODO")));
 };
 
-type CommandOutput = string | string[] | InputTextNode[];
+type CommandOutput = z.infer<typeof zCommandOutput>;
 export type CommandHandler = (
   ...args: string[]
 ) => CommandOutput | Promise<CommandOutput>;

src/utils/core.ts

@@ -0,0 +1,23 @@
+import { InputTextNode } from "roamjs-components/types";
+import { z } from "zod";
+
+const zInputTextNodeBase = z.object({
+  text: z.string(),
+  uid: z.string().optional(),
+  heading: z.number().optional(),
+  textAlign: z.enum(["left", "center", "right", "justify"]).optional(),
+  viewType: z.enum(["document", "bullet", "numbered"]).optional(),
+  open: z.boolean().optional(),
+  props: z.record(z.unknown()).optional(),
+});
+
+// TODO: This should live in roamjs-components
+const zInputTextNode: z.ZodType<InputTextNode> = z.lazy(() =>
+  zInputTextNodeBase.and(
+    z.object({ children: z.array(zInputTextNode).optional() })
+  )
+);
+export const zCommandOutput = z
+  .string()
+  .or(z.string().array())
+  .or(zInputTextNode.array());