@iblai/web-utils 1.2.8 → 1.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Types for the courses feature slice.
3
+ *
4
+ * These mirror the shapes returned by the DM catalog enrollment/suggestions
5
+ * endpoints used by skills profile hooks. They are not present in
6
+ * @iblai/iblai-api so we co-locate them with the slice.
7
+ */
8
+ export interface EnrolledCourse {
9
+ user_id: number;
10
+ username: string;
11
+ email: string;
12
+ course_id: string;
13
+ active: boolean;
14
+ created: string;
15
+ started: string | null;
16
+ ended: string | null;
17
+ expired: string | null;
18
+ metadata: unknown;
19
+ course_name: string;
20
+ }
21
+ export interface EnrolledCourseResponse {
22
+ count: number;
23
+ next_page: number | null;
24
+ previous_page: number | null;
25
+ results: EnrolledCourse[];
26
+ }
@@ -0,0 +1,334 @@
1
+ import type { EdxSSOTokenResponse } from './types';
2
+ export declare const edxSsoApiSlice: 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>, {
3
+ getEdxSSOToken: import("@reduxjs/toolkit/query").QueryDefinition<{
4
+ username: string;
5
+ redirectUrl: string;
6
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>;
7
+ }, "edxSsoApiSlice", never, typeof import("@reduxjs/toolkit/query").coreModuleName | typeof import("@reduxjs/toolkit/dist/query/react").reactHooksModuleName>;
8
+ export declare const useGetEdxSSOTokenQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
9
+ status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
10
+ originalArgs?: undefined | undefined;
11
+ data?: undefined | undefined;
12
+ error?: undefined | undefined;
13
+ requestId?: undefined | undefined;
14
+ endpointName?: string | undefined;
15
+ startedTimeStamp?: undefined | undefined;
16
+ fulfilledTimeStamp?: undefined | undefined;
17
+ } & {
18
+ currentData?: EdxSSOTokenResponse | undefined;
19
+ isUninitialized: false;
20
+ isLoading: false;
21
+ isFetching: false;
22
+ isSuccess: false;
23
+ isError: false;
24
+ }, "isUninitialized"> & {
25
+ isUninitialized: true;
26
+ }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
27
+ username: string;
28
+ redirectUrl: string;
29
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
30
+ currentData?: EdxSSOTokenResponse | undefined;
31
+ isUninitialized: false;
32
+ isLoading: false;
33
+ isFetching: false;
34
+ isSuccess: false;
35
+ isError: false;
36
+ }, {
37
+ isLoading: true;
38
+ isFetching: boolean;
39
+ data: undefined;
40
+ } | ({
41
+ isSuccess: true;
42
+ isFetching: true;
43
+ error: undefined;
44
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
45
+ username: string;
46
+ redirectUrl: string;
47
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
48
+ currentData?: EdxSSOTokenResponse | undefined;
49
+ isUninitialized: false;
50
+ isLoading: false;
51
+ isFetching: false;
52
+ isSuccess: false;
53
+ isError: false;
54
+ }, "data" | "fulfilledTimeStamp">>) | ({
55
+ isSuccess: true;
56
+ isFetching: false;
57
+ error: undefined;
58
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
59
+ username: string;
60
+ redirectUrl: string;
61
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
62
+ currentData?: EdxSSOTokenResponse | undefined;
63
+ isUninitialized: false;
64
+ isLoading: false;
65
+ isFetching: false;
66
+ isSuccess: false;
67
+ isError: false;
68
+ }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
69
+ isError: true;
70
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
71
+ username: string;
72
+ redirectUrl: string;
73
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
74
+ currentData?: EdxSSOTokenResponse | undefined;
75
+ isUninitialized: false;
76
+ isLoading: false;
77
+ isFetching: false;
78
+ isSuccess: false;
79
+ isError: false;
80
+ }, "error">>)>> & {
81
+ status: import("@reduxjs/toolkit/query").QueryStatus;
82
+ }>(arg: {
83
+ username: string;
84
+ redirectUrl: string;
85
+ } | typeof import("@reduxjs/toolkit/query").skipToken, options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & {
86
+ skip?: boolean;
87
+ refetchOnMountOrArgChange?: boolean | number;
88
+ } & {
89
+ skip?: boolean;
90
+ selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
91
+ status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
92
+ originalArgs?: undefined | undefined;
93
+ data?: undefined | undefined;
94
+ error?: undefined | undefined;
95
+ requestId?: undefined | undefined;
96
+ endpointName?: string | undefined;
97
+ startedTimeStamp?: undefined | undefined;
98
+ fulfilledTimeStamp?: undefined | undefined;
99
+ } & {
100
+ currentData?: EdxSSOTokenResponse | undefined;
101
+ isUninitialized: false;
102
+ isLoading: false;
103
+ isFetching: false;
104
+ isSuccess: false;
105
+ isError: false;
106
+ }, "isUninitialized"> & {
107
+ isUninitialized: true;
108
+ }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
109
+ username: string;
110
+ redirectUrl: string;
111
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
112
+ currentData?: EdxSSOTokenResponse | undefined;
113
+ isUninitialized: false;
114
+ isLoading: false;
115
+ isFetching: false;
116
+ isSuccess: false;
117
+ isError: false;
118
+ }, {
119
+ isLoading: true;
120
+ isFetching: boolean;
121
+ data: undefined;
122
+ } | ({
123
+ isSuccess: true;
124
+ isFetching: true;
125
+ error: undefined;
126
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
127
+ username: string;
128
+ redirectUrl: string;
129
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
130
+ currentData?: EdxSSOTokenResponse | undefined;
131
+ isUninitialized: false;
132
+ isLoading: false;
133
+ isFetching: false;
134
+ isSuccess: false;
135
+ isError: false;
136
+ }, "data" | "fulfilledTimeStamp">>) | ({
137
+ isSuccess: true;
138
+ isFetching: false;
139
+ error: undefined;
140
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
141
+ username: string;
142
+ redirectUrl: string;
143
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
144
+ currentData?: EdxSSOTokenResponse | undefined;
145
+ isUninitialized: false;
146
+ isLoading: false;
147
+ isFetching: false;
148
+ isSuccess: false;
149
+ isError: false;
150
+ }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
151
+ isError: true;
152
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
153
+ username: string;
154
+ redirectUrl: string;
155
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
156
+ currentData?: EdxSSOTokenResponse | undefined;
157
+ isUninitialized: false;
158
+ isLoading: false;
159
+ isFetching: false;
160
+ isSuccess: false;
161
+ isError: false;
162
+ }, "error">>)>> & {
163
+ status: import("@reduxjs/toolkit/query").QueryStatus;
164
+ }) => R) | undefined;
165
+ }) | undefined) => [R][R extends any ? 0 : never] & {
166
+ refetch: () => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<{
167
+ username: string;
168
+ redirectUrl: string;
169
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>>;
170
+ }, useLazyGetEdxSSOTokenQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
171
+ status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
172
+ originalArgs?: undefined | undefined;
173
+ data?: undefined | undefined;
174
+ error?: undefined | undefined;
175
+ requestId?: undefined | undefined;
176
+ endpointName?: string | undefined;
177
+ startedTimeStamp?: undefined | undefined;
178
+ fulfilledTimeStamp?: undefined | undefined;
179
+ } & {
180
+ currentData?: EdxSSOTokenResponse | undefined;
181
+ isUninitialized: false;
182
+ isLoading: false;
183
+ isFetching: false;
184
+ isSuccess: false;
185
+ isError: false;
186
+ }, "isUninitialized"> & {
187
+ isUninitialized: true;
188
+ }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
189
+ username: string;
190
+ redirectUrl: string;
191
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
192
+ currentData?: EdxSSOTokenResponse | undefined;
193
+ isUninitialized: false;
194
+ isLoading: false;
195
+ isFetching: false;
196
+ isSuccess: false;
197
+ isError: false;
198
+ }, {
199
+ isLoading: true;
200
+ isFetching: boolean;
201
+ data: undefined;
202
+ } | ({
203
+ isSuccess: true;
204
+ isFetching: true;
205
+ error: undefined;
206
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
207
+ username: string;
208
+ redirectUrl: string;
209
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
210
+ currentData?: EdxSSOTokenResponse | undefined;
211
+ isUninitialized: false;
212
+ isLoading: false;
213
+ isFetching: false;
214
+ isSuccess: false;
215
+ isError: false;
216
+ }, "data" | "fulfilledTimeStamp">>) | ({
217
+ isSuccess: true;
218
+ isFetching: false;
219
+ error: undefined;
220
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
221
+ username: string;
222
+ redirectUrl: string;
223
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
224
+ currentData?: EdxSSOTokenResponse | undefined;
225
+ isUninitialized: false;
226
+ isLoading: false;
227
+ isFetching: false;
228
+ isSuccess: false;
229
+ isError: false;
230
+ }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
231
+ isError: true;
232
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
233
+ username: string;
234
+ redirectUrl: string;
235
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
236
+ currentData?: EdxSSOTokenResponse | undefined;
237
+ isUninitialized: false;
238
+ isLoading: false;
239
+ isFetching: false;
240
+ isSuccess: false;
241
+ isError: false;
242
+ }, "error">>)>> & {
243
+ status: import("@reduxjs/toolkit/query").QueryStatus;
244
+ }>(options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & Omit<{
245
+ skip?: boolean;
246
+ selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
247
+ status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
248
+ originalArgs?: undefined | undefined;
249
+ data?: undefined | undefined;
250
+ error?: undefined | undefined;
251
+ requestId?: undefined | undefined;
252
+ endpointName?: string | undefined;
253
+ startedTimeStamp?: undefined | undefined;
254
+ fulfilledTimeStamp?: undefined | undefined;
255
+ } & {
256
+ currentData?: EdxSSOTokenResponse | undefined;
257
+ isUninitialized: false;
258
+ isLoading: false;
259
+ isFetching: false;
260
+ isSuccess: false;
261
+ isError: false;
262
+ }, "isUninitialized"> & {
263
+ isUninitialized: true;
264
+ }) | import("@reduxjs/toolkit/query").TSHelpersOverride<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
265
+ username: string;
266
+ redirectUrl: string;
267
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
268
+ currentData?: EdxSSOTokenResponse | undefined;
269
+ isUninitialized: false;
270
+ isLoading: false;
271
+ isFetching: false;
272
+ isSuccess: false;
273
+ isError: false;
274
+ }, {
275
+ isLoading: true;
276
+ isFetching: boolean;
277
+ data: undefined;
278
+ } | ({
279
+ isSuccess: true;
280
+ isFetching: true;
281
+ error: undefined;
282
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
283
+ username: string;
284
+ redirectUrl: string;
285
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
286
+ currentData?: EdxSSOTokenResponse | undefined;
287
+ isUninitialized: false;
288
+ isLoading: false;
289
+ isFetching: false;
290
+ isSuccess: false;
291
+ isError: false;
292
+ }, "data" | "fulfilledTimeStamp">>) | ({
293
+ isSuccess: true;
294
+ isFetching: false;
295
+ error: undefined;
296
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
297
+ username: string;
298
+ redirectUrl: string;
299
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
300
+ currentData?: EdxSSOTokenResponse | undefined;
301
+ isUninitialized: false;
302
+ isLoading: false;
303
+ isFetching: false;
304
+ isSuccess: false;
305
+ isError: false;
306
+ }, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
307
+ isError: true;
308
+ } & Required<Pick<import("@reduxjs/toolkit/query").QuerySubState<import("@reduxjs/toolkit/query").QueryDefinition<{
309
+ username: string;
310
+ redirectUrl: string;
311
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>> & {
312
+ currentData?: EdxSSOTokenResponse | undefined;
313
+ isUninitialized: false;
314
+ isLoading: false;
315
+ isFetching: false;
316
+ isSuccess: false;
317
+ isError: false;
318
+ }, "error">>)>> & {
319
+ status: import("@reduxjs/toolkit/query").QueryStatus;
320
+ }) => R) | undefined;
321
+ }, "skip">) | undefined) => [(arg: {
322
+ username: string;
323
+ redirectUrl: string;
324
+ }, preferCacheValue?: boolean) => import("@reduxjs/toolkit/query").QueryActionCreatorResult<import("@reduxjs/toolkit/query").QueryDefinition<{
325
+ username: string;
326
+ redirectUrl: string;
327
+ }, import("@reduxjs/toolkit/query").BaseQueryFn<import("../utils").CustomQueryArgs, unknown, import("../utils").ExtendedFetchBaseQueryError, Record<string, unknown>, import("@reduxjs/toolkit/query").FetchBaseQueryMeta>, never, EdxSSOTokenResponse, "edxSsoApiSlice", unknown>>, [R][R extends any ? 0 : never] & {
328
+ reset: () => void;
329
+ }, {
330
+ lastArg: {
331
+ username: string;
332
+ redirectUrl: string;
333
+ };
334
+ }];
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Types for the edx-sso feature slice.
3
+ *
4
+ * Mirrors the shape returned by the LMS SSO auth token endpoint used by the
5
+ * skills profile hooks. Not present in @iblai/iblai-api so we co-locate it
6
+ * with the slice.
7
+ */
8
+ export interface EdxSSOTokenResponse {
9
+ sso_auth_token: string;
10
+ }