fix: Fix typing issues with mutations

openedx · Nov 27, 2023 · 9271338 · 9271338
1 parent 313728b
commit 9271338
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/src/content-tags-drawer/data/api.js b/src/content-tags-drawer/data/api.js
@@ -9,7 +9,7 @@ export const getContentDataApiUrl = (contentId) => new URL(`/xblock/outline/${co
 
 /**
  * Get all tags that belong to taxonomy.
- * @param {string} taxonomyId The id of the taxonomy to fetch tags for
+ * @param {number} taxonomyId The id of the taxonomy to fetch tags for
  * @param {string} fullPathProvided Optional param that contains the full URL to fetch data
  *                 If provided, we use it instead of generating the URL. This is usually for fetching subTags
  * @returns {Promise<Object>}

diff --git a/src/content-tags-drawer/data/apiHooks.jsx b/src/content-tags-drawer/data/apiHooks.jsx
@@ -47,16 +47,22 @@ export const useContentData = (contentId) => (
 
 /**
  * Builds the mutation to update the tags applied to the content object
+ * @param {string} contentId The id of the content object to update tags for
+ * @param {number} taxonomyId The id of the taxonomy the tags belong to
  */
 export const useContentTaxonomyTagsMutation = (contentId, taxonomyId) => {
   const queryClient = useQueryClient();
 
-  /**
-   * @type {
-   *   import("@tanstack/react-query").MutateFunction<any, any, {contentId: string, taxonomyId: number, tags: string[]}>
-   * }
-   */
   return useMutation({
+    /**
+     * @type {import("@tanstack/react-query").MutateFunction<
+     *   any,
+     *   any,
+     *   {
+     *     tags: string[]
+     *   }
+     * >}
+     */
     mutationFn: ({ tags }) => updateContentTaxonomyTags(contentId, taxonomyId, tags),
     onSettled: () => {
       queryClient.invalidateQueries({ queryKey: ['contentTaxonomyTags', contentId] });

diff --git a/src/content-tags-drawer/data/apiHooks.test.jsx b/src/content-tags-drawer/data/apiHooks.test.jsx
@@ -77,7 +77,7 @@ describe('useContentTaxonomyTagsMutation', () => {
     useMutation.mockReturnValueOnce({ mutate: jest.fn() });
 
     const mutation = useContentTaxonomyTagsMutation();
-    mutation.mutate();
+    mutation.mutate({ tags: ['a', 'b', 'c'] });
 
     expect(useMutation).toBeCalled();