roamjs-components 0.57.2 → 0.57.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "roamjs-components",
   "description": "Description for roamjs-components",
-  "version": "0.57.2",
+  "version": "0.57.4",
   "main": "index.js",
   "types": "index.d.ts",
   "scripts": {

package/types/index.d.ts

@@ -1,331 +1,8 @@
 /// <reference types="react" />
+import { ClientParams, DatalogClause, PullBlock, RoamBasicNode, RoamBlock, SidebarAction, SidebarWindow, SidebarWindowInput, WriteAction } from "./native";
 import { Condition as QueryBuilderCondition, Selection as QueryBuilderSelection, Result as QueryBuilderResult, ExportTypes } from "./query-builder";
-declare type CommandOutput = string | string[] | InputTextNode[];
-export declare type CommandHandler = (...args: string[]) => CommandOutput | Promise<CommandOutput>;
-export declare type DatalogFnArg = DatalogSrcVar | DatalogVariable | DatalogConstant;
-export declare type DatalogSrcVar = {
-    type: "src-var";
-    value: string;
-};
-export declare type DatalogVariable = {
-    type: "variable";
-    value: string;
-};
-export declare type DatalogAndClause = {
-    type: "and-clause";
-    clauses: DatalogClause[];
-};
-export declare type DatalogExpressionClause = DatalogDataPattern | DatalogPredExpr | DatalogFnExpr | DatalogRuleExpr;
-export declare type DatalogRuleExpr = {
-    type: "rule-expr";
-    srcVar?: DatalogSrcVar;
-    ruleName: DatalogRuleName;
-    arguments: DatalogArgument[];
-};
-export declare type DatalogNotClause = {
-    type: "not-clause";
-    srcVar?: DatalogSrcVar;
-    clauses: DatalogClause[];
-};
-export declare type DatalogNotJoinClause = {
-    type: "not-join-clause";
-    srcVar?: DatalogSrcVar;
-    variables: DatalogVariable[];
-    clauses: DatalogClause[];
-};
-export declare type DatalogOrClause = {
-    type: "or-clause";
-    srcVar?: DatalogSrcVar;
-    clauses: (DatalogClause | DatalogAndClause)[];
-};
-export declare type DatalogOrJoinClause = {
-    type: "or-join-clause";
-    srcVar?: DatalogSrcVar;
-    variables: DatalogVariable[];
-    clauses: (DatalogClause | DatalogAndClause)[];
-};
-export declare type DatalogClause = DatalogNotClause | DatalogOrJoinClause | DatalogExpressionClause | DatalogOrClause | DatalogNotJoinClause;
-export declare type DatalogDataPattern = {
-    type: "data-pattern";
-    srcVar?: DatalogSrcVar;
-    arguments: DatalogArgument[];
-};
-export declare type DatalogArgument = DatalogVariable | DatalogConstant | DatalogUnderscore;
-export declare type DatalogConstant = {
-    type: "constant";
-    value: string;
-};
-export declare type DatalogPredExpr = {
-    type: "pred-expr";
-    pred: "<" | ">" | "re-matches" | "re-find" | "clojure.string/includes?" | "clojure.string/ends-with?" | "clojure.string/starts-with?";
-    arguments: DatalogFnArg[];
-};
-export declare type DatalogFnExpr = {
-    type: "fn-expr";
-    fn: "re-pattern";
-    arguments: DatalogFnArg[];
-    binding: DatalogBinding;
-};
-export declare type DatalogBinding = DatalogBindScalar | DatalogBindTuple | DatalogBindColl | DatalogBindRel;
-export declare type DatalogBindScalar = {
-    type: "bind-scalar";
-    variable: DatalogVariable;
-};
-export declare type DatalogBindTuple = {
-    type: "bind-tuple";
-    args: (DatalogVariable | DatalogUnderscore)[];
-};
-export declare type DatalogBindColl = {
-    type: "bind-col";
-    variable: DatalogVariable;
-};
-export declare type DatalogBindRel = {
-    type: "bind-rel";
-    args: (DatalogVariable | DatalogUnderscore)[];
-};
-export declare type DatalogUnderscore = {
-    type: "underscore";
-    value: "_";
-};
-export declare type DatalogRuleName = {
-    type: "rulename";
-    value: string;
-};
-export declare type RoamBasicBlock = {
-    string: string;
-    uid: string;
-};
-export declare type RoamBasicPage = {
-    title: string;
-    uid: string;
-};
-export declare type RoamBasicNode = {
-    text: string;
-    uid: string;
-    children: RoamBasicNode[];
-};
-export declare type RoamUnorderedBasicNode = {
-    text: string;
-    uid: string;
-    order: number;
-    children?: RoamUnorderedBasicNode[];
-};
-export declare type RoamPull = {
-    "block/children"?: RoamNode[];
-    "block/heading"?: number;
-    "block/open"?: boolean;
-    "block/order"?: number;
-    "block/page"?: RoamNode;
-    "block/parents"?: RoamNode[];
-    "block/refs"?: RoamNode[];
-    "block/string"?: string;
-    "block/uid"?: string;
-    "children/view-type"?: `:${ViewType}`;
-    "create/time"?: number;
-    "create/user"?: RoamNode;
-    "edit/time"?: number;
-    "edit/user"?: RoamNode;
-    "log/id"?: number;
-    "node/title"?: string;
-} & RoamNode;
-export declare type PullBlock = {
-    ":block/children"?: {
-        ":db/id": number;
-    }[];
-    ":block/heading"?: number;
-    ":block/open"?: boolean;
-    ":block/order"?: number;
-    ":block/page"?: {
-        ":db/id": number;
-    };
-    ":block/parents"?: {
-        ":db/id": number;
-    }[];
-    ":block/props"?: {
-        ":image-size"?: {
-            [p: string]: {
-                ":height": number;
-                ":width": number;
-            };
-        };
-        ":iframe"?: {
-            [p: string]: {
-                ":size": {
-                    ":height": number;
-                    ":width": number;
-                };
-            };
-        };
-    };
-    ":block/refs"?: {
-        ":db/id": number;
-    }[];
-    ":block/string"?: string;
-    ":block/text-align"?: TextAlignment;
-    ":block/uid"?: string;
-    ":children/view-type"?: `:${ViewType}`;
-    ":create/time"?: number;
-    ":create/user"?: {
-        ":db/id": number;
-    };
-    ":edit/time"?: number;
-    ":edit/user"?: {
-        ":db/id": number;
-    };
-    ":db/id"?: number;
-    ":log/id"?: number;
-    ":node/title"?: string;
-    ":user/display-name"?: string;
-    ":user/display-page"?: {
-        ":db/id": number;
-    };
-    ":user/settings"?: {
-        ":namespace-options": [":none", ":partial", ":full"];
-        ":link-brackets?": boolean;
-        ":showing-inline-references?": boolean;
-        ":right-sidebar-pinned": {
-            [uuid: string]: SidebarWindow;
-        };
-        ":showing-own-icons?": boolean;
-        ":showing-user-icons?": boolean;
-    };
-    ":user/uid"?: string;
-};
-export declare type RoamPullResult = RoamPull | null;
-export declare type ViewType = "document" | "bullet" | "numbered";
-export declare type TextAlignment = "left" | "center" | "right";
-export declare type RoamBlock = {
-    attrs?: {
-        source: string[];
-    }[][];
-    children?: {
-        id: number;
-    }[];
-    id?: number;
-    string?: string;
-    title?: string;
-    time?: number;
-    uid?: string;
-    order?: number;
-    "view-type"?: ViewType;
-};
-export declare type RoamError = {
-    raw: string;
-    "status-code": number;
-};
-export declare type TreeNode = {
-    text: string;
-    order: number;
-    children: TreeNode[];
-    uid: string;
-    heading: number;
-    open: boolean;
-    viewType: ViewType;
-    editTime: Date;
-    textAlign: TextAlignment;
-    props: {
-        imageResize: {
-            [link: string]: {
-                height: number;
-                width: number;
-            };
-        };
-        iframe: {
-            [link: string]: {
-                height: number;
-                width: number;
-            };
-        };
-    };
-};
-export declare type TextNode = {
-    text: string;
-    children: TextNode[];
-};
-export declare type InputTextNode = {
-    text: string;
-    children?: InputTextNode[];
-    uid?: string;
-    heading?: number;
-    textAlign?: TextAlignment;
-    viewType?: ViewType;
-    open?: boolean;
-};
-declare type PlusType = [number, string];
-export declare type RoamNode = {
-    "db/id": number;
-};
-export declare type RoamQuery = RoamPull & {
-    "block/graph"?: RoamNode;
-    "node/graph+title"?: PlusType;
-    "block/graph+uid"?: PlusType;
-    "node/graph"?: RoamNode;
-    "edit/email"?: string;
-    "entity/graph"?: RoamNode;
-};
-export declare type RoamQueryResult = number & RoamQuery;
-export declare type ClientParams = {
-    action: "pull" | "q" | "create-block" | "update-block" | "create-page" | "move-block" | "delete-block" | "delete-page" | "update-page";
-    selector?: string;
-    uid?: string;
-    query?: string;
-    inputs?: string[];
-} & ActionParams;
-export declare type ActionParams = {
-    location?: {
-        "parent-uid": string;
-        order: number;
-    };
-    block?: {
-        string?: string;
-        uid?: string;
-        open?: boolean;
-        heading?: number;
-        "text-align"?: TextAlignment;
-        "children-view-type"?: ViewType;
-    };
-    page?: {
-        title?: string;
-        uid?: string;
-    };
-};
-export declare type WriteAction = (a: ActionParams) => Promise<void>;
-export declare type UserSettings = {
-    "global-filters": {
-        includes: string[];
-        removes: string[];
-    };
-};
-declare type SidebarWindowType = SidebarBlockWindow | SidebarMentionsWindow | SidebarGraphWindow | SidebarOutlineWindow;
-export declare type SidebarWindowInput = {
-    "block-uid": string;
-    type: SidebarWindowType["type"];
-};
-declare type SidebarBlockWindow = {
-    type: "block";
-    "block-uid": string;
-};
-declare type SidebarOutlineWindow = {
-    type: "outline";
-    "page-uid": string;
-};
-declare type SidebarMentionsWindow = {
-    type: "mentions";
-    "mentions-uid": string;
-};
-declare type SidebarGraphWindow = {
-    type: "graph";
-    "block-uid": string;
-};
-export declare type SidebarAction = (action: {
-    window: SidebarWindowInput;
-}) => Promise<void>;
-export declare type SidebarWindow = {
-    "collapsed?": boolean;
-    order: number;
-    "pinned?": boolean;
-    "window-id": string;
-} & SidebarWindowType;
+import { CommandHandler, SmartBlocksContext } from "./smartblocks";
+export * from "./native";
 declare type json = string | number | boolean | null | {
     toJSON: () => string;
 } | json[] | {
@@ -558,7 +235,9 @@ declare global {
                 smartblocks?: {
                     registerCommand: (args: {
                         text: string;
-                        handler: (u: unknown) => CommandHandler;
+                        help?: string;
+                        handler: (c: Pick<SmartBlocksContext, "targetUid" | "variables">) => CommandHandler;
+                        delayArgs?: true;
                     }) => void;
                     triggerSmartblock: (args: {
                         srcName?: string;
@@ -577,4 +256,3 @@ declare global {
         };
     }
 }
-export {};

package/types/index.js

@@ -1,3 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./native"), exports);
 //# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":""}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/types/index.ts"],"names":[],"mappings":";;;AAQA,wDAAyB"}

package/types/native.d.ts

@@ -0,0 +1,325 @@
+export declare type DatalogFnArg = DatalogSrcVar | DatalogVariable | DatalogConstant;
+export declare type DatalogSrcVar = {
+    type: "src-var";
+    value: string;
+};
+export declare type DatalogVariable = {
+    type: "variable";
+    value: string;
+};
+export declare type DatalogAndClause = {
+    type: "and-clause";
+    clauses: DatalogClause[];
+};
+export declare type DatalogExpressionClause = DatalogDataPattern | DatalogPredExpr | DatalogFnExpr | DatalogRuleExpr;
+export declare type DatalogRuleExpr = {
+    type: "rule-expr";
+    srcVar?: DatalogSrcVar;
+    ruleName: DatalogRuleName;
+    arguments: DatalogArgument[];
+};
+export declare type DatalogNotClause = {
+    type: "not-clause";
+    srcVar?: DatalogSrcVar;
+    clauses: DatalogClause[];
+};
+export declare type DatalogNotJoinClause = {
+    type: "not-join-clause";
+    srcVar?: DatalogSrcVar;
+    variables: DatalogVariable[];
+    clauses: DatalogClause[];
+};
+export declare type DatalogOrClause = {
+    type: "or-clause";
+    srcVar?: DatalogSrcVar;
+    clauses: (DatalogClause | DatalogAndClause)[];
+};
+export declare type DatalogOrJoinClause = {
+    type: "or-join-clause";
+    srcVar?: DatalogSrcVar;
+    variables: DatalogVariable[];
+    clauses: (DatalogClause | DatalogAndClause)[];
+};
+export declare type DatalogClause = DatalogNotClause | DatalogOrJoinClause | DatalogExpressionClause | DatalogOrClause | DatalogNotJoinClause;
+export declare type DatalogDataPattern = {
+    type: "data-pattern";
+    srcVar?: DatalogSrcVar;
+    arguments: DatalogArgument[];
+};
+export declare type DatalogArgument = DatalogVariable | DatalogConstant | DatalogUnderscore;
+export declare type DatalogConstant = {
+    type: "constant";
+    value: string;
+};
+export declare type DatalogPredExpr = {
+    type: "pred-expr";
+    pred: "<" | ">" | "re-matches" | "re-find" | "clojure.string/includes?" | "clojure.string/ends-with?" | "clojure.string/starts-with?";
+    arguments: DatalogFnArg[];
+};
+export declare type DatalogFnExpr = {
+    type: "fn-expr";
+    fn: "re-pattern";
+    arguments: DatalogFnArg[];
+    binding: DatalogBinding;
+};
+export declare type DatalogBinding = DatalogBindScalar | DatalogBindTuple | DatalogBindColl | DatalogBindRel;
+export declare type DatalogBindScalar = {
+    type: "bind-scalar";
+    variable: DatalogVariable;
+};
+export declare type DatalogBindTuple = {
+    type: "bind-tuple";
+    args: (DatalogVariable | DatalogUnderscore)[];
+};
+export declare type DatalogBindColl = {
+    type: "bind-col";
+    variable: DatalogVariable;
+};
+export declare type DatalogBindRel = {
+    type: "bind-rel";
+    args: (DatalogVariable | DatalogUnderscore)[];
+};
+export declare type DatalogUnderscore = {
+    type: "underscore";
+    value: "_";
+};
+export declare type DatalogRuleName = {
+    type: "rulename";
+    value: string;
+};
+export declare type RoamBasicBlock = {
+    string: string;
+    uid: string;
+};
+export declare type RoamBasicPage = {
+    title: string;
+    uid: string;
+};
+export declare type RoamBasicNode = {
+    text: string;
+    uid: string;
+    children: RoamBasicNode[];
+};
+export declare type RoamUnorderedBasicNode = {
+    text: string;
+    uid: string;
+    order: number;
+    children?: RoamUnorderedBasicNode[];
+};
+export declare type RoamPull = {
+    "block/children"?: RoamNode[];
+    "block/heading"?: number;
+    "block/open"?: boolean;
+    "block/order"?: number;
+    "block/page"?: RoamNode;
+    "block/parents"?: RoamNode[];
+    "block/refs"?: RoamNode[];
+    "block/string"?: string;
+    "block/uid"?: string;
+    "children/view-type"?: `:${ViewType}`;
+    "create/time"?: number;
+    "create/user"?: RoamNode;
+    "edit/time"?: number;
+    "edit/user"?: RoamNode;
+    "log/id"?: number;
+    "node/title"?: string;
+} & RoamNode;
+export declare type PullBlock = {
+    ":block/children"?: {
+        ":db/id": number;
+    }[];
+    ":block/heading"?: number;
+    ":block/open"?: boolean;
+    ":block/order"?: number;
+    ":block/page"?: {
+        ":db/id": number;
+    };
+    ":block/parents"?: {
+        ":db/id": number;
+    }[];
+    ":block/props"?: {
+        ":image-size"?: {
+            [p: string]: {
+                ":height": number;
+                ":width": number;
+            };
+        };
+        ":iframe"?: {
+            [p: string]: {
+                ":size": {
+                    ":height": number;
+                    ":width": number;
+                };
+            };
+        };
+    };
+    ":block/refs"?: {
+        ":db/id": number;
+    }[];
+    ":block/string"?: string;
+    ":block/text-align"?: TextAlignment;
+    ":block/uid"?: string;
+    ":children/view-type"?: `:${ViewType}`;
+    ":create/time"?: number;
+    ":create/user"?: {
+        ":db/id": number;
+    };
+    ":edit/time"?: number;
+    ":edit/user"?: {
+        ":db/id": number;
+    };
+    ":db/id"?: number;
+    ":log/id"?: number;
+    ":node/title"?: string;
+    ":user/display-name"?: string;
+    ":user/display-page"?: {
+        ":db/id": number;
+    };
+    ":user/settings"?: {
+        ":namespace-options": [":none", ":partial", ":full"];
+        ":link-brackets?": boolean;
+        ":showing-inline-references?": boolean;
+        ":right-sidebar-pinned": {
+            [uuid: string]: SidebarWindow;
+        };
+        ":showing-own-icons?": boolean;
+        ":showing-user-icons?": boolean;
+    };
+    ":user/uid"?: string;
+};
+export declare type RoamPullResult = RoamPull | null;
+export declare type ViewType = "document" | "bullet" | "numbered";
+export declare type TextAlignment = "left" | "center" | "right";
+export declare type RoamBlock = {
+    attrs?: {
+        source: string[];
+    }[][];
+    children?: {
+        id: number;
+    }[];
+    id?: number;
+    string?: string;
+    title?: string;
+    time?: number;
+    uid?: string;
+    order?: number;
+    "view-type"?: ViewType;
+};
+export declare type RoamError = {
+    raw: string;
+    "status-code": number;
+};
+export declare type TreeNode = {
+    text: string;
+    order: number;
+    children: TreeNode[];
+    uid: string;
+    heading: number;
+    open: boolean;
+    viewType: ViewType;
+    editTime: Date;
+    textAlign: TextAlignment;
+    props: {
+        imageResize: {
+            [link: string]: {
+                height: number;
+                width: number;
+            };
+        };
+        iframe: {
+            [link: string]: {
+                height: number;
+                width: number;
+            };
+        };
+    };
+};
+export declare type TextNode = {
+    text: string;
+    children: TextNode[];
+};
+export declare type InputTextNode = {
+    text: string;
+    children?: InputTextNode[];
+    uid?: string;
+    heading?: number;
+    textAlign?: TextAlignment;
+    viewType?: ViewType;
+    open?: boolean;
+};
+declare type PlusType = [number, string];
+export declare type RoamNode = {
+    "db/id": number;
+};
+export declare type RoamQuery = RoamPull & {
+    "block/graph"?: RoamNode;
+    "node/graph+title"?: PlusType;
+    "block/graph+uid"?: PlusType;
+    "node/graph"?: RoamNode;
+    "edit/email"?: string;
+    "entity/graph"?: RoamNode;
+};
+export declare type RoamQueryResult = number & RoamQuery;
+export declare type ClientParams = {
+    action: "pull" | "q" | "create-block" | "update-block" | "create-page" | "move-block" | "delete-block" | "delete-page" | "update-page";
+    selector?: string;
+    uid?: string;
+    query?: string;
+    inputs?: string[];
+} & ActionParams;
+export declare type ActionParams = {
+    location?: {
+        "parent-uid": string;
+        order: number;
+    };
+    block?: {
+        string?: string;
+        uid?: string;
+        open?: boolean;
+        heading?: number;
+        "text-align"?: TextAlignment;
+        "children-view-type"?: ViewType;
+    };
+    page?: {
+        title?: string;
+        uid?: string;
+    };
+};
+export declare type WriteAction = (a: ActionParams) => Promise<void>;
+export declare type UserSettings = {
+    "global-filters": {
+        includes: string[];
+        removes: string[];
+    };
+};
+declare type SidebarWindowType = SidebarBlockWindow | SidebarMentionsWindow | SidebarGraphWindow | SidebarOutlineWindow;
+export declare type SidebarWindowInput = {
+    "block-uid": string;
+    type: SidebarWindowType["type"];
+};
+declare type SidebarBlockWindow = {
+    type: "block";
+    "block-uid": string;
+};
+declare type SidebarOutlineWindow = {
+    type: "outline";
+    "page-uid": string;
+};
+declare type SidebarMentionsWindow = {
+    type: "mentions";
+    "mentions-uid": string;
+};
+declare type SidebarGraphWindow = {
+    type: "graph";
+    "block-uid": string;
+};
+export declare type SidebarAction = (action: {
+    window: SidebarWindowInput;
+}) => Promise<void>;
+export declare type SidebarWindow = {
+    "collapsed?": boolean;
+    order: number;
+    "pinned?": boolean;
+    "window-id": string;
+} & SidebarWindowType;
+export {};

package/types/native.js

@@ -0,0 +1,5 @@
+"use strict";
+// emulating Datalog Grammar
+// https://docs.datomic.com/cloud/query/query-data-reference.html#or-clauses
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=native.js.map

package/types/native.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"native.js","sourceRoot":"","sources":["../src/types/native.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,4EAA4E"}

package/types/smartblocks.d.ts

@@ -0,0 +1,25 @@
+import { InputTextNode } from "./native";
+declare type CommandOutput = string | string[] | InputTextNode[];
+export declare type CommandHandler = (...args: string[]) => CommandOutput | Promise<CommandOutput>;
+export declare type SmartBlocksContext = {
+    onBlockExit: CommandHandler;
+    targetUid: string;
+    triggerUid: string;
+    ifCommand?: boolean;
+    exitBlock: "yes" | "no" | "end" | "empty" | "childless";
+    exitWorkflow: boolean;
+    variables: Record<string, string>;
+    cursorPosition?: {
+        uid: string;
+        selection: number;
+    };
+    currentUid?: string;
+    currentContent: string;
+    indent: Set<string>;
+    unindent: Set<string>;
+    focusOnBlock?: string;
+    dateBasisMethod?: string;
+    refMapping: Record<string, string>;
+    afterWorkflowMethods: (() => void | Promise<void>)[];
+};
+export {};

package/types/smartblocks.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=smartblocks.js.map

package/types/smartblocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"smartblocks.js","sourceRoot":"","sources":["../src/types/smartblocks.ts"],"names":[],"mappings":""}

package/util/registerSmartBlocksCommand.d.ts

@@ -1,4 +1,4 @@
-import { CommandHandler } from "../types";
+import { CommandHandler } from "../types/smartblocks";
 declare const registerSmartBlocksCommand: ({ text: inputText, handler, }: {
     text: string;
     handler: (u: unknown) => CommandHandler;