@iblai/data-layer 1.13.5 → 1.14.1

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

@@ -1,4 +1,4 @@
-import type { UserProfile, GetUserMetadataArgs, ResetPasswordArgs, UpdateUserRoleRequest, UpdateUserAccountRequest, UploadProfileImageResponse, RemoveProfileImageResponse, UserPlatformMetadata, GetUserPlatformMetadataArgs, UpdateUserPlatformMetadataArgs, UserRole, GetUserRolesArgs } from './types';
+import type { UserProfile, GetUserMetadataArgs, ResetPasswordArgs, UpdateUserRoleRequest, UpdateUserAccountRequest, UploadProfileImageResponse, RemoveProfileImageResponse, UserPlatformMetadata, GetUserPlatformMetadataArgs, UpdateUserPlatformMetadataArgs, UserRole, GetUserRolesArgs, UserProfileSummary, GetUserProfileSummaryArgs } 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>;
@@ -18,6 +18,12 @@ export declare const userApiSlice: import("@reduxjs/toolkit/query").Api<import("
      */
     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>;
+    /**
+     * A user's profile-card fields, read-only, from DM-local data. Unlike
+     * `getUserMetadata` it is also served to watchers of the user, so use it
+     * when previewing someone else's profile.
+     */
+    getUserProfileSummary: import("@reduxjs/toolkit/query").QueryDefinition<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>;
     uploadProfileImage: import("@reduxjs/toolkit/query").MutationDefinition<{
         file: File | Blob;
         filename: string;
@@ -1802,6 +1808,269 @@ export declare const useGetUserMetadataQuery: <R extends Record<string, any> = i
     reset: () => void;
 }, {
     lastArg: GetUserMetadataArgs;
+}], useGetUserProfileSummaryQuery: <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?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus;
+}>(arg: GetUserProfileSummaryArgs | 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?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>>;
+}, useLazyGetUserProfileSummaryQuery: <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?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+    currentData?: UserProfileSummary | 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?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | 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<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>> & {
+        currentData?: UserProfileSummary | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus;
+    }) => R) | undefined;
+}, "skip">) | undefined) => [(arg: GetUserProfileSummaryArgs, preferCacheValue?: boolean) => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<GetUserProfileSummaryArgs, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, string, UserProfileSummary, "userApiSlice", unknown>>, [R][R extends any ? 0 : never] & {
+    reset: () => void;
+}, {
+    lastArg: GetUserProfileSummaryArgs;
 }], useUpdateUserMetadataEdxMutation: <R extends Record<string, any> = ({
     requestId?: undefined;
     status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;

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

@@ -37,11 +37,16 @@ export declare const USERS_ENDPOINTS: {
         service: SERVICES;
         path: () => string;
     };
+    GET_USER_PROFILE_SUMMARY: {
+        service: SERVICES;
+        path: () => string;
+    };
 };
 export declare const USERS_QUERY_KEYS: {
     GET_USER_METADATA: () => string[];
     GET_USER_PLATFORM_METADATA: () => string[];
     GET_USER_METADATA_EDX: () => string[];
+    GET_USER_PROFILE_SUMMARY: () => string[];
     RESET_PASSWORD: () => string[];
     UPDATE_USER_ROLES: () => string[];
     GET_USER_ROLES: () => string[];

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

@@ -62,6 +62,41 @@ export interface GetUserMetadataArgs {
         username: string;
     };
 }
+/**
+ * Profile-card fields for a user, from `/api/core/users/profile/summary/`. A
+ * fixed allowlist: no other account fields (phone, mailing address,
+ * demographics) are ever included.
+ */
+export interface UserProfileSummary {
+    username: string;
+    name: string;
+    email: string;
+    date_joined: string;
+    /** Absolute URL of the profile picture. */
+    profile_image: string;
+    bio: string;
+    about: string;
+    social_links: {
+        platform: string;
+        social_link: string;
+    }[];
+    public_metadata: Record<string, any>;
+}
+/**
+ * Lookup args for the profile summary endpoint. Identify the user with one of
+ * `username`, `userId` or `email`.
+ */
+export interface GetUserProfileSummaryArgs {
+    username?: string;
+    email?: string;
+    /** User ID (primary key). */
+    userId?: number;
+    /**
+     * Platform the read is scoped to. Only used to resolve the watcher
+     * relationship; profile fields are global per user.
+     */
+    platformKey?: string;
+}
 export interface ResetPasswordArgs {
     email: string;
     platformKey?: string;

package/dist/tests/features/analytics/api-slice-endpoints.test.d.ts

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

package/dist/tests/features/analytics/financial-stats-deprecated.test.d.ts

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