Use notifications API for tool requests

Author: arash77

client/src/api/notifications.ts

@@ -1,3 +1,4 @@
+import { GalaxyApi } from "@/api";
 import type { components } from "@/api/schema";
 
 export type BaseUserNotification = components["schemas"]["UserNotificationResponse"];
@@ -30,16 +31,14 @@ export interface MessageNotificationCreateRequest extends NotificationCreateRequ
 
 export interface ToolRequestNotificationContent {
     category: "tool_request";
-    tool_name: string;
+    tool_names: string[];
     tool_url?: string;
     description: string;
     scientific_domain?: string;
     requested_version?: string;
-    conda_available?: boolean;
-    test_data_available?: boolean;
-    requester_name?: string;
-    requester_email: string;
-    requester_affiliation?: string;
+    requester_email?: string | null;
+    workflow_id?: string;
+    additional_remarks?: string;
 }
 
 export interface ToolRequestNotification extends BaseUserNotification {
@@ -57,3 +56,39 @@ export type NotificationVariants = components["schemas"]["NotificationVariant"];
 
 export type NewSharedItemNotificationContentItemType =
     components["schemas"]["NewSharedItemNotificationContent"]["item_type"];
+
+export interface ToolRequestSubmitContent {
+    tool_names: string[];
+    tool_url?: string;
+    description: string;
+    scientific_domain?: string;
+    requested_version?: string;
+    workflow_id?: string;
+    additional_remarks?: string;
+}
+
+/** Submit a tool-installation request as the authenticated user.
+ *  Returns the encoded notification ID so the caller can link to it.
+ */
+export async function submitUserNotification(content: ToolRequestSubmitContent): Promise<string> {
+    const { data, error } = await GalaxyApi().POST("/api/notifications", {
+        body: {
+            recipients: { user_ids: [], group_ids: [], role_ids: [] },
+            notification: {
+                source: "tool_request_form",
+                category: "tool_request",
+                variant: "info",
+                content: {
+                    category: "tool_request",
+                    ...content,
+                },
+            },
+        },
+    });
+    if (error) {
+        const errorObject = error as { err_msg?: string; message?: string };
+        const message = errorObject.err_msg || errorObject.message || "Failed to submit notification.";
+        throw new Error(message);
+    }
+    return (data as { notification: { id: string } }).notification.id;
+}

client/src/api/schema/schema.ts

@@ -5198,29 +5198,6 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/tool_request_form": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Submit a tool installation request to the instance admins.
-         * @description Submit a request for a new tool to be installed on this Galaxy instance.
-         *
-         *     Sends a notification to all admin users with the submitted request details.
-         *     Requires the notification system and tool request form to be enabled in the configuration.
-         */
-        post: operations["submit_tool_request_api_tool_request_form_post"];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/api/tool_requests/{id}": {
         parameters: {
             query?: never;
@@ -23607,62 +23584,6 @@ export interface components {
             state: components["schemas"]["ToolRequestState"];
             state_message?: components["schemas"]["ToolRequestStateMessage"] | null;
         };
-        /**
-         * ToolRequestFormData
-         * @description The data submitted with the Tool Request Form.
-         */
-        ToolRequestFormData: {
-            /**
-             * Conda available
-             * @description Whether a Conda package for this tool is available.
-             */
-            conda_available?: boolean | null;
-            /**
-             * Description
-             * @description Short description of the tool and its scientific use case.
-             */
-            description: string;
-            /**
-             * Requested version
-             * @description The version of the tool being requested.
-             */
-            requested_version?: string | null;
-            /**
-             * Requester affiliation
-             * @description The affiliation/lab of the requester.
-             */
-            requester_affiliation?: string | null;
-            /**
-             * Scientific domain
-             * @description The scientific domain for the requested tool.
-             */
-            scientific_domain?: string | null;
-            /**
-             * Test data available
-             * @description Whether test data for this tool is available.
-             */
-            test_data_available?: boolean | null;
-            /**
-             * Tool IDs
-             * @description Tool shed tool IDs for workflow install requests.
-             */
-            tool_ids?: string[] | null;
-            /**
-             * Tool name
-             * @description The name of the requested tool.
-             */
-            tool_name: string;
-            /**
-             * Tool URL
-             * @description Homepage or repository URL for the requested tool.
-             */
-            tool_url?: string | null;
-            /**
-             * Workflow name
-             * @description Name of the workflow requiring these tools, if applicable.
-             */
-            workflow_name?: string | null;
-        };
         /** ToolRequestImplicitCollectionReference */
         ToolRequestImplicitCollectionReference: {
             /**
@@ -23708,16 +23629,16 @@ export interface components {
         };
         /** ToolRequestNotificationContent */
         ToolRequestNotificationContent: {
+            /**
+             * Additional remarks
+             * @description Any additional information or context for the request.
+             */
+            additional_remarks?: string | null;
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
              */
             category: "tool_request";
-            /**
-             * Conda available
-             * @description Whether a Conda package for this tool is available.
-             */
-            conda_available?: boolean | null;
             /**
              * Description
              * @description Short description of the tool and its scientific use case.
@@ -23728,51 +23649,31 @@ export interface components {
              * @description The version of the tool being requested.
              */
             requested_version?: string | null;
-            /**
-             * Requester affiliation
-             * @description The affiliation/lab of the requester.
-             */
-            requester_affiliation?: string | null;
             /**
              * Requester email
-             * @description The email address of the requester for follow-up.
+             * @description The email address of the requester for follow-up. This is derived server-side for user submissions.
              */
-            requester_email: string;
-            /**
-             * Requester name
-             * @description The name of the person requesting the tool.
-             */
-            requester_name?: string | null;
+            requester_email?: string | null;
             /**
              * Scientific domain
              * @description The scientific domain for the requested tool.
              */
             scientific_domain?: string | null;
             /**
-             * Test data available
-             * @description Whether test data for this tool is available.
+             * Tool names
+             * @description Names or tool-shed IDs of the requested tools.
              */
-            test_data_available?: boolean | null;
-            /**
-             * Tool IDs
-             * @description Tool shed tool IDs for workflow install requests.
-             */
-            tool_ids?: string[] | null;
-            /**
-             * Tool name
-             * @description The name of the requested tool.
-             */
-            tool_name: string;
+            tool_names: string[];
             /**
              * Tool URL
-             * @description Homepage or repository URL for the requested tool.
+             * @description Homepage or repository URL for the requested tool (single-tool requests only).
              */
             tool_url?: string | null;
             /**
-             * Workflow name
-             * @description Name of the workflow requiring these tools, if applicable.
+             * Workflow ID
+             * @description Encoded ID of the workflow requiring these tools, if applicable.
              */
-            workflow_name?: string | null;
+            workflow_id?: string | null;
         };
         /**
          * ToolRequestState
@@ -46658,49 +46559,6 @@ export interface operations {
             };
         };
     };
-    submit_tool_request_api_tool_request_form_post: {
-        parameters: {
-            query?: never;
-            header?: {
-                /** @description The user ID that will be used to effectively make this API call. Only admins and designated users can make API calls on behalf of other users. */
-                "run-as"?: string | null;
-            };
-            path?: never;
-            cookie?: never;
-        };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["ToolRequestFormData"];
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            204: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content?: never;
-            };
-            /** @description Request Error */
-            "4XX": {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["MessageExceptionModel"];
-                };
-            };
-            /** @description Server Error */
-            "5XX": {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["MessageExceptionModel"];
-                };
-            };
-        };
-    };
     get_tool_request_api_tool_requests__id__get: {
         parameters: {
             query?: never;