Renamed InputOutput into Channel with common property "link"

forman · forman · commit 75dadf82500e · 2024-11-06T16:35:14.000+01:00
diff --git a/dashi/src/lib/actions/handleComponentChange.ts b/dashi/src/lib/actions/handleComponentChange.ts
@@ -17,7 +17,7 @@ export function handleComponentChange(
       contribIndex,
       stateChanges: [
         {
-          type: "Output",
+          link: "component",
           id: changeEvent.componentId,
           property: changeEvent.propertyName,
           value: changeEvent.propertyValue,
@@ -57,7 +57,8 @@ function getCallbackRequests(
       const inputs = callback.inputs;
       const inputIndex = inputs.findIndex(
         (input) =>
-          (!input.type || input.type === "Input") &&
+          !input.noTrigger &&
+          (!input.link || input.link === "component") &&
           input.id === changeEvent.componentId &&
           input.property === changeEvent.propertyName,
       );
diff --git a/dashi/src/lib/actions/handleHostStoreChange.ts b/dashi/src/lib/actions/handleHostStoreChange.ts
@@ -5,9 +5,9 @@ import type {
   CallbackRef,
   CallbackRequest,
   ContribRef,
-  Input,
   InputRef,
 } from "@/lib/types/model/callback";
+import type { Input } from "@/lib/types/model/channel";
 import { getInputValues } from "@/lib/actions/helpers/getInputValues";
 import { getValue, type PropertyPath } from "@/lib/utils/getValue";
 import { invokeCallbacks } from "@/lib/actions/helpers/invokeCallbacks";
@@ -59,6 +59,9 @@ function getCallbackRequests<S extends object = object>(
 
 const getHostStorePropertyRefs = memoizeOne(_getHostStorePropertyRefs);
 
+/**
+ * Get the static list of host state property references for all contributions.
+ */
 function _getHostStorePropertyRefs(): PropertyRef[] {
   const { contributionsRecord } = store.getState();
   const propertyRefs: PropertyRef[] = [];
@@ -68,13 +71,13 @@ function _getHostStorePropertyRefs(): PropertyRef[] {
       (contribution.callbacks || []).forEach(
         (callback, callbackIndex) =>
           (callback.inputs || []).forEach((input, inputIndex) => {
-            if (input.type === "AppInput") {
+            if (!input.noTrigger && input.link === "app") {
               propertyRefs.push({
                 contribPoint,
                 contribIndex,
                 callbackIndex,
                 inputIndex,
-                propertyPath: input.property.split("."),
+                propertyPath: input.property!.split("."),
               });
             }
           }),
diff --git a/dashi/src/lib/actions/helpers/applyStateChangeRequests.test.ts b/dashi/src/lib/actions/helpers/applyStateChangeRequests.test.ts
@@ -46,7 +46,7 @@ describe("Test that applyContributionChangeRequests()", () => {
     contribIndex: 0,
     stateChanges: [
       {
-        type: "Output",
+        link: "component",
         id: "dd1",
         property: "value",
         value: 14,
@@ -59,7 +59,7 @@ describe("Test that applyContributionChangeRequests()", () => {
     contribIndex: 0,
     stateChanges: [
       {
-        type: "Output",
+        link: "component",
         id: "dd1",
         property: "value",
         value: 13,
@@ -88,7 +88,7 @@ describe("Test that applyContributionChangeRequests()", () => {
 describe("Test that applyComponentStateChange()", () => {
   it("changes state if values are different", () => {
     const newState = applyComponentStateChange(componentTree, {
-      type: "Output",
+      link: "component",
       id: "cb1",
       property: "value",
       value: false,
@@ -99,7 +99,7 @@ describe("Test that applyComponentStateChange()", () => {
 
   it("doesn't change the state if value stays the same", () => {
     const newState = applyComponentStateChange(componentTree, {
-      type: "Output",
+      link: "component",
       id: "cb1",
       property: "value",
       value: true,
diff --git a/dashi/src/lib/actions/helpers/applyStateChangeRequests.ts b/dashi/src/lib/actions/helpers/applyStateChangeRequests.ts
@@ -38,7 +38,7 @@ function applyHostStateChanges(stateChangeRequests: StateChangeRequest[]) {
       hostState = applyStateChanges(
         hostState,
         stateChangeRequest.stateChanges.filter(
-          (stateChange) => stateChange.type === "AppOutput",
+          (stateChange) => stateChange.link === "app",
         ),
       );
     });
@@ -72,16 +72,14 @@ export function applyContributionChangeRequests(
       const state = applyStateChanges(
         contribution.state,
         stateChanges.filter(
-          (stateChange) =>
-            (!stateChange.type || stateChange.type === "Output") &&
-            !stateChange.id,
+          (stateChange) => stateChange.link === "container" && !stateChange.id,
         ),
       );
       const component = applyComponentStateChanges(
         contribution.component,
         stateChanges.filter(
           (stateChange) =>
-            (!stateChange.type || stateChange.type === "Output") &&
+            (!stateChange.link || stateChange.link === "component") &&
             stateChange.id,
         ),
       );
diff --git a/dashi/src/lib/actions/helpers/getInputValues.test.ts b/dashi/src/lib/actions/helpers/getInputValues.test.ts
@@ -27,7 +27,7 @@ describe("Test that getComponentStateValue()", () => {
   it("works on 1st level", () => {
     expect(
       getComponentStateValue(componentState, {
-        type: "Input",
+        link: "component",
         id: "b1",
         property: "value",
       }),
@@ -37,7 +37,7 @@ describe("Test that getComponentStateValue()", () => {
   it("works on 2nd level", () => {
     expect(
       getComponentStateValue(componentState, {
-        type: "Input",
+        link: "component",
         id: "p1",
         property: "chart",
       }),
@@ -47,15 +47,15 @@ describe("Test that getComponentStateValue()", () => {
   it("works on 3rd level", () => {
     expect(
       getComponentStateValue(componentState, {
-        type: "Input",
+        link: "component",
         id: "cb1",
         property: "value",
       }),
     ).toEqual(true);
 
     expect(
       getComponentStateValue(componentState, {
-        type: "Input",
+        link: "component",
         id: "dd1",
         property: "value",
       }),
@@ -67,21 +67,27 @@ describe("Test that getInputValueFromState()", () => {
   it("works with input.id and input.property", () => {
     const state = { x: { y: 26 } };
     expect(
-      getInputValueFromState({ type: "State", id: "x", property: "y" }, state),
+      getInputValueFromState(
+        { link: "component", id: "x", property: "y" },
+        state,
+      ),
     ).toEqual(26);
   });
 
   it("works with arrays indexes", () => {
     const state = { x: [4, 5, 6] };
     expect(
-      getInputValueFromState({ type: "State", id: "x", property: "1" }, state),
+      getInputValueFromState(
+        { link: "component", id: "x", property: "1" },
+        state,
+      ),
     ).toEqual(5);
   });
 
   it("works without input.id", () => {
     const state = { x: [4, 5, 6] };
     expect(
-      getInputValueFromState({ type: "State", property: "x" }, state),
+      getInputValueFromState({ link: "container", property: "x" }, state),
     ).toEqual([4, 5, 6]);
   });
 });
diff --git a/dashi/src/lib/actions/helpers/getInputValues.ts b/dashi/src/lib/actions/helpers/getInputValues.ts
@@ -1,4 +1,4 @@
-import type { Input } from "@/lib/types/model/callback";
+import type { Input } from "@/lib/types/model/channel";
 import type { ContributionState } from "@/lib/types/state/contribution";
 import type { ComponentState } from "@/lib/types/state/component";
 import { isSubscriptable } from "@/lib/utils/isSubscriptable";
@@ -22,17 +22,16 @@ export function getInputValue<S extends object = object>(
   hostState?: S | undefined,
 ): unknown {
   let inputValue: unknown = undefined;
-  const inputKind = input.type || "Input";
-  if (
-    (inputKind === "Input" || inputKind === "State") &&
-    contributionState.component
-  ) {
+  const dataSource = input.link || "component";
+  if (dataSource === "component" && contributionState.component) {
     // Return value of a property of some component in the tree
     inputValue = getComponentStateValue(contributionState.component, input);
-  } else if (inputKind === "AppInput" && hostState) {
+  } else if (dataSource === "container" && contributionState.state) {
+    inputValue = getInputValueFromState(input, hostState);
+  } else if (dataSource === "app" && hostState) {
     inputValue = getInputValueFromState(input, hostState);
   } else {
-    console.warn(`input of unknown kind:`, input);
+    console.warn(`input with unknown data source:`, input);
   }
   if (inputValue === undefined || inputValue === noValue) {
     // We use null, because undefined is not JSON-serializable.
diff --git a/dashi/src/lib/components/Component.tsx b/dashi/src/lib/components/Component.tsx
@@ -15,7 +15,7 @@ export function Component({ type, ...props }: ComponentProps) {
   // TODO: allow for registering components via their types
   //   and make following code generic.
   //
-  // const DashiComp = Registry.getComponent(type);
+  // const DashiComp = Registry.getComponent(link);
   // return return <DashiComp {...props} />;
   //
   if (type === "Plot") {
diff --git a/dashi/src/lib/types/model/callback.ts b/dashi/src/lib/types/model/callback.ts
@@ -1,3 +1,5 @@
+import type { Input, Output } from "@/lib/types/model/channel";
+
 export interface Callback {
   function: CbFunction;
   inputs?: Input[];
@@ -30,43 +32,6 @@ export interface CbParameter {
   default?: unknown;
 }
 
-export type InputType = "AppInput" | "Input" | "State";
-
-export type OutputType = "AppOutput" | "Output";
-
-export type InputOutputType = InputType | OutputType;
-
-export interface InputOutput {
-  /**
-   * The type of input or output.
-   */
-  type: InputOutputType;
-
-  /**
-   * The identifier of a subcomponent.
-   * `id` is not needed if type == "AppInput" | "AppOutput".
-   */
-  id?: string;
-
-  // TODO: we must allow `property` to be a constant
-  //  expression of the form: name {"." name | index}.
-  //  Then we get the normalized form
-  //    property: string[];
-
-  /**
-   * The property of an object or array index.
-   */
-  property: string;
-}
-
-export interface Input extends InputOutput {
-  type: InputType;
-}
-
-export interface Output extends InputOutput {
-  type: OutputType;
-}
-
 /**
  * A reference to a specific contribution.
  */
diff --git a/dashi/src/lib/types/model/channel.ts b/dashi/src/lib/types/model/channel.ts
@@ -0,0 +1,33 @@
+export type Link = "component" | "container" | "app";
+
+/**
+ * Base for `Input` and `Output`.
+ */
+export interface Channel {
+  /**
+   * The link provides the source for inputs and that target for outputs.
+   */
+  link: Link;
+
+  /**
+   * The identifier of a subcomponent.
+   * `id` is not needed if link == "AppInput" | "AppOutput".
+   */
+  id?: string;
+
+  // TODO: we must allow `property` to be a constant
+  //  expression of the form: name {"." name | index}.
+  //  Then we get the normalized form
+  //    property: string[];
+
+  /**
+   * The property of an object or array index.
+   */
+  property: string;
+}
+
+export interface Input extends Channel {
+  noTrigger?: boolean;
+}
+
+export interface Output extends Channel {}
