@iblai/data-layer 1.31.0 → 1.32.0

package/dist/package.json

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

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

@@ -1,4 +1,4 @@
-import { PlatformApplicationAdminDetail, PlatformApplicationBlock, PlatformApplicationCourseAssignment, PlatformApplicationFormRecord, PlatformApplicationNote, PlatformApplicationPipelineResponse, PlatformApplicationPipelineStats, PlatformApplicationPlacement, PlatformApplicationStatusResponse, PlatformUserGroupDetailsResponse, PlatformUserPolicyUpdateRequest, PlatformUsersListResponse } from './types';
+import { PlatformApplicationAdminDetail, PlatformApplicationBlock, PlatformApplicationCourseAssignment, PlatformApplicationFormRecord, PlatformApplicationNote, PlatformApplicationPipelineResponse, PlatformApplicationPipelineStats, PlatformApplicationPlacement, PlatformApplicationStatusResponse, PlatformUserGroupDetailsResponse, PlatformUserPolicyUpdateRequest, PlatformUsersListResponse, UserPlatformLink } from './types';
 export interface InviteUserRequest {
     email: string;
     platform_key: string;
@@ -43,6 +43,19 @@ export declare const platformApiSlice: import("@reduxjs/toolkit/query").Api<impo
     }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
         attempt?: number;
     } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, any, "platform-api", any>;
+    /**
+     * The platforms a user is linked to. Each link carries `is_default`, so the
+     * caller's default platform can be read from this list without a second
+     * call to `/api/core/users/platforms/default/`.
+     *
+     * The pinned client's `UserPlatformLink` predates that field, hence the
+     * cast to the local type.
+     */
+    userPlatforms: import("@reduxjs/toolkit/query").QueryDefinition<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>;
     platformUsers: import("@reduxjs/toolkit/query").QueryDefinition<{
         platform_key: string;
         page?: number;
@@ -11158,4 +11171,345 @@ export declare const useUsersGradesPassedQuery: <R extends Record<string, any> =
         email?: string;
     } | undefined;
     reset: () => void;
+}], useUserPlatformsQuery: <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?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | undefined;
+    isUninitialized: false;
+    isLoading: false;
+    isFetching: false;
+    isSuccess: false;
+    isError: false;
+}, "error">>)>> & {
+    status: import("@reduxjs/toolkit/query").QueryStatus;
+}>(arg: {
+    username: string;
+} | 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?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>>;
+}, useLazyUserPlatformsQuery: <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?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+    currentData?: UserPlatformLink[] | 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?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | 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<{
+        username: string;
+    }, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+        attempt?: number;
+    } & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>> & {
+        currentData?: UserPlatformLink[] | undefined;
+        isUninitialized: false;
+        isLoading: false;
+        isFetching: false;
+        isSuccess: false;
+        isError: false;
+    }, "error">>)>> & {
+        status: import("@reduxjs/toolkit/query").QueryStatus;
+    }) => R) | undefined;
+}, "skip">) | undefined) => [(arg: {
+    username: string;
+}, preferCacheValue?: boolean) => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<{
+    username: string;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<void, unknown, unknown, {
+    attempt?: number;
+} & import("@reduxjs/toolkit/query").RetryOptions, {}>, string, UserPlatformLink[], "platform-api", any>>, [R][R extends any ? 0 : never] & {
+    reset: () => void;
+}, {
+    lastArg: {
+        username: string;
+    };
 }];

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

@@ -278,3 +278,35 @@ export interface PlatformApplicationBlock {
     created_by?: string | null;
     created?: string;
 }
+/**
+ * One user↔platform link, as returned by the user platform list
+ * (`GET /api/core/users/platforms/`).
+ *
+ * The pinned generated client (@iblai/iblai-api 4.166.0-ai) still carries the
+ * older shape of this model, so the fields the API has added since are declared
+ * here rather than imported: `is_default` (the user's default platform, also
+ * settable through `/api/core/users/platforms/default/`), `show_paywall` and
+ * `enable_monetization`. `is_default` is serialized as a string, not a boolean.
+ */
+export interface UserPlatformLink {
+    user_id: number;
+    username: string;
+    email: string;
+    user_active: boolean;
+    key: string;
+    org: string;
+    platform_name: string;
+    lms_url: string;
+    cms_url: string;
+    portal_url: string;
+    is_admin?: boolean;
+    is_staff?: boolean;
+    added_on?: string | null;
+    expired_on?: string | null;
+    public: string;
+    active?: boolean;
+    is_enterprise: string;
+    is_default: string;
+    show_paywall: boolean;
+    enable_monetization: boolean;
+}