add endpoint to fetch examples to current working dir

Author: MFA-X-AI

src/commands/CommandIDs.tsx

@@ -44,5 +44,6 @@ export const commandIDs = {
   createNewXircuitInCurrentDir: "Xircuit-filebrowser:create-new-in-current-dir",
   helpOpenResource: "xircuits-help:open-resource",
   openXircuitsConfiguration: "xircuits-config:open-config",
-  fetchRemoteRunConfig: "xircuits-config:fetch-remote-config"
+  fetchRemoteRunConfig: "xircuits-config:fetch-remote-config",
+  fetchExamples: "xircuits-examples:fetch-xircuits-examples"
 };

src/index.tsx

@@ -591,6 +591,13 @@ const xircuits: JupyterFrontEndPlugin<void> = {
         return new Set();
       }
     }
+    app.commands.addCommand(commandIDs.fetchExamples, {
+      label: 'Fetch Example Workflows',
+      caption: 'Fetch example workflows into the examples directory',
+      execute: async () => {
+        await requestAPI('examples', { method: 'POST' });
+      }
+    });
 
     function registerTemplateButton(
       id: string,
@@ -624,16 +631,16 @@ const xircuits: JupyterFrontEndPlugin<void> = {
             installedLibs.add(lib);
             }
 
+          // Currently the templates are stored at the `examples` dir
+          await app.commands.execute(commandIDs.fetchExamples);
+
           const model = await app.serviceManager.contents.copy(
             examplePath,
-            currentPath || ''          
+            currentPath || ''
           );
 
           const finalPath = model.path;    
 
-          // small delay to avoid the empty-canvas race
-          await new Promise(res => setTimeout(res, 200));
-
           // Open the file and refresh the component list
           await app.commands.execute('docmanager:open', { path: finalPath });
           await app.commands.execute(commandIDs.refreshComponentList);

xircuits/handlers/__init__.py

@@ -5,7 +5,7 @@
 from .config import RunConfigRouteHandler, SplitModeConfigHandler
 from .debugger import DebuggerRouteHandler
 from .request_library import InstallLibraryRouteHandler, FetchLibraryRouteHandler, UninstallLibraryRouteHandler, GetLibraryDirectoryRouteHandler, GetLibraryReadmeRouteHandler, GetLibraryExampleRouteHandler, ReloadComponentLibraryConfigHandler, GetComponentLibraryConfigHandler, CreateNewLibraryHandler
-
+from .request_examples import FetchExamplesRouteHandler
 
 def setup_handlers(web_app, url_path):
     host_pattern = ".*$"
@@ -29,6 +29,10 @@ def setup_handlers(web_app, url_path):
             url_path_join(base_url, url_path, "components/"),
             ComponentsRouteHandler
         ),
+        (
+            url_path_join(base_url, url_path, "examples/"),
+            FetchExamplesRouteHandler
+        ),
         (
             url_path_join(base_url, url_path, "file/compile"),
             CompileXircuitsFileRouteHandler

xircuits/handlers/request_examples.py

@@ -0,0 +1,38 @@
+import os
+import json
+import traceback
+import tornado
+from http import HTTPStatus
+from pathlib import Path
+from jupyter_server.base.handlers import APIHandler
+from xircuits.utils import is_empty, copy_from_installed_wheel
+from xircuits.start_xircuits import find_xircuits_working_dir, init_xircuits
+
+class FetchExamplesRouteHandler(APIHandler):
+    """
+    API Handler to fetch example workflows into the Xircuits working directory.
+    """
+    @tornado.web.authenticated
+    def post(self):
+        try:
+            # Determine the Xircuits working directory (where xai_components exists)
+            working_dir = find_xircuits_working_dir()
+            if working_dir is None:
+                self.set_status(HTTPStatus.BAD_REQUEST)
+                return self.finish(json.dumps({
+                    "error": "Xircuits is not initialized. Please run 'xircuits init' or set XIRCUITS_INIT."}))
+
+            examples_dir = working_dir / "examples"
+            # Only copy if directory is missing or empty
+            if not examples_dir.exists() or is_empty(str(examples_dir)):
+                # Copy into the working directory
+                copy_from_installed_wheel('examples', resource='', dest_path=str(examples_dir))
+                message = "Examples have been fetched and saved to the 'examples' folder."
+            else:
+                message = "Examples folder already exists and is not empty."
+
+            self.finish(json.dumps({"status": "OK", "message": message}))
+        except Exception as e:
+            self.set_status(HTTPStatus.INTERNAL_SERVER_ERROR)
+            error_msg = f"An error occurred while fetching examples: {traceback.format_exc()}"
+            self.finish(json.dumps({"error": error_msg}))