@iblai/data-layer 1.13.4 → 1.14.0
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.
- package/dist/index.d.ts +321 -2
- package/dist/index.esm.js +67 -8
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +69 -7
- package/dist/index.js.map +1 -1
- package/dist/package.json +1 -1
- package/dist/src/constants.d.ts +13 -0
- package/dist/src/features/user/__tests__/user-profile-summary.test.d.ts +1 -0
- package/dist/src/features/user/api-slice.d.ts +270 -1
- package/dist/src/features/user/constants.d.ts +5 -0
- package/dist/src/features/user/types.d.ts +35 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
package/dist/package.json
CHANGED
package/dist/src/constants.d.ts
CHANGED
|
@@ -30,3 +30,16 @@ export declare enum SERVICES {
|
|
|
30
30
|
AXD = "AXD",
|
|
31
31
|
STUDIO = "STUDIO"
|
|
32
32
|
}
|
|
33
|
+
/**
|
|
34
|
+
* Client errors a retry cannot fix.
|
|
35
|
+
*
|
|
36
|
+
* These reject the request for what it IS — unauthenticated, forbidden,
|
|
37
|
+
* malformed — not for anything transient. Sending it again unchanged produces
|
|
38
|
+
* the same answer, just later, while multiplying load behind a failure the
|
|
39
|
+
* user is already waiting on. A 401 in particular must surface promptly so the
|
|
40
|
+
* token-refresh path can act on it rather than being buried under backoff.
|
|
41
|
+
*
|
|
42
|
+
* Shared so every retry policy agrees; individual call sites add their own
|
|
43
|
+
* extras (a 402 payment block, a 500 an endpoint treats as terminal).
|
|
44
|
+
*/
|
|
45
|
+
export declare const NEVER_RETRY_STATUSES: number[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { UserProfile, GetUserMetadataArgs, ResetPasswordArgs, UpdateUserRoleRequest, UpdateUserAccountRequest, UploadProfileImageResponse, RemoveProfileImageResponse, UserPlatformMetadata, GetUserPlatformMetadataArgs, UpdateUserPlatformMetadataArgs, UserRole, GetUserRolesArgs } from './types';
|
|
1
|
+
import type { UserProfile, GetUserMetadataArgs, ResetPasswordArgs, UpdateUserRoleRequest, UpdateUserAccountRequest, UploadProfileImageResponse, RemoveProfileImageResponse, UserPlatformMetadata, GetUserPlatformMetadataArgs, UpdateUserPlatformMetadataArgs, UserRole, GetUserRolesArgs, UserProfileSummary, GetUserProfileSummaryArgs } from './types';
|
|
2
2
|
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>, {
|
|
3
3
|
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>;
|
|
4
4
|
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("
|
|
|
18
18
|
*/
|
|
19
19
|
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>;
|
|
20
20
|
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>;
|
|
21
|
+
/**
|
|
22
|
+
* A user's profile-card fields, read-only, from DM-local data. Unlike
|
|
23
|
+
* `getUserMetadata` it is also served to watchers of the user, so use it
|
|
24
|
+
* when previewing someone else's profile.
|
|
25
|
+
*/
|
|
26
|
+
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>;
|
|
21
27
|
uploadProfileImage: import("@reduxjs/toolkit/query").MutationDefinition<{
|
|
22
28
|
file: File | Blob;
|
|
23
29
|
filename: string;
|
|
@@ -1802,6 +1808,269 @@ export declare const useGetUserMetadataQuery: <R extends Record<string, any> = i
|
|
|
1802
1808
|
reset: () => void;
|
|
1803
1809
|
}, {
|
|
1804
1810
|
lastArg: GetUserMetadataArgs;
|
|
1811
|
+
}], useGetUserProfileSummaryQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
|
|
1812
|
+
status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
|
|
1813
|
+
originalArgs?: undefined | undefined;
|
|
1814
|
+
data?: undefined | undefined;
|
|
1815
|
+
error?: undefined | undefined;
|
|
1816
|
+
requestId?: undefined | undefined;
|
|
1817
|
+
endpointName?: string | undefined;
|
|
1818
|
+
startedTimeStamp?: undefined | undefined;
|
|
1819
|
+
fulfilledTimeStamp?: undefined | undefined;
|
|
1820
|
+
} & {
|
|
1821
|
+
currentData?: UserProfileSummary | undefined;
|
|
1822
|
+
isUninitialized: false;
|
|
1823
|
+
isLoading: false;
|
|
1824
|
+
isFetching: false;
|
|
1825
|
+
isSuccess: false;
|
|
1826
|
+
isError: false;
|
|
1827
|
+
}, "isUninitialized"> & {
|
|
1828
|
+
isUninitialized: true;
|
|
1829
|
+
}) | 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>> & {
|
|
1830
|
+
currentData?: UserProfileSummary | undefined;
|
|
1831
|
+
isUninitialized: false;
|
|
1832
|
+
isLoading: false;
|
|
1833
|
+
isFetching: false;
|
|
1834
|
+
isSuccess: false;
|
|
1835
|
+
isError: false;
|
|
1836
|
+
}, {
|
|
1837
|
+
isLoading: true;
|
|
1838
|
+
isFetching: boolean;
|
|
1839
|
+
data: undefined;
|
|
1840
|
+
} | ({
|
|
1841
|
+
isSuccess: true;
|
|
1842
|
+
isFetching: true;
|
|
1843
|
+
error: undefined;
|
|
1844
|
+
} & 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>> & {
|
|
1845
|
+
currentData?: UserProfileSummary | undefined;
|
|
1846
|
+
isUninitialized: false;
|
|
1847
|
+
isLoading: false;
|
|
1848
|
+
isFetching: false;
|
|
1849
|
+
isSuccess: false;
|
|
1850
|
+
isError: false;
|
|
1851
|
+
}, "data" | "fulfilledTimeStamp">>) | ({
|
|
1852
|
+
isSuccess: true;
|
|
1853
|
+
isFetching: false;
|
|
1854
|
+
error: undefined;
|
|
1855
|
+
} & 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>> & {
|
|
1856
|
+
currentData?: UserProfileSummary | undefined;
|
|
1857
|
+
isUninitialized: false;
|
|
1858
|
+
isLoading: false;
|
|
1859
|
+
isFetching: false;
|
|
1860
|
+
isSuccess: false;
|
|
1861
|
+
isError: false;
|
|
1862
|
+
}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
|
|
1863
|
+
isError: true;
|
|
1864
|
+
} & 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>> & {
|
|
1865
|
+
currentData?: UserProfileSummary | undefined;
|
|
1866
|
+
isUninitialized: false;
|
|
1867
|
+
isLoading: false;
|
|
1868
|
+
isFetching: false;
|
|
1869
|
+
isSuccess: false;
|
|
1870
|
+
isError: false;
|
|
1871
|
+
}, "error">>)>> & {
|
|
1872
|
+
status: import("@reduxjs/toolkit/query").QueryStatus;
|
|
1873
|
+
}>(arg: GetUserProfileSummaryArgs | typeof import("@reduxjs/toolkit/query").skipToken, options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & {
|
|
1874
|
+
skip?: boolean;
|
|
1875
|
+
refetchOnMountOrArgChange?: boolean | number;
|
|
1876
|
+
} & {
|
|
1877
|
+
skip?: boolean;
|
|
1878
|
+
selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
|
|
1879
|
+
status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
|
|
1880
|
+
originalArgs?: undefined | undefined;
|
|
1881
|
+
data?: undefined | undefined;
|
|
1882
|
+
error?: undefined | undefined;
|
|
1883
|
+
requestId?: undefined | undefined;
|
|
1884
|
+
endpointName?: string | undefined;
|
|
1885
|
+
startedTimeStamp?: undefined | undefined;
|
|
1886
|
+
fulfilledTimeStamp?: undefined | undefined;
|
|
1887
|
+
} & {
|
|
1888
|
+
currentData?: UserProfileSummary | undefined;
|
|
1889
|
+
isUninitialized: false;
|
|
1890
|
+
isLoading: false;
|
|
1891
|
+
isFetching: false;
|
|
1892
|
+
isSuccess: false;
|
|
1893
|
+
isError: false;
|
|
1894
|
+
}, "isUninitialized"> & {
|
|
1895
|
+
isUninitialized: true;
|
|
1896
|
+
}) | 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>> & {
|
|
1897
|
+
currentData?: UserProfileSummary | undefined;
|
|
1898
|
+
isUninitialized: false;
|
|
1899
|
+
isLoading: false;
|
|
1900
|
+
isFetching: false;
|
|
1901
|
+
isSuccess: false;
|
|
1902
|
+
isError: false;
|
|
1903
|
+
}, {
|
|
1904
|
+
isLoading: true;
|
|
1905
|
+
isFetching: boolean;
|
|
1906
|
+
data: undefined;
|
|
1907
|
+
} | ({
|
|
1908
|
+
isSuccess: true;
|
|
1909
|
+
isFetching: true;
|
|
1910
|
+
error: undefined;
|
|
1911
|
+
} & 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>> & {
|
|
1912
|
+
currentData?: UserProfileSummary | undefined;
|
|
1913
|
+
isUninitialized: false;
|
|
1914
|
+
isLoading: false;
|
|
1915
|
+
isFetching: false;
|
|
1916
|
+
isSuccess: false;
|
|
1917
|
+
isError: false;
|
|
1918
|
+
}, "data" | "fulfilledTimeStamp">>) | ({
|
|
1919
|
+
isSuccess: true;
|
|
1920
|
+
isFetching: false;
|
|
1921
|
+
error: undefined;
|
|
1922
|
+
} & 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>> & {
|
|
1923
|
+
currentData?: UserProfileSummary | undefined;
|
|
1924
|
+
isUninitialized: false;
|
|
1925
|
+
isLoading: false;
|
|
1926
|
+
isFetching: false;
|
|
1927
|
+
isSuccess: false;
|
|
1928
|
+
isError: false;
|
|
1929
|
+
}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
|
|
1930
|
+
isError: true;
|
|
1931
|
+
} & 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>> & {
|
|
1932
|
+
currentData?: UserProfileSummary | undefined;
|
|
1933
|
+
isUninitialized: false;
|
|
1934
|
+
isLoading: false;
|
|
1935
|
+
isFetching: false;
|
|
1936
|
+
isSuccess: false;
|
|
1937
|
+
isError: false;
|
|
1938
|
+
}, "error">>)>> & {
|
|
1939
|
+
status: import("@reduxjs/toolkit/query").QueryStatus;
|
|
1940
|
+
}) => R) | undefined;
|
|
1941
|
+
}) | undefined) => [R][R extends any ? 0 : never] & {
|
|
1942
|
+
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>>;
|
|
1943
|
+
}, useLazyGetUserProfileSummaryQuery: <R extends Record<string, any> = import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
|
|
1944
|
+
status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
|
|
1945
|
+
originalArgs?: undefined | undefined;
|
|
1946
|
+
data?: undefined | undefined;
|
|
1947
|
+
error?: undefined | undefined;
|
|
1948
|
+
requestId?: undefined | undefined;
|
|
1949
|
+
endpointName?: string | undefined;
|
|
1950
|
+
startedTimeStamp?: undefined | undefined;
|
|
1951
|
+
fulfilledTimeStamp?: undefined | undefined;
|
|
1952
|
+
} & {
|
|
1953
|
+
currentData?: UserProfileSummary | undefined;
|
|
1954
|
+
isUninitialized: false;
|
|
1955
|
+
isLoading: false;
|
|
1956
|
+
isFetching: false;
|
|
1957
|
+
isSuccess: false;
|
|
1958
|
+
isError: false;
|
|
1959
|
+
}, "isUninitialized"> & {
|
|
1960
|
+
isUninitialized: true;
|
|
1961
|
+
}) | 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>> & {
|
|
1962
|
+
currentData?: UserProfileSummary | undefined;
|
|
1963
|
+
isUninitialized: false;
|
|
1964
|
+
isLoading: false;
|
|
1965
|
+
isFetching: false;
|
|
1966
|
+
isSuccess: false;
|
|
1967
|
+
isError: false;
|
|
1968
|
+
}, {
|
|
1969
|
+
isLoading: true;
|
|
1970
|
+
isFetching: boolean;
|
|
1971
|
+
data: undefined;
|
|
1972
|
+
} | ({
|
|
1973
|
+
isSuccess: true;
|
|
1974
|
+
isFetching: true;
|
|
1975
|
+
error: undefined;
|
|
1976
|
+
} & 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>> & {
|
|
1977
|
+
currentData?: UserProfileSummary | undefined;
|
|
1978
|
+
isUninitialized: false;
|
|
1979
|
+
isLoading: false;
|
|
1980
|
+
isFetching: false;
|
|
1981
|
+
isSuccess: false;
|
|
1982
|
+
isError: false;
|
|
1983
|
+
}, "data" | "fulfilledTimeStamp">>) | ({
|
|
1984
|
+
isSuccess: true;
|
|
1985
|
+
isFetching: false;
|
|
1986
|
+
error: undefined;
|
|
1987
|
+
} & 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>> & {
|
|
1988
|
+
currentData?: UserProfileSummary | undefined;
|
|
1989
|
+
isUninitialized: false;
|
|
1990
|
+
isLoading: false;
|
|
1991
|
+
isFetching: false;
|
|
1992
|
+
isSuccess: false;
|
|
1993
|
+
isError: false;
|
|
1994
|
+
}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
|
|
1995
|
+
isError: true;
|
|
1996
|
+
} & 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>> & {
|
|
1997
|
+
currentData?: UserProfileSummary | undefined;
|
|
1998
|
+
isUninitialized: false;
|
|
1999
|
+
isLoading: false;
|
|
2000
|
+
isFetching: false;
|
|
2001
|
+
isSuccess: false;
|
|
2002
|
+
isError: false;
|
|
2003
|
+
}, "error">>)>> & {
|
|
2004
|
+
status: import("@reduxjs/toolkit/query").QueryStatus;
|
|
2005
|
+
}>(options?: (import("@reduxjs/toolkit/query").SubscriptionOptions & Omit<{
|
|
2006
|
+
skip?: boolean;
|
|
2007
|
+
selectFromResult?: ((state: import("@reduxjs/toolkit/query").TSHelpersId<(Omit<{
|
|
2008
|
+
status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
|
|
2009
|
+
originalArgs?: undefined | undefined;
|
|
2010
|
+
data?: undefined | undefined;
|
|
2011
|
+
error?: undefined | undefined;
|
|
2012
|
+
requestId?: undefined | undefined;
|
|
2013
|
+
endpointName?: string | undefined;
|
|
2014
|
+
startedTimeStamp?: undefined | undefined;
|
|
2015
|
+
fulfilledTimeStamp?: undefined | undefined;
|
|
2016
|
+
} & {
|
|
2017
|
+
currentData?: UserProfileSummary | undefined;
|
|
2018
|
+
isUninitialized: false;
|
|
2019
|
+
isLoading: false;
|
|
2020
|
+
isFetching: false;
|
|
2021
|
+
isSuccess: false;
|
|
2022
|
+
isError: false;
|
|
2023
|
+
}, "isUninitialized"> & {
|
|
2024
|
+
isUninitialized: true;
|
|
2025
|
+
}) | 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>> & {
|
|
2026
|
+
currentData?: UserProfileSummary | undefined;
|
|
2027
|
+
isUninitialized: false;
|
|
2028
|
+
isLoading: false;
|
|
2029
|
+
isFetching: false;
|
|
2030
|
+
isSuccess: false;
|
|
2031
|
+
isError: false;
|
|
2032
|
+
}, {
|
|
2033
|
+
isLoading: true;
|
|
2034
|
+
isFetching: boolean;
|
|
2035
|
+
data: undefined;
|
|
2036
|
+
} | ({
|
|
2037
|
+
isSuccess: true;
|
|
2038
|
+
isFetching: true;
|
|
2039
|
+
error: undefined;
|
|
2040
|
+
} & 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>> & {
|
|
2041
|
+
currentData?: UserProfileSummary | undefined;
|
|
2042
|
+
isUninitialized: false;
|
|
2043
|
+
isLoading: false;
|
|
2044
|
+
isFetching: false;
|
|
2045
|
+
isSuccess: false;
|
|
2046
|
+
isError: false;
|
|
2047
|
+
}, "data" | "fulfilledTimeStamp">>) | ({
|
|
2048
|
+
isSuccess: true;
|
|
2049
|
+
isFetching: false;
|
|
2050
|
+
error: undefined;
|
|
2051
|
+
} & 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>> & {
|
|
2052
|
+
currentData?: UserProfileSummary | undefined;
|
|
2053
|
+
isUninitialized: false;
|
|
2054
|
+
isLoading: false;
|
|
2055
|
+
isFetching: false;
|
|
2056
|
+
isSuccess: false;
|
|
2057
|
+
isError: false;
|
|
2058
|
+
}, "data" | "fulfilledTimeStamp" | "currentData">>) | ({
|
|
2059
|
+
isError: true;
|
|
2060
|
+
} & 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>> & {
|
|
2061
|
+
currentData?: UserProfileSummary | undefined;
|
|
2062
|
+
isUninitialized: false;
|
|
2063
|
+
isLoading: false;
|
|
2064
|
+
isFetching: false;
|
|
2065
|
+
isSuccess: false;
|
|
2066
|
+
isError: false;
|
|
2067
|
+
}, "error">>)>> & {
|
|
2068
|
+
status: import("@reduxjs/toolkit/query").QueryStatus;
|
|
2069
|
+
}) => R) | undefined;
|
|
2070
|
+
}, "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] & {
|
|
2071
|
+
reset: () => void;
|
|
2072
|
+
}, {
|
|
2073
|
+
lastArg: GetUserProfileSummaryArgs;
|
|
1805
2074
|
}], useUpdateUserMetadataEdxMutation: <R extends Record<string, any> = ({
|
|
1806
2075
|
requestId?: undefined;
|
|
1807
2076
|
status: import("@reduxjs/toolkit/query").QueryStatus.uninitialized;
|
|
@@ -37,11 +37,16 @@ export declare const USERS_ENDPOINTS: {
|
|
|
37
37
|
service: SERVICES;
|
|
38
38
|
path: () => string;
|
|
39
39
|
};
|
|
40
|
+
GET_USER_PROFILE_SUMMARY: {
|
|
41
|
+
service: SERVICES;
|
|
42
|
+
path: () => string;
|
|
43
|
+
};
|
|
40
44
|
};
|
|
41
45
|
export declare const USERS_QUERY_KEYS: {
|
|
42
46
|
GET_USER_METADATA: () => string[];
|
|
43
47
|
GET_USER_PLATFORM_METADATA: () => string[];
|
|
44
48
|
GET_USER_METADATA_EDX: () => string[];
|
|
49
|
+
GET_USER_PROFILE_SUMMARY: () => string[];
|
|
45
50
|
RESET_PASSWORD: () => string[];
|
|
46
51
|
UPDATE_USER_ROLES: () => string[];
|
|
47
52
|
GET_USER_ROLES: () => string[];
|
|
@@ -62,6 +62,41 @@ export interface GetUserMetadataArgs {
|
|
|
62
62
|
username: string;
|
|
63
63
|
};
|
|
64
64
|
}
|
|
65
|
+
/**
|
|
66
|
+
* Profile-card fields for a user, from `/api/core/users/profile/summary/`. A
|
|
67
|
+
* fixed allowlist: no other account fields (phone, mailing address,
|
|
68
|
+
* demographics) are ever included.
|
|
69
|
+
*/
|
|
70
|
+
export interface UserProfileSummary {
|
|
71
|
+
username: string;
|
|
72
|
+
name: string;
|
|
73
|
+
email: string;
|
|
74
|
+
date_joined: string;
|
|
75
|
+
/** Absolute URL of the profile picture. */
|
|
76
|
+
profile_image: string;
|
|
77
|
+
bio: string;
|
|
78
|
+
about: string;
|
|
79
|
+
social_links: {
|
|
80
|
+
platform: string;
|
|
81
|
+
social_link: string;
|
|
82
|
+
}[];
|
|
83
|
+
public_metadata: Record<string, any>;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* Lookup args for the profile summary endpoint. Identify the user with one of
|
|
87
|
+
* `username`, `userId` or `email`.
|
|
88
|
+
*/
|
|
89
|
+
export interface GetUserProfileSummaryArgs {
|
|
90
|
+
username?: string;
|
|
91
|
+
email?: string;
|
|
92
|
+
/** User ID (primary key). */
|
|
93
|
+
userId?: number;
|
|
94
|
+
/**
|
|
95
|
+
* Platform the read is scoped to. Only used to resolve the watcher
|
|
96
|
+
* relationship; profile fields are global per user.
|
|
97
|
+
*/
|
|
98
|
+
platformKey?: string;
|
|
99
|
+
}
|
|
65
100
|
export interface ResetPasswordArgs {
|
|
66
101
|
email: string;
|
|
67
102
|
platformKey?: string;
|