@elementor/editor-variables 3.35.0-469 → 3.35.0-471

package/dist/index.js

@@ -3425,240 +3425,119 @@ var trackOpenVariablePopover = (path, variableType) => {
   });
 };
 
-// src/mcp/create-variable-tool.ts
-var import_editor_mcp = require("@elementor/editor-mcp");
+// src/mcp/manage-variable-tool.ts
+var import_editor_mcp2 = require("@elementor/editor-mcp");
 var import_schema3 = require("@elementor/schema");
-var InputSchema = {
-  type: import_schema3.z.string().describe('The type of the variable. Example values: "global-color-variable" or "global-font-variable".'),
-  label: import_schema3.z.string().describe("The label of the variable, displayed to the user"),
-  value: import_schema3.z.string().describe("The value of the variable, should correspond to the type")
-};
-var OutputSchema = {
-  status: import_schema3.z.enum(["ok", "error"]).describe("The status of the operation"),
-  message: import_schema3.z.string().optional().describe("Optional message providing additional information about the operation")
-};
-var initCreateVariableTool = () => {
-  (0, import_editor_mcp.getMCPByDomain)("canvas").addTool({
-    name: "create-global-variable",
-    schema: InputSchema,
-    outputSchema: OutputSchema,
-    modelPreferences: {
-      intelligencePriority: 0.7,
-      speedPriority: 0.7
-    },
-    description: `Create a new global variable
-## When to use this tool:
-- When a user requests to create a new global variable in the Elementor editor.
-- When you need to add a new variable to be used in the editor.
-
-## Prequisites:
-- Ensure you have the most up-to-date list of existing global variables to avoid label duplication. You can use the "list-global-variables" tool to fetch the current variables.
-- Make sure when creating a new variable, the label is unique and not already in use.
-- If the user does not provide a label, ask them to provide one before proceeding.
-- If the user does not provide a type, ask them to provide one before proceeding.
-- If the user does not provide a value, ask them to provide one before proceeding.
-
-## Required parameters:
-- type: The type of the variable. Possible values are 'global-color-variable' or 'global-font-variable'.
-- label: The label of the variable, displayed to the user. Must be unique and not already in use.
-- value: The value of the variable. For color variables, this should be a valid CSS color (e.g., 'rgb(255,0,0)', '#ff0000', 'red'). For font variables, this should be a valid font family (e.g., 'Arial', 'serif').
-
-## Example tool call (JSON format):
-\`\`\`json
-{ "type": "global-color-variable", "label": "My Cool Color", "value": "rgb(1,2,3)" }
-\`\`\`
-
-## Example tool response (JSON format):
-\`\`\`json
-{ "status": "ok" }
-\`\`\`
-
-## Example to a failed tool response, which must be displayed to the end user. If the error message is not plain, attempt to find the most useful part of the message and display it.
-{ "status": "error", "message": "Unsupported type 'global-kuku-variable'" }
-
-In that case, inform the user the type is unsupported and they should try another type, perhaps consult to online documentation.
-`,
-    handler: async (params) => {
-      const { type, label, value } = params;
-      try {
-        await service.create({ type, label, value });
-      } catch (error) {
-        const message = error.message || "Unknown server error";
-        return {
-          status: "error",
-          message: `There was an error creating the variable: ${message}`
-        };
-      }
-      return { status: "ok" };
-    }
-  });
-};
 
-// src/mcp/delete-variable-tool.ts
-var import_editor_mcp2 = require("@elementor/editor-mcp");
-var import_schema4 = require("@elementor/schema");
-var initDeleteVariableTool = () => {
-  (0, import_editor_mcp2.getMCPByDomain)("canvas").addTool({
-    name: "delete-global-variable",
-    schema: {
-      id: import_schema4.z.string().describe("The unique identifier of the variable to be deleted.")
-    },
-    outputSchema: {
-      status: import_schema4.z.enum(["ok", "error"]).describe("The status of the operation")
-    },
-    modelPreferences: {
-      intelligencePriority: 0.7,
-      speedPriority: 0.8
-    },
-    description: `Delete an existing global variable
-    
-## When to use this tool:
-- When a user requests to delete an existing global variable in the Elementor editor.
-- When you need to remove a variable that is no longer needed or relevant, with the user's confirmation.
-
-## Prerequisites:
-- Ensure you have the most up-to-date list of existing global variables. You can use the "list-global-variables" tool to fetch the current variables.
-- Reference the variable by the "id" property, given from the "list-global-variables" tool.
-- Make sure you have the unique identifier of the variable to be deleted before using this tool.
-- Confirm with the user that they want to proceed with the deletion, as this action is irreversible.
-
-<notice>
-A use might reference a variable by it's label, but you must always use the unique identifier (id) to delete it.
-If you only have the label, use the "list-global-variables" tool to find the corresponding id.
-</notice>
-
-<important>
-This operation is destructive and cannot be undone. Ensure that the user is fully aware of the consequences before proceeding.
-When a variable is deleted, all references to it in all pages accross the website will lose their effect.
-</important>`,
-    handler: async (params) => {
-      const { id: id2 } = params;
-      try {
-        await service.delete(id2);
-        return { status: "ok" };
-      } catch (err) {
+// src/mcp/variables-resource.ts
+var import_editor_mcp = require("@elementor/editor-mcp");
+var GLOBAL_VARIABLES_URI = "elementor://global-variables";
+var initVariablesResource = () => {
+  const canvasMcpEntry = (0, import_editor_mcp.getMCPByDomain)("canvas");
+  const variablesMcpEntry = (0, import_editor_mcp.getMCPByDomain)("variables");
+  [canvasMcpEntry, variablesMcpEntry].forEach((entry) => {
+    const { mcpServer } = entry;
+    mcpServer.resource(
+      "global-variables",
+      GLOBAL_VARIABLES_URI,
+      {
+        description: "List of Global variables. Defined as a key-value store (ID as key, global-variable object as value)"
+      },
+      async () => {
+        const variables = {};
+        Object.entries(service.variables()).forEach(([id2, variable]) => {
+          if (!variable.deleted) {
+            variables[id2] = variable;
+          }
+        });
         return {
-          status: "error"
+          contents: [{ uri: GLOBAL_VARIABLES_URI, text: JSON.stringify(variables) }]
         };
       }
-    },
-    isDestrcutive: true
+    );
+    window.addEventListener("variables:updated", () => {
+      mcpServer.server.sendResourceUpdated({
+        uri: GLOBAL_VARIABLES_URI,
+        contents: [{ uri: GLOBAL_VARIABLES_URI, text: localStorage["elementor-global-variables"] }]
+      });
+    });
   });
 };
 
-// src/mcp/update-variable-tool.ts
-var import_editor_mcp3 = require("@elementor/editor-mcp");
-var import_schema5 = require("@elementor/schema");
-var initUpdateVariableTool = () => {
-  (0, import_editor_mcp3.getMCPByDomain)("canvas").addTool({
+// src/mcp/manage-variable-tool.ts
+var initManageVariableTool = () => {
+  (0, import_editor_mcp2.getMCPByDomain)("variables").addTool({
+    name: "manage-global-variable",
     schema: {
-      id: import_schema5.z.string().describe("The unique identifier of the variable to be updated or renamed."),
-      label: import_schema5.z.string().describe(
-        "The label of the variable to be stored after the change. If the user only wishes to update the value, this must be strictly equal to the current label."
-      ),
-      value: import_schema5.z.string().describe(
-        "The new value for the variable. For color variables, this should be a valid CSS color (e.g., 'rgb(255,0,0)', '#ff0000', 'red'). For font variables, this should be a valid font family (e.g., 'Arial', 'serif'). If the user wishes to rename only, make sure you provide the existing value."
-      )
+      action: import_schema3.z.enum(["create", "update", "delete"]).describe("Operation to perform"),
+      id: import_schema3.z.string().optional().describe("Variable id (required for update/delete). Get from list-global-variables."),
+      type: import_schema3.z.string().optional().describe('Variable type: "global-color-variable" or "global-font-variable" (required for create)'),
+      label: import_schema3.z.string().optional().describe("Variable label (required for create/update)"),
+      value: import_schema3.z.string().optional().describe("Variable value (required for create/update)")
     },
     outputSchema: {
-      status: import_schema5.z.enum(["ok", "error"]).describe("The status of the operation"),
-      message: import_schema5.z.string().optional().describe("Optional message providing additional information about the operation")
+      status: import_schema3.z.enum(["ok"]).describe("Operation status"),
+      message: import_schema3.z.string().optional().describe("Error details if status is error")
     },
-    name: "update-global-variable",
     modelPreferences: {
       intelligencePriority: 0.75,
-      speedPriority: 0.7
+      speedPriority: 0.75
     },
-    description: `Update an existing global variable
-
-## When to use this tool:
-- When a user requests to update an existing global variable in the Elementor editor.
-- When you need to modify the value of an existing variable.
-- When you want to rename an existing variable (change its label).
-- When you want to both rename and modify the value of an existing variable.
-
-## Prerequisites:
-- Ensure you have the most up-to-date list of existing global variables to avoid label duplication. You can use the "list-global-variables" tool to fetch the current variables.
-- Make sure when updating a variable, the new label is unique and not already in use by another variable.
-- Make sure you understand whether you are updating a value, renaming, or both.
-- Reference the variable by the "id" property, given from the "list-global-variables" tool.
-- If the user wishes to rename, make sure you have the existing value.
-- If the user wishes to update the value, make sure you have to **correct label**.
-- You must have the unique identifier, the current label, the current value, and the new value or label or both, before using this tool.
-
-## Required parameters:
-- id: The unique identifier of the variable to be updated or renamed.
-- label: The label of the variable to be stored after the change. If the user only wishes to update the value, this must be strictly equal to the current label.
-- value: The new value for the variable. For color variables, this should be a valid CSS color (e.g., 'rgb(255,0,0)', '#ff0000', 'red'). For font variables, this should be a valid font family (e.g., 'Arial', 'serif'). If the user wishes to rename only, make sure you provide the existing value.
-
-## Example tool call (JSON format):
-\`\`\`json
-{ "id": "some-unique-id", "label": "Cool", "value": "rgb(0,140,250)" }
-\`\`\`
-
-## Example responses (JSON format):
-Successful update:
-\`\`\`json
-{ "status": "ok" }
-\`\`\`
-
-Failed update, which must be displayed to the end user. If the error message is not plain, attempt to find the most useful part of the message and display it.
-\`\`\`json
-{ "status": "error", "message": "Label 'Cool' is already in use by another variable." }
-\`\`\`
+    requiredResources: [
+      {
+        uri: GLOBAL_VARIABLES_URI,
+        description: "Global variables"
+      }
+    ],
+    description: `Manages global variables (create/update/delete). Existing variables available in resources.
+CREATE: requires type, label, value. Ensure label is unique.
+UPDATE: requires id, label, value. When renaming: keep existing value. When updating value: keep exact label.
+DELETE: requires id. DESTRUCTIVE - confirm with user first.
+
+# NAMING - IMPORTANT
+the variables names should ALWAYS be lowercased and dashed spaced. example: "Headline Primary" should be "headline-primary"
 `,
     handler: async (params) => {
-      const { id: id2, label, value } = params;
-      try {
-        await service.update(id2, { label, value });
-        return { status: "ok" };
-      } catch (error) {
-        const message = error.message || "Unknown server error";
+      const operations = getServiceActions(service);
+      const op = operations[params.action];
+      if (op) {
+        await op(params);
         return {
-          status: "error",
-          message: `There was an error creating the variable: ${message}`
+          status: "ok"
         };
       }
-    }
+      throw new Error(`Unknown action ${params.action}`);
+    },
+    isDestructive: true
+    // Because delete is destructive
   });
 };
-
-// src/mcp/variables-resource.ts
-var import_editor_mcp4 = require("@elementor/editor-mcp");
-var GLOBAL_VARIABLES_URI = "elementor://global-variables";
-var initVariablesResource = () => {
-  const { mcpServer } = (0, import_editor_mcp4.getMCPByDomain)("canvas");
-  mcpServer.resource(
-    "global-variables",
-    GLOBAL_VARIABLES_URI,
-    {
-      description: "List of Global variables. Defined as a key-value store (ID as key, global-variable object as value)"
+function getServiceActions(svc) {
+  return {
+    create({ type, label, value }) {
+      if (!type || !label || !value) {
+        throw new Error("Create requires type, label, and value");
+      }
+      return svc.create({ type, label, value });
     },
-    async () => {
-      const variables = {};
-      Object.entries(service.variables()).forEach(([id2, variable]) => {
-        if (!variable.deleted) {
-          variables[id2] = variable;
-        }
-      });
-      return {
-        contents: [{ uri: GLOBAL_VARIABLES_URI, text: JSON.stringify(variables) }]
-      };
+    update({ id: id2, label, value }) {
+      if (!id2 || !label || !value) {
+        throw new Error("Update requires id, label, and value");
+      }
+      return svc.update(id2, { label, value });
+    },
+    delete({ id: id2 }) {
+      if (!id2) {
+        throw new Error("delete requires id");
+      }
+      return svc.delete(id2);
     }
-  );
-  window.addEventListener("variables:updated", () => {
-    mcpServer.server.sendResourceUpdated({
-      uri: GLOBAL_VARIABLES_URI,
-      contents: [{ uri: GLOBAL_VARIABLES_URI, text: localStorage["elementor-global-variables"] }]
-    });
-  });
-};
+  };
+}
 
 // src/mcp/index.ts
 function initMcp() {
-  initCreateVariableTool();
-  initUpdateVariableTool();
-  initDeleteVariableTool();
+  initManageVariableTool();
   initVariablesResource();
 }
 
@@ -3784,8 +3663,8 @@ var FontField = ({ value, onChange, onValidationChange }) => {
 
 // src/prop-types/size-variable-prop-type.ts
 var import_editor_props4 = require("@elementor/editor-props");
-var import_schema6 = require("@elementor/schema");
-var sizeVariablePropTypeUtil = (0, import_editor_props4.createPropUtils)("global-size-variable", import_schema6.z.string());
+var import_schema4 = require("@elementor/schema");
+var sizeVariablePropTypeUtil = (0, import_editor_props4.createPropUtils)("global-size-variable", import_schema4.z.string());
 
 // src/transformers/empty-transformer.tsx
 var import_editor_canvas4 = require("@elementor/editor-canvas");
@@ -3963,28 +3842,17 @@ function hasVariableAssigned(value) {
 }
 
 // src/utils/llm-propvalue-label-resolver.ts
+var defaultResolver = (key) => (value) => {
+  const idOrLabel = String(value);
+  return {
+    $$type: key,
+    value: service.variables()[idOrLabel] ? idOrLabel : service.findIdByLabel(idOrLabel)
+  };
+};
 var globalVariablesLLMResolvers = {
-  "global-color-variable": (value) => {
-    const idOrLabel = String(value);
-    return {
-      $$type: "global-color-variable",
-      value: service.variables()[idOrLabel] ? idOrLabel : service.findIdByLabel(idOrLabel)
-    };
-  },
-  "global-font-variable": (value) => {
-    const idOrLabel = String(value);
-    return {
-      $$type: "global-font-variable",
-      value: service.variables()[idOrLabel] ? idOrLabel : service.findIdByLabel(idOrLabel)
-    };
-  },
-  "global-size-variable": (value) => {
-    const idOrLabel = String(value);
-    return {
-      $$type: "global-size-variable",
-      value: service.variables()[idOrLabel] ? idOrLabel : service.findIdByLabel(idOrLabel)
-    };
-  }
+  "global-color-variable": defaultResolver("global-color-variable"),
+  "global-font-variable": defaultResolver("global-font-variable"),
+  "global-size-variable": defaultResolver("global-size-variable")
 };
 
 // src/index.ts