[core] NodeReference type for references to nodes (#720)

* `NodeReference` type for references to nodes * `NodeReference` type for references to nodes * Abstract implementation details
mui · Aug 2, 2022 · 5409576 · 5409576
1 parent f00a26b
commit 5409576
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 10 deletions.
diff --git a/packages/toolpad-app/src/appDom.ts b/packages/toolpad-app/src/appDom.ts
@@ -2,6 +2,7 @@ import { generateKeyBetween } from 'fractional-indexing';
 import cuid from 'cuid';
 import {
   NodeId,
+  NodeReference,
   ConstantAttrValue,
   BindableAttrValue,
   BindableAttrValues,
@@ -106,7 +107,7 @@ export interface QueryNode<Q = any, P = any> extends AppDomNodeBase {
   readonly params?: BindableAttrValues<P>;
   readonly attributes: {
     readonly dataSource?: ConstantAttrValue<string>;
-    readonly connectionId: ConstantAttrValue<NodeId>;
+    readonly connectionId: ConstantAttrValue<NodeReference>;
     readonly query: ConstantAttrValue<Q>;
     readonly transform?: ConstantAttrValue<string>;
     readonly transformEnabled?: ConstantAttrValue<boolean>;
@@ -803,3 +804,10 @@ export function createRenderTree(dom: AppDom): RenderTree {
     nodes: filterValues(dom.nodes, (node) => frontendNodes.has(node.type)) as RenderTreeNodes,
   };
 }
+
+export function ref(nodeId: NodeId): NodeReference {
+  return { $$ref: nodeId };
+}
+export function deref(nodeRef: NodeReference): NodeId {
+  return nodeRef.$$ref;
+}
diff --git a/packages/toolpad-app/src/runtime/ToolpadApp.tsx b/packages/toolpad-app/src/runtime/ToolpadApp.tsx
@@ -235,7 +235,7 @@ function RenderedNodeContent({ node, childNodes, Component }: RenderedNodeConten
         const handler = () => {
           const { page } = action.value;
           if (page) {
-            navigateToPage(page);
+            navigateToPage(appDom.deref(page));
           }
         };
 

diff --git a/packages/toolpad-app/src/server/data.ts b/packages/toolpad-app/src/server/data.ts
@@ -391,7 +391,10 @@ export async function execQuery<P, Q>(
     );
   }
 
-  const connectionParams = await getConnectionParams<P>(appId, query.attributes.connectionId.value);
+  const connectionParams = await getConnectionParams<P>(
+    appId,
+    appDom.deref(query.attributes.connectionId.value),
+  );
 
   const transformEnabled = query.attributes.transformEnabled?.value;
   const transform = query.attributes.transform?.value;

diff --git a/packages/toolpad-app/src/toolpad/AppEditor/BindingEditor.tsx b/packages/toolpad-app/src/toolpad/AppEditor/BindingEditor.tsx
@@ -186,7 +186,10 @@ function NavigationActionEditor({ value, onChange }: NavigationActionEditorProps
 
   const handlePageChange = React.useCallback(
     (event: React.ChangeEvent<HTMLInputElement>) => {
-      onChange({ type: 'navigationAction', value: { page: event.target.value as NodeId } });
+      onChange({
+        type: 'navigationAction',
+        value: { page: appDom.ref(event.target.value as NodeId) },
+      });
     },
     [onChange],
   );
@@ -206,7 +209,7 @@ function NavigationActionEditor({ value, onChange }: NavigationActionEditorProps
         sx={{ my: 3 }}
         label="page"
         select
-        value={value?.value?.page || ''}
+        value={value?.value?.page ? appDom.deref(value.value.page) : ''}
         onChange={handlePageChange}
         disabled={!hasPagesAvailable}
         helperText={hasPagesAvailable ? null : 'No other pages available'}

diff --git a/packages/toolpad-app/src/toolpad/AppEditor/PageEditor/QueryEditor.tsx b/packages/toolpad-app/src/toolpad/AppEditor/PageEditor/QueryEditor.tsx
@@ -127,7 +127,7 @@ function ConnectionSelectorDialog<Q>({ open, onCreated, onClose }: DataSourceSel
     const queryNode = appDom.createNode(dom, 'query', {
       attributes: {
         query: appDom.createConst(dataSource.getInitialQueryValue()),
-        connectionId: appDom.createConst(connectionId),
+        connectionId: appDom.createConst(appDom.ref(connectionId)),
         dataSource: appDom.createConst(dataSourceId),
       },
     });
@@ -180,7 +180,7 @@ function QueryNodeEditorDialog<Q, P>({
     }
   }, [open, node]);
 
-  const connectionId = input.attributes.connectionId.value;
+  const connectionId = appDom.deref(input.attributes.connectionId.value);
   const connection = appDom.getMaybeNode(dom, connectionId, 'connection');
   const dataSourceId = input.attributes.dataSource?.value;
   const dataSource = (dataSourceId && dataSources[dataSourceId]) || null;
@@ -189,7 +189,9 @@ function QueryNodeEditorDialog<Q, P>({
     setInput((existing) =>
       update(existing, {
         attributes: update(existing.attributes, {
-          connectionId: newConnectionId ? appDom.createConst(newConnectionId) : undefined,
+          connectionId: newConnectionId
+            ? appDom.createConst(appDom.ref(newConnectionId))
+            : undefined,
         }),
       }),
     );
@@ -380,7 +382,7 @@ function QueryNodeEditorDialog<Q, P>({
           <NodeNameEditor node={node} />
           <ConnectionSelect
             dataSource={dataSourceId}
-            value={input.attributes.connectionId.value || null}
+            value={appDom.deref(input.attributes.connectionId.value) || null}
             onChange={handleConnectionChange}
           />
         </Stack>

diff --git a/packages/toolpad-core/src/types.ts b/packages/toolpad-core/src/types.ts
@@ -6,6 +6,10 @@ export type NodeId = Branded<string, 'NodeId'>;
 
 export type BindingAttrValueFormat = 'stringLiteral' | 'default';
 
+export interface NodeReference {
+  $$ref: NodeId;
+}
+
 export interface BoundExpressionAttrValue {
   type: 'boundExpression';
   value: string;
@@ -40,7 +44,7 @@ export interface JsExpressionAction {
 export interface NavigationAction<P = any> {
   type: 'navigationAction';
   value: {
-    page: NodeId;
+    page: NodeReference;
     parameters?: BindableAttrValues<P>;
   };
 }