@iblai/data-layer 1.12.106 → 1.13.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iblai/data-layer",
-  "version": "1.12.106",
+  "version": "1.12.107",
   "description": "ibl.ai data layer",
   "main": "dist/index.esm.js",
   "types": "dist/index.d.ts",

package/dist/src/features/user/__tests__/user-roles.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/features/user/api-slice.d.ts

@@ -1,10 +1,22 @@
-import type { UserProfile, GetUserMetadataArgs, ResetPasswordArgs, UpdateUserRoleRequest, UpdateUserAccountRequest, UploadProfileImageResponse, RemoveProfileImageResponse, UserPlatformMetadata, GetUserPlatformMetadataArgs, UpdateUserPlatformMetadataArgs } from './types';
+import type { UserProfile, GetUserMetadataArgs, ResetPasswordArgs, UpdateUserRoleRequest, UpdateUserAccountRequest, UploadProfileImageResponse, RemoveProfileImageResponse, UserPlatformMetadata, GetUserPlatformMetadataArgs, UpdateUserPlatformMetadataArgs, UserRole, GetUserRolesArgs } from './types';
 export declare const userApiSlice: import("@reduxjs/toolkit/query").Api<import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, {
     getUserMetadata: import("@reduxjs/toolkit/query").QueryDefinition<GetUserMetadataArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfile, "userApiSlice", unknown>;
     updateUserMetadata: import("@reduxjs/toolkit/query").MutationDefinition<UserProfile, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, unknown, "userApiSlice", unknown>;
     updateUserAccount: import("@reduxjs/toolkit/query").MutationDefinition<UpdateUserAccountRequest, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, unknown, "userApiSlice", unknown>;
     resetPassword: import("@reduxjs/toolkit/query").MutationDefinition<ResetPasswordArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, void, "userApiSlice", unknown>;
     updateUserRole: import("@reduxjs/toolkit/query").MutationDefinition<UpdateUserRoleRequest, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, unknown, "userApiSlice", unknown>;
+    /**
+     * 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: import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>;
     getUserMetadataEdx: import("@reduxjs/toolkit/query").QueryDefinition<GetUserMetadataArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, Partial<UserProfile>, "userApiSlice", unknown>;
     uploadProfileImage: import("@reduxjs/toolkit/query").MutationDefinition<{
         file: File | Blob;
@@ -926,6 +938,269 @@ export declare const useGetUserMetadataQuery: <R extends Record<string, any> = i
 } | undefined) => readonly [(arg: UpdateUserRoleRequest) => import("@reduxjs/toolkit/query").MutationActionCreatorResult<import("@reduxjs/toolkit/query").MutationDefinition<UpdateUserRoleRequest, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, unknown, "userApiSlice", unknown>>, import("@reduxjs/toolkit/query").TSHelpersNoInfer<R> & {
     originalArgs?: UpdateUserRoleRequest | undefined;
     reset: () => void;
+}], useGetUserRolesQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    originalArgs?: undefined | undefined;
+    data?: undefined | undefined;
+    error?: undefined | undefined;
+    requestId?: undefined | undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined | undefined;
+    fulfilledTimeStamp?: undefined | undefined;
+} & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "isUninitialized"> & {
+    isUninitialized: true;
+}) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, {
+    isLoading: true;
+    isFetching: boolean;
+    data: undefined;
+} | ({
+    isSuccess: true;
+    isFetching: true;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp">>) | ({
+    isSuccess: true;
+    isFetching: false;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+    isError: true;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus;
+}>(arg: GetUserRolesArgs | typeof import("@reduxjs/toolkit/query").skipToken, options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & {
+    skip?: boolean;
+    refetchOnMountOrArgChange?: boolean | number;
+} & {
+    skip?: boolean;
+    selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        originalArgs?: undefined | undefined;
+        data?: undefined | undefined;
+        error?: undefined | undefined;
+        requestId?: undefined | undefined;
+        endpointName?: string | undefined;
+        startedTimeStamp?: undefined | undefined;
+        fulfilledTimeStamp?: undefined | undefined;
+    } & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "isUninitialized"> & {
+        isUninitialized: true;
+    }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, {
+        isLoading: true;
+        isFetching: boolean;
+        data: undefined;
+    } | ({
+        isSuccess: true;
+        isFetching: true;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp">>) | ({
+        isSuccess: true;
+        isFetching: false;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+        isError: true;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus;
+    }) => R) | undefined;
+}) | undefined) => [R][R extends any ? 0 : never] & {
+    refetch: () => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>>;
+}, useLazyGetUserRolesQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+    status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+    originalArgs?: undefined | undefined;
+    data?: undefined | undefined;
+    error?: undefined | undefined;
+    requestId?: undefined | undefined;
+    endpointName?: string | undefined;
+    startedTimeStamp?: undefined | undefined;
+    fulfilledTimeStamp?: undefined | undefined;
+} & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "isUninitialized"> & {
+    isUninitialized: true;
+}) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, {
+    isLoading: true;
+    isFetching: boolean;
+    data: undefined;
+} | ({
+    isSuccess: true;
+    isFetching: true;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp">>) | ({
+    isSuccess: true;
+    isFetching: false;
+    error: undefined;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+    isError: true;
+} & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+    currentData?: UserRole[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus;
+}>(options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & Omit<{
+    skip?: boolean;
+    selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
+        status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
+        originalArgs?: undefined | undefined;
+        data?: undefined | undefined;
+        error?: undefined | undefined;
+        requestId?: undefined | undefined;
+        endpointName?: string | undefined;
+        startedTimeStamp?: undefined | undefined;
+        fulfilledTimeStamp?: undefined | undefined;
+    } & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "isUninitialized"> & {
+        isUninitialized: true;
+    }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, {
+        isLoading: true;
+        isFetching: boolean;
+        data: undefined;
+    } | ({
+        isSuccess: true;
+        isFetching: true;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp">>) | ({
+        isSuccess: true;
+        isFetching: false;
+        error: undefined;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
+        isError: true;
+    } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>> & {
+        currentData?: UserRole[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus;
+    }) => R) | undefined;
+}, "skip">) | undefined) => [(arg: GetUserRolesArgs, preferCacheValue?: boolean) => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<GetUserRolesArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserRole[], "userApiSlice", unknown>>, [R][R extends any ? 0 : never] & {
+    reset: () => void;
+}, {
+    lastArg: GetUserRolesArgs;
 }], useUploadProfileImageMutation: <R extends Record<string, any> = ({
     requestId?: undefined;
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;

package/dist/src/features/user/constants.d.ts

@@ -12,6 +12,11 @@ export declare const USERS_ENDPOINTS: {
         service: SERVICES;
         path: () => string;
     };
+    GET_USER_ROLES: {
+        service: SERVICES;
+        lmsService: SERVICES;
+        path: () => string;
+    };
     UPLOAD_PROFILE_IMAGE: {
         service: SERVICES;
         path: (username: string) => string;
@@ -39,6 +44,7 @@ export declare const USERS_QUERY_KEYS: {
     GET_USER_METADATA_EDX: () => string[];
     RESET_PASSWORD: () => string[];
     UPDATE_USER_ROLES: () => string[];
+    GET_USER_ROLES: () => string[];
     UPLOAD_PROFILE_IMAGE: () => string[];
     EDX_UPDATE_USER_METADATA: () => string[];
     EDX_GET_USER_METADATA: () => string[];

package/dist/src/features/user/types.d.ts

@@ -132,3 +132,47 @@ export interface UpdateUserPlatformMetadataArgs {
     tenantKey: string;
     metadata: Record<string, unknown>;
 }
+/** Global (platform-wide) role keys returned by the role-listing endpoint. */
+export type GlobalUserRoleKey = 'staff' | 'support-staff' | 'course-creator';
+/** Course-scoped role keys. */
+export type CourseUserRoleKey = 'course-staff' | 'course-instructor' | 'course-limited-staff' | 'course-finance-admin' | 'course-sales-admin' | 'course-beta-tester' | 'course-library-user' | 'course-ccx-coach' | 'course-data-researcher';
+/** Organization-scoped role keys. */
+export type OrgUserRoleKey = 'org-staff' | 'org-instructor' | 'org-library-user' | 'org-data-researcher' | 'org-course-creator';
+/**
+ * Known role keys. Widened with `(string & {})` so an unrecognised role from a
+ * newer platform release still type-checks while editors keep autocompletion.
+ */
+export type UserRoleKey = GlobalUserRoleKey | CourseUserRoleKey | OrgUserRoleKey | (string & {});
+/**
+ * A single role assignment. `org` and `course` are empty strings for scopes
+ * that don't apply:
+ * - global role — both empty (e.g. `staff`)
+ * - organization role — `org` set, `course` empty (e.g. `org-instructor`)
+ * - course role — both set (e.g. `course-instructor`)
+ */
+export interface UserRole {
+    role: UserRoleKey;
+    org: string;
+    course: string;
+}
+/** Scope a {@link UserRole} applies to, derived from its `org`/`course` fields. */
+export type UserRoleScope = 'global' | 'org' | 'course';
+/**
+ * Lookup args for the role-listing endpoint. At least one of `userId`,
+ * `username` or `email` must be provided — the API returns 400 otherwise.
+ *
+ * Non-staff users may only look up their own roles; requesting another user's
+ * roles yields 404.
+ */
+export interface GetUserRolesArgs {
+    username?: string;
+    email?: string;
+    /** User ID (primary key). */
+    userId?: number;
+    /**
+     * Query the deprecated LMS host instead of CMS/Studio. Only needed on
+     * deployments without a reachable Studio host; course-creation roles are not
+     * fully resolvable there.
+     */
+    useLms?: boolean;
+}

package/dist/src/features/user/utils.d.ts

@@ -0,0 +1,12 @@
+import type { UserRole, UserRoleScope } from './types';
+/**
+ * Scope a role row applies to, read off its `org`/`course` fields:
+ * both empty → global, `org` only → org, both set → course.
+ */
+export declare const getUserRoleScope: (role: UserRole) => UserRoleScope;
+/** Roles that apply platform-wide (e.g. `staff`). */
+export declare const filterGlobalUserRoles: (roles: UserRole[]) => UserRole[];
+/** Roles scoped to an organization, optionally narrowed to one org short name. */
+export declare const filterOrgUserRoles: (roles: UserRole[], org?: string) => UserRole[];
+/** Roles scoped to a course run, optionally narrowed to one course ID. */
+export declare const filterCourseUserRoles: (roles: UserRole[], course?: string) => UserRole[];

package/dist/src/features/user-chat-history/__tests__/api-slice.test.d.ts

@@ -0,0 +1 @@
+export {};