get read only endpoints of user objects from js package

ocadotechnology · Jul 8, 2024 · 9c0154e · 9c0154e
1 parent 5ae4951
commit 9c0154e
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 107 deletions.
diff --git a/src/api/authFactor.ts b/src/api/authFactor.ts
@@ -1,19 +1,22 @@
-import { urls, type AuthFactor } from "codeforlife/api"
+import {
+  getReadAuthFactorEndpoints,
+  urls,
+  type AuthFactor,
+} from "codeforlife/api"
 import {
   buildUrl,
   tagData,
   type CreateArg,
   type CreateResult,
   type DestroyArg,
   type DestroyResult,
-  type ListArg,
-  type ListResult,
 } from "codeforlife/utils/api"
 
 import api from "."
 
 const authFactorApi = api.injectEndpoints({
   endpoints: build => ({
+    ...getReadAuthFactorEndpoints(build),
     createAuthFactor: build.mutation<
       CreateResult<AuthFactor>,
       CreateArg<AuthFactor, "type">
@@ -31,13 +34,6 @@ const authFactorApi = api.injectEndpoints({
       }),
       invalidatesTags: tagData("AuthFactor"),
     }),
-    listAuthFactors: build.query<ListResult<AuthFactor, "type">, ListArg>({
-      query: search => ({
-        url: buildUrl(urls.authFactor.list, { search }),
-        method: "GET",
-      }),
-      providesTags: tagData("AuthFactor"),
-    }),
   }),
 })
 

diff --git a/src/api/klass.ts b/src/api/klass.ts
@@ -1,15 +1,11 @@
-import { urls, type Class } from "codeforlife/api"
+import { getReadClassEndpoints, urls, type Class } from "codeforlife/api"
 import {
   buildUrl,
   tagData,
   type CreateArg,
   type CreateResult,
   type DestroyArg,
   type DestroyResult,
-  type ListArg,
-  type ListResult,
-  type RetrieveArg,
-  type RetrieveResult,
   type UpdateArg,
   type UpdateResult,
 } from "codeforlife/utils/api"
@@ -18,6 +14,7 @@ import api from "."
 
 const classApi = api.injectEndpoints({
   endpoints: build => ({
+    ...getReadClassEndpoints(build),
     createClass: build.mutation<
       CreateResult<Class>,
       CreateArg<
@@ -54,40 +51,6 @@ const classApi = api.injectEndpoints({
       }),
       invalidatesTags: tagData("Class"),
     }),
-    retrieveClass: build.query<
-      RetrieveResult<
-        Class,
-        | "name"
-        | "read_classmates_data"
-        | "receive_requests_until"
-        | "school"
-        | "teacher"
-      >,
-      RetrieveArg<Class>
-    >({
-      query: id => ({
-        url: buildUrl(urls.class.detail, { url: { id } }),
-        method: "GET",
-      }),
-      providesTags: tagData("Class"),
-    }),
-    listClasses: build.query<
-      ListResult<
-        Class,
-        | "name"
-        | "read_classmates_data"
-        | "receive_requests_until"
-        | "school"
-        | "teacher"
-      >,
-      ListArg
-    >({
-      query: search => ({
-        url: buildUrl(urls.class.list, { search }),
-        method: "GET",
-      }),
-      providesTags: tagData("Class"),
-    }),
   }),
 })
 

diff --git a/src/api/school.ts b/src/api/school.ts
@@ -1,11 +1,9 @@
-import { urls, type School } from "codeforlife/api"
+import { getReadSchoolEndpoints, urls, type School } from "codeforlife/api"
 import {
   buildUrl,
   tagData,
   type CreateArg,
   type CreateResult,
-  type RetrieveArg,
-  type RetrieveResult,
   type UpdateArg,
   type UpdateResult,
 } from "codeforlife/utils/api"
@@ -14,16 +12,7 @@ import api from "."
 
 const schoolApi = api.injectEndpoints({
   endpoints: build => ({
-    retrieveSchool: build.query<
-      RetrieveResult<School, "name" | "country" | "uk_county">,
-      RetrieveArg<School>
-    >({
-      query: id => ({
-        url: buildUrl(urls.school.detail, { url: { id } }),
-        method: "GET",
-      }),
-      providesTags: tagData("School"),
-    }),
+    ...getReadSchoolEndpoints(build),
     createSchool: build.mutation<
       CreateResult<School>,
       CreateArg<School, "name", "country" | "uk_county">

diff --git a/src/api/user.ts b/src/api/user.ts
@@ -1,4 +1,4 @@
-import { urls, type User } from "codeforlife/api"
+import { getReadUserEndpoints, urls, type User } from "codeforlife/api"
 import {
   buildUrl,
   tagData,
@@ -7,10 +7,6 @@ import {
   type CreateResult,
   type DestroyArg,
   type DestroyResult,
-  type ListArg,
-  type ListResult,
-  type RetrieveArg,
-  type RetrieveResult,
   type UpdateArg,
   type UpdateResult,
 } from "codeforlife/utils/api"
@@ -19,6 +15,7 @@ import api from "."
 
 const userApi = api.injectEndpoints({
   endpoints: build => ({
+    ...getReadUserEndpoints(build),
     handleJoinClassRequest: build.mutation<
       UpdateResult<User>,
       UpdateArg<User, never, "first_name", { accept: boolean }>
@@ -101,46 +98,6 @@ const userApi = api.injectEndpoints({
         body,
       }),
     }),
-    retrieveUser: build.query<
-      RetrieveResult<
-        User,
-        | "first_name"
-        | "last_name"
-        | "email"
-        | "is_active"
-        | "date_joined"
-        | "requesting_to_join_class"
-        | "student"
-        | "teacher"
-      >,
-      RetrieveArg<User>
-    >({
-      query: id => ({
-        url: buildUrl(urls.user.detail, { url: { id } }),
-        method: "GET",
-      }),
-      providesTags: tagData("User"),
-    }),
-    listUsers: build.query<
-      ListResult<
-        User,
-        | "first_name"
-        | "last_name"
-        | "email"
-        | "is_active"
-        | "date_joined"
-        | "requesting_to_join_class"
-        | "student"
-        | "teacher"
-      >,
-      ListArg<{ students_in_class: string }>
-    >({
-      query: search => ({
-        url: buildUrl(urls.user.list, { search }),
-        method: "GET",
-      }),
-      providesTags: tagData("User"),
-    }),
   }),
 })