@iblai/data-layer 1.12.107 → 1.13.0

package/dist/index.js

@@ -40799,6 +40799,17 @@ const USERS_ENDPOINTS = {
         service: exports.SERVICES.LMS,
         path: () => `/api/ibl/users/manage/roles/`,
     },
+    // All roles assigned to a user across every scope (global, org, course).
+    // The same path is served by the CMS/Studio host and, deprecated, by the LMS.
+    // Studio is the default because course-creation roles are only fully
+    // resolvable there; `lmsService` is the fallback for deployments without a
+    // reachable Studio host. Both hosts share one cache tag, so this stays a
+    // single endpoint rather than two.
+    GET_USER_ROLES: {
+        service: exports.SERVICES.STUDIO,
+        lmsService: exports.SERVICES.LMS,
+        path: () => `/api/ibl/users/manage/roles/`,
+    },
     UPLOAD_PROFILE_IMAGE: {
         service: exports.SERVICES.LMS,
         path: (username) => `/api/user/v1/accounts/${username}/image`,
@@ -40828,6 +40839,7 @@ const USERS_QUERY_KEYS = {
     GET_USER_METADATA_EDX: () => ['USER_METADATA_EDX'],
     RESET_PASSWORD: () => ['RESET_PASSWORD'],
     UPDATE_USER_ROLES: () => ['UPDATE_USER_ROLES'],
+    GET_USER_ROLES: () => ['USER_ROLES'],
     UPLOAD_PROFILE_IMAGE: () => ['UPLOAD_PROFILE_IMAGE'],
     EDX_UPDATE_USER_METADATA: () => ['EDX_UPDATE_USER_METADATA'],
     EDX_GET_USER_METADATA: () => ['EDX_GET_USER_METADATA'],
@@ -40842,6 +40854,7 @@ const userApiSlice = react.createApi({
         ...USERS_QUERY_KEYS.GET_USER_METADATA(),
         ...USERS_QUERY_KEYS.GET_USER_METADATA_EDX(),
         ...USERS_QUERY_KEYS.GET_USER_PLATFORM_METADATA(),
+        ...USERS_QUERY_KEYS.GET_USER_ROLES(),
         featureTags.PLATFORM_USERS,
     ],
     endpoints: (builder) => ({
@@ -40902,7 +40915,39 @@ const userApiSlice = react.createApi({
                 body: args,
                 method: 'POST',
             }),
-            invalidatesTags: [featureTags.PLATFORM_USERS],
+            invalidatesTags: [featureTags.PLATFORM_USERS, ...USERS_QUERY_KEYS.GET_USER_ROLES()],
+        }),
+        /**
+         * Every role assigned to a user, across all scopes — global, organization
+         * and individual course. A user with no roles returns `[]`.
+         *
+         * At least one of `username`, `email` or `userId` is required (400
+         * otherwise). Non-staff users can only look up their own roles; asking for
+         * someone else's returns 404.
+         *
+         * Defaults to the CMS/Studio host, where course-creation roles are fully
+         * resolvable; pass `useLms` to fall back to the deprecated LMS host.
+         */
+        getUserRoles: builder.query({
+            query: ({ username, email, userId, useLms }) => {
+                const endpoint = USERS_ENDPOINTS.GET_USER_ROLES;
+                const params = {};
+                if (username) {
+                    params.username = username;
+                }
+                if (email) {
+                    params.email = email;
+                }
+                if (userId !== undefined) {
+                    params.user_id = userId;
+                }
+                return {
+                    url: endpoint.path(),
+                    service: useLms ? endpoint.lmsService : endpoint.service,
+                    params,
+                };
+            },
+            providesTags: USERS_QUERY_KEYS.GET_USER_ROLES(),
         }),
         getUserMetadataEdx: builder.query({
             query: (args) => ({
@@ -40971,7 +41016,27 @@ const userApiSlice = react.createApi({
         }),
     }),
 });
-const { useGetUserMetadataQuery, useLazyGetUserMetadataQuery, useUpdateUserMetadataMutation, useUpdateUserAccountMutation, useResetPasswordMutation, useUpdateUserRoleMutation, useUploadProfileImageMutation, useRemoveProfileImageMutation, useGetUserMetadataEdxQuery, useLazyGetUserMetadataEdxQuery, useUpdateUserMetadataEdxMutation, useGetUserPlatformMetadataQuery, useLazyGetUserPlatformMetadataQuery, useUpdateUserPlatformMetadataMutation, } = userApiSlice;
+const { useGetUserMetadataQuery, useLazyGetUserMetadataQuery, useUpdateUserMetadataMutation, useUpdateUserAccountMutation, useResetPasswordMutation, useUpdateUserRoleMutation, useGetUserRolesQuery, useLazyGetUserRolesQuery, useUploadProfileImageMutation, useRemoveProfileImageMutation, useGetUserMetadataEdxQuery, useLazyGetUserMetadataEdxQuery, useUpdateUserMetadataEdxMutation, useGetUserPlatformMetadataQuery, useLazyGetUserPlatformMetadataQuery, useUpdateUserPlatformMetadataMutation, } = userApiSlice;
+
+/**
+ * Scope a role row applies to, read off its `org`/`course` fields:
+ * both empty → global, `org` only → org, both set → course.
+ */
+const getUserRoleScope = (role) => {
+    if (role.course) {
+        return 'course';
+    }
+    if (role.org) {
+        return 'org';
+    }
+    return 'global';
+};
+/** Roles that apply platform-wide (e.g. `staff`). */
+const filterGlobalUserRoles = (roles) => roles.filter((role) => getUserRoleScope(role) === 'global');
+/** Roles scoped to an organization, optionally narrowed to one org short name. */
+const filterOrgUserRoles = (roles, org) => roles.filter((role) => getUserRoleScope(role) === 'org' && (org === undefined || role.org === org));
+/** Roles scoped to a course run, optionally narrowed to one course ID. */
+const filterCourseUserRoles = (roles, course) => roles.filter((role) => getUserRoleScope(role) === 'course' && (course === undefined || role.course === course));
 
 /**
  * Shared fetch for the paginated LTI provider list endpoints. Sends
@@ -48300,9 +48365,13 @@ exports.evalTotalPages = evalTotalPages;
 exports.evaluationsApiSlice = evaluationsApiSlice;
 exports.fakeBaseQueryWithLogging = fakeBaseQueryWithLogging;
 exports.featureTags = featureTags;
+exports.filterCourseUserRoles = filterCourseUserRoles;
+exports.filterGlobalUserRoles = filterGlobalUserRoles;
+exports.filterOrgUserRoles = filterOrgUserRoles;
 exports.filterSlashSkills = filterSlashSkills;
 exports.getNextRecentMessagesPageParam = getNextRecentMessagesPageParam;
 exports.getSpendCapExceededError = getSpendCapExceededError;
+exports.getUserRoleScope = getUserRoleScope;
 exports.gradingApiSlice = gradingApiSlice;
 exports.iblFakeBaseQuery = iblFakeBaseQuery;
 exports.initializeDataLayer = initializeDataLayer;
@@ -48764,6 +48833,7 @@ exports.useGetUserProjectDetailsQuery = useGetUserProjectDetailsQuery;
 exports.useGetUserProjectsQuery = useGetUserProjectsQuery;
 exports.useGetUserReportedSkillsQuery = useGetUserReportedSkillsQuery;
 exports.useGetUserResumeQuery = useGetUserResumeQuery;
+exports.useGetUserRolesQuery = useGetUserRolesQuery;
 exports.useGetUserSkillsPointsQuery = useGetUserSkillsPointsQuery;
 exports.useGetUserSpendCapQuery = useGetUserSpendCapQuery;
 exports.useGetUserTenantsQuery = useGetUserTenantsQuery;
@@ -48973,6 +49043,7 @@ exports.useLazyGetUserProjectDetailsQuery = useLazyGetUserProjectDetailsQuery;
 exports.useLazyGetUserProjectsQuery = useLazyGetUserProjectsQuery;
 exports.useLazyGetUserReportedSkillsQuery = useLazyGetUserReportedSkillsQuery;
 exports.useLazyGetUserResumeQuery = useLazyGetUserResumeQuery;
+exports.useLazyGetUserRolesQuery = useLazyGetUserRolesQuery;
 exports.useLazyGetUserSkillsPointsQuery = useLazyGetUserSkillsPointsQuery;
 exports.useLazyGetUserSpendCapQuery = useLazyGetUserSpendCapQuery;
 exports.useLazyGetUserTenantsQuery = useLazyGetUserTenantsQuery;