Serialize NodeInputSlot.widget (#622)

Serialize linked widget on node input slot properly according to current
save format in
76818b54e6/src/extensions/core/widgetInputs.ts

eslint.config.js

@@ -8,10 +8,7 @@ import globals from "globals"
 import tseslint from "typescript-eslint"
 
 const rules = Object.fromEntries(
-  Object.entries(eslintPluginAntfu.rules)
-    .map(
-      ([id]) => [`antfu/${id}`, "off"],
-    ),
+  Object.entries(eslintPluginAntfu.rules).map(([id]) => [`antfu/${id}`, "off"]),
 )
 const antfuLint = {
   name: "antfu/without-if-newline-or-imports",
@@ -214,7 +211,15 @@ export default tseslint.config(
     rules: {
       "@typescript-eslint/no-unused-vars": "off",
       "unused-imports/no-unused-imports": "error",
-      "unused-imports/no-unused-vars": "error",
+      "unused-imports/no-unused-vars": [
+        "error",
+        {
+          vars: "all",
+          varsIgnorePattern: "^_",
+          args: "after-used",
+          argsIgnorePattern: "^_",
+        },
+      ],
     },
   },
 
@@ -242,7 +247,14 @@ export default tseslint.config(
         "error",
         {
           // The default grouping, but with type imports first as a separate group.
-          groups: [["^.*\\u0000$"], ["^\\u0000"], ["^node:"], ["^@?\\w"], ["^"], ["^\\."]],
+          groups: [
+            ["^.*\\u0000$"],
+            ["^\\u0000"],
+            ["^node:"],
+            ["^@?\\w"],
+            ["^"],
+            ["^\\."],
+          ],
         },
       ],
       "simple-import-sort/exports": "error",

src/NodeSlot.ts

@@ -7,6 +7,7 @@ import { LiteGraph } from "./litegraph"
 import { LinkDirection, RenderShape } from "./types/globalEnums"
 import { ISerialisedNodeOutputSlot } from "./types/serialisation"
 import { ISerialisedNodeInputSlot } from "./types/serialisation"
+import { omitBy } from "./utils/object"
 
 export interface ConnectionColorContext {
   default_connection_color: {
@@ -33,16 +34,13 @@ interface IDrawOptions {
 export function serializeSlot(slot: INodeInputSlot): ISerialisedNodeInputSlot
 export function serializeSlot(slot: INodeOutputSlot): ISerialisedNodeOutputSlot
 export function serializeSlot(slot: INodeInputSlot | INodeOutputSlot): ISerialisedNodeInputSlot | ISerialisedNodeOutputSlot {
-  const serialized = { ...slot }
-  delete serialized._layoutElement
-  if ("_data" in serialized) {
-    delete serialized._data
-  }
-  // Widget input slots' pos is calculated during layout, so we don't need to serialize it.
-  if (isWidgetInputSlot(slot) && "pos" in serialized) {
-    delete serialized.pos
-  }
-  return serialized
+  return omitBy({
+    ...slot,
+    _layoutElement: undefined,
+    _data: undefined,
+    pos: isWidgetInputSlot(slot) ? undefined : slot.pos,
+    widget: isWidgetInputSlot(slot) && slot.widget?.name ? { name: slot.widget.name } : undefined,
+  }, value => value === undefined) as ISerialisedNodeInputSlot | ISerialisedNodeOutputSlot
 }
 
 export function toNodeSlotClass(slot: INodeSlot): NodeSlot {

src/types/serialisation.ts

@@ -41,7 +41,7 @@ export interface SerialisableGraph {
 }
 
 export type ISerialisedNodeInputSlot = Omit<INodeInputSlot, "_layoutElement"> & {
-  widget?: { name?: string }
+  widget?: { name: string }
 }
 export type ISerialisedNodeOutputSlot = Omit<INodeOutputSlot, "_layoutElement" | "_data">
 

src/utils/object.ts

@@ -0,0 +1,5 @@
+export function omitBy<T extends object>(obj: T, predicate: (value: any) => boolean): Partial<T> {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([_key, value]) => !predicate(value)),
+  ) as Partial<T>
+}

test/NodeSlot.test.ts

@@ -46,5 +46,27 @@ describe("NodeSlot", () => {
       const serialized = serializeSlot(normalSlot)
       expect(serialized).toHaveProperty("pos")
     })
+
+    it("preserves only widget name during serialization", () => {
+      const widgetInputSlot: INodeInputSlot = {
+        name: "test-id",
+        type: "STRING",
+        link: null,
+        widget: {
+          name: "test-widget",
+          type: "combo",
+          value: "test-value-1",
+          options: {
+            values: ["test-value-1", "test-value-2"],
+          },
+        },
+      }
+
+      const serialized = serializeSlot(widgetInputSlot)
+      expect(serialized.widget).toEqual({ name: "test-widget" })
+      expect(serialized.widget).not.toHaveProperty("type")
+      expect(serialized.widget).not.toHaveProperty("value")
+      expect(serialized.widget).not.toHaveProperty("options")
+    })
   })
 })