cabbage-react 1.0.2 → 1.0.3

package/README.md

@@ -20,7 +20,7 @@ npm install cabbage-react
 
 Synchronize a parameter with Cabbage. This hook:
 
-- Identifies and sets the default value defined in Cabbage to the state.
+- Identifies and sets the default value defined in Cabbage to a state.
 - Handles initialization when opening an existing session, or reopening the plugin window.
 - Listens for value updates from the host (DAW), or from Csound.
 - Sends changes back to Cabbage when using the provided value-setter.

package/dist/hooks/useCabbageState.d.ts

@@ -3,8 +3,8 @@
  * This hook listens for updates to a parameter value from Cabbage and
  * sends updates to Cabbage when the parameter value changes locally (e.g., through a UI slider).
  */
-export declare const useCabbageState: <T>(channelId: string, parameterIndex: number) => {
+export declare const useCabbageState: <T>(channelId: string) => {
     value: T | undefined;
-    setValue: (newValue: T) => void;
+    setValue: (newValue: T, stringData?: string) => void;
 };
 //# sourceMappingURL=useCabbageState.d.ts.map

package/dist/hooks/useCabbageState.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useCabbageState.d.ts","sourceRoot":"","sources":["../../src/hooks/useCabbageState.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,aACrB,MAAM,kBACD,MAAM;;yBAMe,CAAC;CA6EtC,CAAC"}
+{"version":3,"file":"useCabbageState.d.ts","sourceRoot":"","sources":["../../src/hooks/useCabbageState.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,CAAC,aAAa,MAAM;;yBAKd,CAAC,eAAe,MAAM;CA4E3D,CAAC"}

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const g=require("react");console.log("Cabbage: loading cabbage.js");class c{static sendChannelUpdate(n,e=null,a=0){if(a===1)c.sendParameterUpdate(n,e);else{const s=n.value!==void 0?n.value:n.stringData||n.floatData;c.sendChannelData(n.channel,s,e)}}static sendParameterUpdate(n,e=null){const a={command:"parameterChange",...n};console.log("Cabbage.sendParameterUpdate:",n,"vscode:",e,"msg:",a),e!==null?(console.log("Sending via vscode.postMessage"),e.postMessage(a)):(console.log("Sending via window.sendMessageFromUI"),window.sendMessageFromUI(a))}static sendCustomCommand(n,e=null){const a={command:n,text:JSON.stringify({})};console.log("Cabbage: sending custom command from UI",a),e!==null?e.postMessage(a):window.sendMessageFromUI(a)}static sendWidgetUpdate(n,e=null){console.log("Cabbage: sending widget update from UI",n.props);const a={command:"widgetStateUpdate",obj:JSON.stringify(CabbageUtils.sanitizeForEditor(n))};e!==null?e.postMessage(a):window.sendMessageFromUI(a)}static sendMidiMessageFromUI(n,e,a,s=null){var t={statusByte:n,dataByte1:e,dataByte2:a};const o={command:"midiMessage",obj:JSON.stringify(t)};console.log("Cabbage: sending midi message from UI",t),s!==null?s.postMessage(o):window.sendMessageFromUI(o)}static sendChannelData(n,e,a=null){var s={channel:n};if(typeof e=="string")s.stringData=e;else if(typeof e=="number")s.floatData=e;else{console.warn("Cabbage: sendChannelData received unsupported data type:",typeof e);return}const t={command:"channelData",obj:JSON.stringify(s)};console.log("Cabbage: sending channel data from UI",s),a!==null?a.postMessage(t):window.sendMessageFromUI(t)}static MidiMessageFromHost(n,e,a){console.log("Cabbage: Got MIDI Message"+n+":"+e+":"+a)}static triggerFileOpenDialog(n,e,a={}){var s={channel:e,directory:a.directory||"",filters:a.filters||"*",openAtLastKnownLocation:a.openAtLastKnownLocation!==void 0?a.openAtLastKnownLocation:!0};const t={command:"fileOpen",obj:JSON.stringify(s)};n!==null?n.postMessage(t):window.sendMessageFromUI(t)}static openUrl(n,e,a){var s={url:e,file:a};const t={command:"openUrl",obj:JSON.stringify(s)};n!==null?n.postMessage(t):window.sendMessageFromUI(t)}}const u=r=>{const[n,e]=g.useState();return g.useEffect(()=>{const a=s=>{const{id:t,widgetJson:o,command:l}=s.data;if(t===r&&o&&l==="widgetUpdate"){const i=JSON.parse(o);console.log(`[Cabbage-React] Received properties for channelId ${t}`,i),e(i)}};return window.addEventListener("message",a),()=>{window.removeEventListener("message",a)}},[]),{properties:n}},f=(r,n)=>{const{properties:e}=u(r),[a,s]=g.useState(),t=o=>{s(o);const l={paramIdx:n,channel:r,value:o};c.sendParameterUpdate(l,null)};return g.useEffect(()=>{var d;const o=e==null?void 0:e.value;if(o!=null){console.log(`[Cabbage-React] Received initial value for channelId "${r}"`,o),s(o);return}const l=e==null?void 0:e.channels.find(m=>m.id===r);if(!l)return;const i=(d=l.range)==null?void 0:d.defaultValue;a===void 0&&i!==void 0&&(console.log(`[Cabbage-React] Received default value for channelId "${l.id}"`,i),s(i))},[e]),g.useEffect(()=>{const o=l=>{const{command:i}=l.data;if(i==="parameterChange"){const{value:d,paramIdx:m}=l.data;if(m!==n||d===null)return;console.log(`[Cabbage-React] Received value change for parameterIndex ${m}`,d),s(d)}};return window.addEventListener("message",o),()=>{window.removeEventListener("message",o)}},[]),{value:a,setValue:t}};exports.Cabbage=c;exports.useCabbageProperties=u;exports.useCabbageState=f;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const d=require("react");console.log("Cabbage: loading cabbage.js");class g{static sendChannelUpdate(e,n=null,a=0){if(a===1)g.sendParameterUpdate(e,n);else{const t=e.value!==void 0?e.value:e.stringData||e.floatData;g.sendChannelData(e.channel,t,n)}}static sendParameterUpdate(e,n=null){const a={command:"parameterChange",...e};console.log("Cabbage.sendParameterUpdate:",e,"vscode:",n,"msg:",a),n!==null?(console.log("Sending via vscode.postMessage"),n.postMessage(a)):(console.log("Sending via window.sendMessageFromUI"),window.sendMessageFromUI(a))}static sendCustomCommand(e,n=null){const a={command:e,text:JSON.stringify({})};console.log("Cabbage: sending custom command from UI",a),n!==null?n.postMessage(a):window.sendMessageFromUI(a)}static sendWidgetUpdate(e,n=null){console.log("Cabbage: sending widget update from UI",e.props);const a={command:"widgetStateUpdate",obj:JSON.stringify(CabbageUtils.sanitizeForEditor(e))};n!==null?n.postMessage(a):window.sendMessageFromUI(a)}static sendMidiMessageFromUI(e,n,a,t=null){var s={statusByte:e,dataByte1:n,dataByte2:a};const o={command:"midiMessage",obj:JSON.stringify(s)};console.log("Cabbage: sending midi message from UI",s),t!==null?t.postMessage(o):window.sendMessageFromUI(o)}static sendChannelData(e,n,a=null){var t={channel:e};if(typeof n=="string")t.stringData=n;else if(typeof n=="number")t.floatData=n;else{console.warn("Cabbage: sendChannelData received unsupported data type:",typeof n);return}const s={command:"channelData",obj:JSON.stringify(t)};console.log("Cabbage: sending channel data from UI",t),a!==null?a.postMessage(s):window.sendMessageFromUI(s)}static MidiMessageFromHost(e,n,a){console.log("Cabbage: Got MIDI Message"+e+":"+n+":"+a)}static triggerFileOpenDialog(e,n,a={}){var t={channel:n,directory:a.directory||"",filters:a.filters||"*",openAtLastKnownLocation:a.openAtLastKnownLocation!==void 0?a.openAtLastKnownLocation:!0};const s={command:"fileOpen",obj:JSON.stringify(t)};e!==null?e.postMessage(s):window.sendMessageFromUI(s)}static openUrl(e,n,a){var t={url:n,file:a};const s={command:"openUrl",obj:JSON.stringify(t)};e!==null?e.postMessage(s):window.sendMessageFromUI(s)}}const m=r=>{const[e,n]=d.useState();return d.useEffect(()=>{const a=t=>{const{id:s,widgetJson:o,command:l}=t.data;if(s===r&&o&&l==="widgetUpdate"){const i=JSON.parse(o);console.log(`[Cabbage-React] Received properties for channelId ${s}`,i),n(i)}};return window.addEventListener("message",a),()=>{window.removeEventListener("message",a)}},[]),{properties:e}},u=r=>{const{properties:e}=m(r),[n,a]=d.useState(),t=(s,o)=>{a(s);const l={channel:r,value:s,stringData:o};g.sendParameterUpdate(l,null)};return d.useEffect(()=>{var i;const s=e==null?void 0:e.value;if(s!=null){console.log(`[Cabbage-React] Received initial value for channelId "${r}"`,s),a(s);return}const o=e==null?void 0:e.channels.find(c=>c.id===r);if(!o)return;const l=(i=o.range)==null?void 0:i.defaultValue;n===void 0&&l!==void 0&&(console.log(`[Cabbage-React] Received default value for channelId "${o.id}"`,l),a(l))},[e]),d.useEffect(()=>{const s=o=>{const{command:l}=o.data;if(l==="parameterChange"){const{value:i,paramIdx:c}=o.data;if(i===null)return;console.log(`[Cabbage-React] Received value change for parameterIndex ${c}`,i),a(i)}};return window.addEventListener("message",s),()=>{window.removeEventListener("message",s)}},[]),{value:n,setValue:t}};exports.Cabbage=g;exports.useCabbageProperties=m;exports.useCabbageState=u;

package/dist/index.mjs

@@ -1,6 +1,6 @@
-import { useState as u, useEffect as m } from "react";
+import { useState as m, useEffect as c } from "react";
 console.log("Cabbage: loading cabbage.js");
-class c {
+class d {
   /**
    * Main entry point for sending any data from UI widgets to the Cabbage backend.
    * This function automatically routes messages to the appropriate backend function
@@ -14,164 +14,164 @@ class c {
    * All widget interactions should use this function instead of calling the lower-level
    * sendParameterUpdate or sendChannelData functions directly.
    */
-  static sendChannelUpdate(a, e = null, n = 0) {
+  static sendChannelUpdate(e, a = null, n = 0) {
     if (n === 1)
-      c.sendParameterUpdate(a, e);
+      d.sendParameterUpdate(e, a);
     else {
-      const s = a.value !== void 0 ? a.value : a.stringData || a.floatData;
-      c.sendChannelData(a.channel, s, e);
+      const t = e.value !== void 0 ? e.value : e.stringData || e.floatData;
+      d.sendChannelData(e.channel, t, a);
     }
   }
-  static sendParameterUpdate(a, e = null) {
+  static sendParameterUpdate(e, a = null) {
     const n = {
       command: "parameterChange",
-      ...a
+      ...e
     };
-    console.log("Cabbage.sendParameterUpdate:", a, "vscode:", e, "msg:", n), e !== null ? (console.log("Sending via vscode.postMessage"), e.postMessage(n)) : (console.log("Sending via window.sendMessageFromUI"), window.sendMessageFromUI(n));
+    console.log("Cabbage.sendParameterUpdate:", e, "vscode:", a, "msg:", n), a !== null ? (console.log("Sending via vscode.postMessage"), a.postMessage(n)) : (console.log("Sending via window.sendMessageFromUI"), window.sendMessageFromUI(n));
   }
-  static sendCustomCommand(a, e = null) {
+  static sendCustomCommand(e, a = null) {
     const n = {
-      command: a,
+      command: e,
       text: JSON.stringify({})
     };
-    console.log("Cabbage: sending custom command from UI", n), e !== null ? e.postMessage(n) : window.sendMessageFromUI(n);
+    console.log("Cabbage: sending custom command from UI", n), a !== null ? a.postMessage(n) : window.sendMessageFromUI(n);
   }
-  static sendWidgetUpdate(a, e = null) {
-    console.log("Cabbage: sending widget update from UI", a.props);
+  static sendWidgetUpdate(e, a = null) {
+    console.log("Cabbage: sending widget update from UI", e.props);
     const n = {
       command: "widgetStateUpdate",
-      obj: JSON.stringify(CabbageUtils.sanitizeForEditor(a))
+      obj: JSON.stringify(CabbageUtils.sanitizeForEditor(e))
     };
-    e !== null ? e.postMessage(n) : window.sendMessageFromUI(n);
+    a !== null ? a.postMessage(n) : window.sendMessageFromUI(n);
   }
-  static sendMidiMessageFromUI(a, e, n, s = null) {
-    var t = {
-      statusByte: a,
-      dataByte1: e,
+  static sendMidiMessageFromUI(e, a, n, t = null) {
+    var s = {
+      statusByte: e,
+      dataByte1: a,
       dataByte2: n
     };
     const o = {
       command: "midiMessage",
-      obj: JSON.stringify(t)
+      obj: JSON.stringify(s)
     };
-    console.log("Cabbage: sending midi message from UI", t), s !== null ? s.postMessage(o) : window.sendMessageFromUI(o);
+    console.log("Cabbage: sending midi message from UI", s), t !== null ? t.postMessage(o) : window.sendMessageFromUI(o);
   }
-  static sendChannelData(a, e, n = null) {
-    var s = {
-      channel: a
+  static sendChannelData(e, a, n = null) {
+    var t = {
+      channel: e
     };
-    if (typeof e == "string")
-      s.stringData = e;
-    else if (typeof e == "number")
-      s.floatData = e;
+    if (typeof a == "string")
+      t.stringData = a;
+    else if (typeof a == "number")
+      t.floatData = a;
     else {
-      console.warn("Cabbage: sendChannelData received unsupported data type:", typeof e);
+      console.warn("Cabbage: sendChannelData received unsupported data type:", typeof a);
       return;
     }
-    const t = {
+    const s = {
       command: "channelData",
-      obj: JSON.stringify(s)
+      obj: JSON.stringify(t)
     };
-    console.log("Cabbage: sending channel data from UI", s), n !== null ? n.postMessage(t) : window.sendMessageFromUI(t);
+    console.log("Cabbage: sending channel data from UI", t), n !== null ? n.postMessage(s) : window.sendMessageFromUI(s);
   }
-  static MidiMessageFromHost(a, e, n) {
-    console.log("Cabbage: Got MIDI Message" + a + ":" + e + ":" + n);
+  static MidiMessageFromHost(e, a, n) {
+    console.log("Cabbage: Got MIDI Message" + e + ":" + a + ":" + n);
   }
-  static triggerFileOpenDialog(a, e, n = {}) {
-    var s = {
-      channel: e,
+  static triggerFileOpenDialog(e, a, n = {}) {
+    var t = {
+      channel: a,
       directory: n.directory || "",
       filters: n.filters || "*",
       openAtLastKnownLocation: n.openAtLastKnownLocation !== void 0 ? n.openAtLastKnownLocation : !0
     };
-    const t = {
+    const s = {
       command: "fileOpen",
-      obj: JSON.stringify(s)
+      obj: JSON.stringify(t)
     };
-    a !== null ? a.postMessage(t) : window.sendMessageFromUI(t);
+    e !== null ? e.postMessage(s) : window.sendMessageFromUI(s);
   }
-  static openUrl(a, e, n) {
-    var s = {
-      url: e,
+  static openUrl(e, a, n) {
+    var t = {
+      url: a,
       file: n
     };
-    const t = {
+    const s = {
       command: "openUrl",
-      obj: JSON.stringify(s)
+      obj: JSON.stringify(t)
     };
-    a !== null ? a.postMessage(t) : window.sendMessageFromUI(t);
+    e !== null ? e.postMessage(s) : window.sendMessageFromUI(s);
   }
 }
-const f = (r) => {
-  const [a, e] = u();
-  return m(() => {
-    const n = (s) => {
-      const { id: t, widgetJson: o, command: l } = s.data;
-      if (t === r && o && l === "widgetUpdate") {
+const u = (r) => {
+  const [e, a] = m();
+  return c(() => {
+    const n = (t) => {
+      const { id: s, widgetJson: o, command: l } = t.data;
+      if (s === r && o && l === "widgetUpdate") {
         const i = JSON.parse(o);
         console.log(
-          `[Cabbage-React] Received properties for channelId ${t}`,
+          `[Cabbage-React] Received properties for channelId ${s}`,
           i
-        ), e(i);
+        ), a(i);
       }
     };
     return window.addEventListener("message", n), () => {
       window.removeEventListener("message", n);
     };
   }, []), {
-    properties: a
+    properties: e
   };
-}, b = (r, a) => {
-  const { properties: e } = f(r), [n, s] = u(), t = (o) => {
-    s(o);
+}, p = (r) => {
+  const { properties: e } = u(r), [a, n] = m(), t = (s, o) => {
+    n(s);
     const l = {
-      paramIdx: a,
       channel: r,
-      value: o
+      value: s,
+      stringData: o
     };
-    c.sendParameterUpdate(l, null);
+    d.sendParameterUpdate(l, null);
   };
-  return m(() => {
-    var d;
-    const o = e == null ? void 0 : e.value;
-    if (o != null) {
+  return c(() => {
+    var i;
+    const s = e == null ? void 0 : e.value;
+    if (s != null) {
       console.log(
         `[Cabbage-React] Received initial value for channelId "${r}"`,
-        o
-      ), s(o);
+        s
+      ), n(s);
       return;
     }
-    const l = e == null ? void 0 : e.channels.find(
+    const o = e == null ? void 0 : e.channels.find(
       (g) => g.id === r
     );
-    if (!l) return;
-    const i = (d = l.range) == null ? void 0 : d.defaultValue;
-    n === void 0 && i !== void 0 && (console.log(
-      `[Cabbage-React] Received default value for channelId "${l.id}"`,
-      i
-    ), s(i));
-  }, [e]), m(() => {
-    const o = (l) => {
-      const { command: i } = l.data;
-      if (i === "parameterChange") {
-        const { value: d, paramIdx: g } = l.data;
-        if (g !== a || d === null) return;
+    if (!o) return;
+    const l = (i = o.range) == null ? void 0 : i.defaultValue;
+    a === void 0 && l !== void 0 && (console.log(
+      `[Cabbage-React] Received default value for channelId "${o.id}"`,
+      l
+    ), n(l));
+  }, [e]), c(() => {
+    const s = (o) => {
+      const { command: l } = o.data;
+      if (l === "parameterChange") {
+        const { value: i, paramIdx: g } = o.data;
+        if (i === null) return;
         console.log(
           `[Cabbage-React] Received value change for parameterIndex ${g}`,
-          d
-        ), s(d);
+          i
+        ), n(i);
       }
     };
-    return window.addEventListener("message", o), () => {
-      window.removeEventListener("message", o);
+    return window.addEventListener("message", s), () => {
+      window.removeEventListener("message", s);
     };
   }, []), {
-    value: n,
+    value: a,
     setValue: t
   };
 };
 export {
-  c as Cabbage,
-  f as useCabbageProperties,
-  b as useCabbageState
+  d as Cabbage,
+  u as useCabbageProperties,
+  p as useCabbageState
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "cabbage-react",
-	"version": "1.0.2",
+	"version": "1.0.3",
 	"type": "module",
 	"keywords": [
 		"cabbage",