Move post mutation helpers to hooks files

Author: jonkafton

frontends/api/src/hooks/learningResources/index.ts

@@ -1,6 +1,5 @@
 import {
   UseQueryOptions,
-  // useInfiniteQuery,
   useMutation,
   useQuery,
   useQueryClient,
@@ -16,8 +15,9 @@ import type {
   PaginatedLearningResourceList,
   LearningResourcesApiLearningResourcesUserlistsPartialUpdateRequest,
   LearningResourcesApiLearningResourcesLearningPathsPartialUpdateRequest,
+  MicroUserListRelationship,
 } from "../../generated/v1"
-import learningResources, { updateListParents } from "./keyFactory"
+import learningResources from "./keyFactory"
 import { invalidateResourceQueries } from "./invalidation"
 import { invalidateUserListQueries } from "../userLists/invalidation"
 
@@ -144,6 +144,41 @@ const useSchoolsList = () => {
   return useQuery(learningResources.schools())
 }
 
+/**
+ * Given
+ *  - a LearningResource ID
+ *  - a paginated list of current resources
+ *  - a list of new relationships
+ *  - the type of list
+ * Update the resources' user_list_parents field to include the new relationships
+ */
+const updateListParents = (
+  resourceId: number,
+  staleResources?: PaginatedLearningResourceList,
+  newRelationships?: MicroUserListRelationship[],
+  listType?: "userlist" | "learningpath",
+) => {
+  if (!resourceId || !staleResources || !newRelationships || !listType)
+    return staleResources
+  const matchIndex = staleResources.results.findIndex(
+    (res) => res.id === resourceId,
+  )
+  if (matchIndex === -1) return staleResources
+  const updatedResults = [...staleResources.results]
+  const newResource = { ...updatedResults[matchIndex] }
+  if (listType === "userlist") {
+    newResource.user_list_parents = newRelationships
+  }
+  if (listType === "learningpath") {
+    newResource.learning_path_parents = newRelationships
+  }
+  updatedResults[matchIndex] = newResource
+  return {
+    ...staleResources,
+    results: updatedResults,
+  }
+}
+
 export {
   useLearningResourcesList,
   useFeaturedLearningResourcesList,

frontends/api/src/hooks/learningResources/invalidation.ts

@@ -106,8 +106,4 @@ const resourceHasUserList =
     )
   }
 
-export {
-  invalidateResourceQueries,
-  // invalidateUserListQueries,
-  invalidateResourceWithUserListQueries,
-}
+export { invalidateResourceQueries, invalidateResourceWithUserListQueries }

frontends/api/src/hooks/learningResources/keyFactory.ts

@@ -3,27 +3,19 @@ import {
   learningResourcesApi,
   learningResourcesSearchApi,
   topicsApi,
-  // userListsApi,
   offerorsApi,
   platformsApi,
   schoolsApi,
   featuredApi,
 } from "../../clients"
-// import axiosInstance from "../../axios"
 import type {
   LearningResource,
-  LearningResourcesApiLearningResourcesListRequest as LRListRequest,
+  LearningResourcesApiLearningResourcesListRequest as LearningResourcesListRequest,
   TopicsApiTopicsListRequest as TopicsListRequest,
-  PaginatedLearningResourceList,
-  LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest as LRSearchRequest,
-  // UserlistsApiUserlistsItemsListRequest as ULResourcesListRequest,
-  // UserlistsApiUserlistsListRequest as ULListRequest,
-  // PaginatedUserListRelationshipList,
+  LearningResourcesSearchApiLearningResourcesSearchRetrieveRequest as LearningResourcesSearchRetrieveRequest,
   OfferorsApiOfferorsListRequest,
   PlatformsApiPlatformsListRequest,
   FeaturedApiFeaturedListRequest as FeaturedListParams,
-  // UserListRelationship,
-  MicroUserListRelationship,
 } from "../../generated/v1"
 
 const shuffle = ([...arr]) => {
@@ -63,7 +55,7 @@ const learningResources = createQueryKeys("learningResources", {
         .learningResourcesRetrieve({ id })
         .then((res) => res.data),
   }),
-  list: (params: LRListRequest) => ({
+  list: (params: LearningResourcesListRequest) => ({
     queryKey: [params],
     queryFn: () =>
       learningResourcesApi
@@ -88,7 +80,7 @@ const learningResources = createQueryKeys("learningResources", {
     queryKey: [params],
     queryFn: () => topicsApi.topicsList(params).then((res) => res.data),
   }),
-  search: (params: LRSearchRequest) => {
+  search: (params: LearningResourcesSearchRetrieveRequest) => {
     return {
       queryKey: [params],
       queryFn: () =>
@@ -122,40 +114,4 @@ const learningResources = createQueryKeys("learningResources", {
   },
 })
 
-/**
- * Given
- *  - a LearningResource ID
- *  - a paginated list of current resources
- *  - a list of new relationships
- *  - the type of list
- * Update the resources' user_list_parents field to include the new relationships
- */
-const updateListParents = (
-  resourceId: number,
-  staleResources?: PaginatedLearningResourceList,
-  newRelationships?: MicroUserListRelationship[],
-  listType?: "userlist" | "learningpath",
-) => {
-  if (!resourceId || !staleResources || !newRelationships || !listType)
-    return staleResources
-  const matchIndex = staleResources.results.findIndex(
-    (res) => res.id === resourceId,
-  )
-  if (matchIndex === -1) return staleResources
-  const updatedResults = [...staleResources.results]
-  const newResource = { ...updatedResults[matchIndex] }
-  if (listType === "userlist") {
-    newResource.user_list_parents = newRelationships
-  }
-  if (listType === "learningpath") {
-    newResource.learning_path_parents = newRelationships
-  }
-  updatedResults[matchIndex] = newResource
-  return {
-    ...staleResources,
-    results: updatedResults,
-  }
-}
-
 export default learningResources
-export { updateListParents }

frontends/api/src/hooks/userLists/index.ts

@@ -18,10 +18,6 @@ import type {
 } from "../../generated/v1"
 // import learningResources from "../learningResources/keyFactory"
 import userLists from "./keyFactory"
-// import {
-//   updateListParentsOnAdd,
-//   updateListParentsOnDestroy,
-// } from "./keyFactory"
 import {
   invalidateResourceWithUserListQueries,
   // invalidateResourceQueries,
@@ -196,6 +192,60 @@ const useUserListListItemMove = () => {
     },
   })
 }
+
+// /**
+//  * Given
+//  *  - a list of learning resources L
+//  *  - a new relationship between learningpath/userlist and a resource R
+//  * Update the list L so that it includes the updated resource R. (If the list
+//  * did not contain R to begin with, no change is made)
+//  */
+// const updateListParentsOnAdd = (
+//   relationship: UserListRelationship,
+//   oldList?: PaginatedLearningResourceList,
+// ) => {
+//   if (!oldList) return oldList
+//   const matchIndex = oldList.results.findIndex(
+//     (res) => res.id === relationship.child,
+//   )
+//   if (matchIndex === -1) return oldList
+//   const updatesResults = [...oldList.results]
+//   updatesResults[matchIndex] = relationship.resource
+//   return {
+//     ...oldList,
+//     results: updatesResults,
+//   }
+// }
+
+// /**
+//  * Given
+//  *  - a list of learning resources L
+//  *  - a destroyed relationship between learningpath/userlist and a resource R
+//  * Update the list L so that it includes the updated resource R. (If the list
+//  * did not contain R to begin with, no change is made)
+//  */
+// const updateListParentsOnDestroy = (
+//   relationship: MicroUserListRelationship,
+//   list?: PaginatedLearningResourceList,
+// ) => {
+//   if (!list) return list
+//   if (!relationship) return list
+//   const matchIndex = list.results.findIndex(
+//     (res) => res.id === relationship.child,
+//   )
+//   if (matchIndex === -1) return list
+//   const updatedResults = [...list.results]
+//   const newResource = { ...updatedResults[matchIndex] }
+//   newResource.user_list_parents =
+//     newResource.user_list_parents?.filter((m) => m.id !== relationship.id) ??
+//     null
+//   updatedResults[matchIndex] = newResource
+//   return {
+//     ...list,
+//     results: updatedResults,
+//   }
+// }
+
 export {
   useUserListList,
   useUserListsDetail,

frontends/api/src/hooks/userLists/keyFactory.ts

@@ -1,12 +1,9 @@
 import { createQueryKeys } from "@lukemorales/query-key-factory"
 import axiosInstance from "../../axios"
 import type {
-  PaginatedLearningResourceList,
   UserlistsApiUserlistsItemsListRequest as ItemsListRequest,
   UserlistsApiUserlistsListRequest as ListRequest,
   PaginatedUserListRelationshipList,
-  UserListRelationship,
-  MicroUserListRelationship,
 } from "../../generated/v1"
 import { userListsApi } from "../../clients"
 
@@ -36,58 +33,4 @@ const userLists = createQueryKeys("userLists", {
   }),
 })
 
-/**
- * Given
- *  - a list of learning resources L
- *  - a new relationship between learningpath/userlist and a resource R
- * Update the list L so that it includes the updated resource R. (If the list
- * did not contain R to begin with, no change is made)
- */
-const updateListParentsOnAdd = (
-  relationship: UserListRelationship,
-  oldList?: PaginatedLearningResourceList,
-) => {
-  if (!oldList) return oldList
-  const matchIndex = oldList.results.findIndex(
-    (res) => res.id === relationship.child,
-  )
-  if (matchIndex === -1) return oldList
-  const updatesResults = [...oldList.results]
-  updatesResults[matchIndex] = relationship.resource
-  return {
-    ...oldList,
-    results: updatesResults,
-  }
-}
-
-/**
- * Given
- *  - a list of learning resources L
- *  - a destroyed relationship between learningpath/userlist and a resource R
- * Update the list L so that it includes the updated resource R. (If the list
- * did not contain R to begin with, no change is made)
- */
-const updateListParentsOnDestroy = (
-  relationship: MicroUserListRelationship,
-  list?: PaginatedLearningResourceList,
-) => {
-  if (!list) return list
-  if (!relationship) return list
-  const matchIndex = list.results.findIndex(
-    (res) => res.id === relationship.child,
-  )
-  if (matchIndex === -1) return list
-  const updatedResults = [...list.results]
-  const newResource = { ...updatedResults[matchIndex] }
-  newResource.user_list_parents =
-    newResource.user_list_parents?.filter((m) => m.id !== relationship.id) ??
-    null
-  updatedResults[matchIndex] = newResource
-  return {
-    ...list,
-    results: updatedResults,
-  }
-}
-
 export default userLists
-export { updateListParentsOnAdd, updateListParentsOnDestroy }