@djangocfg/api 2.1.225 → 2.1.227
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/clients.d.cts +270 -270
- package/dist/clients.d.ts +270 -270
- package/dist/hooks.d.cts +76 -76
- package/dist/hooks.d.ts +76 -76
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +105 -105
- package/dist/index.d.ts +105 -105
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/_api/generated/cfg_accounts/accounts/models.ts +27 -27
- package/src/_api/generated/cfg_accounts/accounts__auth/models.ts +5 -5
- package/src/_api/generated/cfg_accounts/accounts__oauth/models.ts +55 -55
- package/src/_api/generated/cfg_accounts/accounts__user_profile/models.ts +24 -24
- package/src/_api/generated/cfg_centrifugo/centrifugo__centrifugo_admin_api/models.ts +108 -108
- package/src/_api/generated/cfg_centrifugo/centrifugo__centrifugo_monitoring/models.ts +39 -39
- package/src/_api/generated/cfg_centrifugo/centrifugo__centrifugo_testing/models.ts +14 -14
- package/src/_api/generated/cfg_totp/totp__backup_codes/models.ts +10 -10
- package/src/_api/generated/cfg_totp/totp__totp_management/models.ts +10 -10
- package/src/_api/generated/cfg_totp/totp__totp_setup/models.ts +13 -13
- package/src/_api/generated/cfg_totp/totp__totp_verification/models.ts +8 -8
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@djangocfg/api",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.227",
|
|
4
4
|
"description": "Auto-generated TypeScript API client with React hooks, SWR integration, and Zod validation for Django REST Framework backends",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"django",
|
|
@@ -84,7 +84,7 @@
|
|
|
84
84
|
"devDependencies": {
|
|
85
85
|
"@types/node": "^24.7.2",
|
|
86
86
|
"@types/react": "^19.1.0",
|
|
87
|
-
"@djangocfg/typescript-config": "^2.1.
|
|
87
|
+
"@djangocfg/typescript-config": "^2.1.227",
|
|
88
88
|
"next": "^16.0.10",
|
|
89
89
|
"react": "^19.1.0",
|
|
90
90
|
"tsup": "^8.5.0",
|
|
@@ -2,6 +2,33 @@
|
|
|
2
2
|
// Auto-generated by DjangoCFG - see CLAUDE.md
|
|
3
3
|
import * as Enums from "../enums";
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Serializer for OTP request.
|
|
7
|
+
*
|
|
8
|
+
* Request model (no read-only fields).
|
|
9
|
+
*/
|
|
10
|
+
export interface OTPRequestRequest {
|
|
11
|
+
/** Email address or phone number for OTP delivery */
|
|
12
|
+
identifier: string;
|
|
13
|
+
/** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
|
|
14
|
+
|
|
15
|
+
* `email` - Email
|
|
16
|
+
* `phone` - Phone */
|
|
17
|
+
channel?: Enums.OTPRequestRequestChannel;
|
|
18
|
+
/** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
|
|
19
|
+
source_url?: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* Error response for OTP operations.
|
|
24
|
+
*
|
|
25
|
+
* Response model (includes read-only fields).
|
|
26
|
+
*/
|
|
27
|
+
export interface OTPErrorResponse {
|
|
28
|
+
/** Error message */
|
|
29
|
+
error: string;
|
|
30
|
+
}
|
|
31
|
+
|
|
5
32
|
/**
|
|
6
33
|
* OTP verification response. When 2FA is required: - requires_2fa: True -
|
|
7
34
|
* session_id: UUID of 2FA verification session - refresh/access/user: null
|
|
@@ -24,23 +51,6 @@ export interface OTPVerifyResponse {
|
|
|
24
51
|
should_prompt_2fa?: boolean;
|
|
25
52
|
}
|
|
26
53
|
|
|
27
|
-
/**
|
|
28
|
-
* Serializer for OTP request.
|
|
29
|
-
*
|
|
30
|
-
* Request model (no read-only fields).
|
|
31
|
-
*/
|
|
32
|
-
export interface OTPRequestRequest {
|
|
33
|
-
/** Email address or phone number for OTP delivery */
|
|
34
|
-
identifier: string;
|
|
35
|
-
/** Delivery channel: 'email' or 'phone'. Auto-detected if not provided.
|
|
36
|
-
|
|
37
|
-
* `email` - Email
|
|
38
|
-
* `phone` - Phone */
|
|
39
|
-
channel?: Enums.OTPRequestRequestChannel;
|
|
40
|
-
/** Source URL for tracking registration (e.g., https://my.djangocfg.com) */
|
|
41
|
-
source_url?: string;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
54
|
/**
|
|
45
55
|
* OTP request response.
|
|
46
56
|
*
|
|
@@ -51,16 +61,6 @@ export interface OTPRequestResponse {
|
|
|
51
61
|
message: string;
|
|
52
62
|
}
|
|
53
63
|
|
|
54
|
-
/**
|
|
55
|
-
* Error response for OTP operations.
|
|
56
|
-
*
|
|
57
|
-
* Response model (includes read-only fields).
|
|
58
|
-
*/
|
|
59
|
-
export interface OTPErrorResponse {
|
|
60
|
-
/** Error message */
|
|
61
|
-
error: string;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
64
|
/**
|
|
65
65
|
* Serializer for OTP verification.
|
|
66
66
|
*
|
|
@@ -2,18 +2,18 @@
|
|
|
2
2
|
// Auto-generated by DjangoCFG - see CLAUDE.md
|
|
3
3
|
/**
|
|
4
4
|
*
|
|
5
|
-
*
|
|
5
|
+
* Response model (includes read-only fields).
|
|
6
6
|
*/
|
|
7
|
-
export interface
|
|
7
|
+
export interface TokenRefresh {
|
|
8
|
+
access: string;
|
|
8
9
|
refresh: string;
|
|
9
10
|
}
|
|
10
11
|
|
|
11
12
|
/**
|
|
12
13
|
*
|
|
13
|
-
*
|
|
14
|
+
* Request model (no read-only fields).
|
|
14
15
|
*/
|
|
15
|
-
export interface
|
|
16
|
-
access: string;
|
|
16
|
+
export interface TokenRefreshRequest {
|
|
17
17
|
refresh: string;
|
|
18
18
|
}
|
|
19
19
|
|
|
@@ -2,6 +2,30 @@
|
|
|
2
2
|
// Auto-generated by DjangoCFG - see CLAUDE.md
|
|
3
3
|
import * as Enums from "../enums";
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* Request to disconnect OAuth provider.
|
|
7
|
+
*
|
|
8
|
+
* Request model (no read-only fields).
|
|
9
|
+
*/
|
|
10
|
+
export interface OAuthDisconnectRequestRequest {
|
|
11
|
+
/** OAuth provider to disconnect
|
|
12
|
+
|
|
13
|
+
* `github` - GitHub */
|
|
14
|
+
provider: Enums.OAuthConnectionProvider;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Response with OAuth authorization URL.
|
|
19
|
+
*
|
|
20
|
+
* Response model (includes read-only fields).
|
|
21
|
+
*/
|
|
22
|
+
export interface OAuthAuthorizeResponse {
|
|
23
|
+
/** Full URL to redirect user to OAuth provider */
|
|
24
|
+
authorization_url: string;
|
|
25
|
+
/** State token for CSRF protection. Store this and verify on callback. */
|
|
26
|
+
state: string;
|
|
27
|
+
}
|
|
28
|
+
|
|
5
29
|
/**
|
|
6
30
|
* Request to start OAuth flow.
|
|
7
31
|
*
|
|
@@ -15,25 +39,40 @@ export interface OAuthAuthorizeRequestRequest {
|
|
|
15
39
|
}
|
|
16
40
|
|
|
17
41
|
/**
|
|
18
|
-
* Response with
|
|
42
|
+
* Response with JWT tokens after OAuth authentication. When 2FA is required: -
|
|
43
|
+
* requires_2fa: True - session_id: UUID of 2FA verification session -
|
|
44
|
+
* access/refresh/user: null When 2FA is not required: - requires_2fa: False -
|
|
45
|
+
* session_id: null - access/refresh/user: populated
|
|
19
46
|
*
|
|
20
47
|
* Response model (includes read-only fields).
|
|
21
48
|
*/
|
|
22
|
-
export interface
|
|
23
|
-
/**
|
|
24
|
-
|
|
49
|
+
export interface OAuthTokenResponse {
|
|
50
|
+
/** True if 2FA verification is required */
|
|
51
|
+
requires_2fa?: boolean;
|
|
52
|
+
/** 2FA session ID (only when requires_2fa=True) */
|
|
53
|
+
session_id?: string | null;
|
|
54
|
+
/** JWT access token (null when requires_2fa=True) */
|
|
55
|
+
access?: string | null;
|
|
56
|
+
/** JWT refresh token (null when requires_2fa=True) */
|
|
57
|
+
refresh?: string | null;
|
|
58
|
+
/** Authenticated user info (null when requires_2fa=True) */
|
|
59
|
+
user?: Record<string, any> | null;
|
|
60
|
+
/** True if a new user was created during this OAuth flow */
|
|
61
|
+
is_new_user: boolean;
|
|
62
|
+
/** True if a new OAuth connection was created */
|
|
63
|
+
is_new_connection: boolean;
|
|
64
|
+
/** True if user should be prompted to enable 2FA */
|
|
65
|
+
should_prompt_2fa?: boolean;
|
|
25
66
|
}
|
|
26
67
|
|
|
27
68
|
/**
|
|
28
|
-
*
|
|
69
|
+
* Response with available OAuth providers.
|
|
29
70
|
*
|
|
30
71
|
* Response model (includes read-only fields).
|
|
31
72
|
*/
|
|
32
|
-
export interface
|
|
33
|
-
/**
|
|
34
|
-
|
|
35
|
-
/** Human-readable error description */
|
|
36
|
-
error_description?: string;
|
|
73
|
+
export interface OAuthProvidersResponse {
|
|
74
|
+
/** List of available OAuth providers */
|
|
75
|
+
providers: Array<Record<string, any>>;
|
|
37
76
|
}
|
|
38
77
|
|
|
39
78
|
/**
|
|
@@ -75,53 +114,14 @@ export interface OAuthConnection {
|
|
|
75
114
|
}
|
|
76
115
|
|
|
77
116
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* Request model (no read-only fields).
|
|
81
|
-
*/
|
|
82
|
-
export interface OAuthDisconnectRequestRequest {
|
|
83
|
-
/** OAuth provider to disconnect
|
|
84
|
-
|
|
85
|
-
* `github` - GitHub */
|
|
86
|
-
provider: Enums.OAuthConnectionProvider;
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* Response with JWT tokens after OAuth authentication. When 2FA is required: -
|
|
91
|
-
* requires_2fa: True - session_id: UUID of 2FA verification session -
|
|
92
|
-
* access/refresh/user: null When 2FA is not required: - requires_2fa: False -
|
|
93
|
-
* session_id: null - access/refresh/user: populated
|
|
94
|
-
*
|
|
95
|
-
* Response model (includes read-only fields).
|
|
96
|
-
*/
|
|
97
|
-
export interface OAuthTokenResponse {
|
|
98
|
-
/** True if 2FA verification is required */
|
|
99
|
-
requires_2fa?: boolean;
|
|
100
|
-
/** 2FA session ID (only when requires_2fa=True) */
|
|
101
|
-
session_id?: string | null;
|
|
102
|
-
/** JWT access token (null when requires_2fa=True) */
|
|
103
|
-
access?: string | null;
|
|
104
|
-
/** JWT refresh token (null when requires_2fa=True) */
|
|
105
|
-
refresh?: string | null;
|
|
106
|
-
/** Authenticated user info (null when requires_2fa=True) */
|
|
107
|
-
user?: Record<string, any> | null;
|
|
108
|
-
/** True if a new user was created during this OAuth flow */
|
|
109
|
-
is_new_user: boolean;
|
|
110
|
-
/** True if a new OAuth connection was created */
|
|
111
|
-
is_new_connection: boolean;
|
|
112
|
-
/** True if user should be prompted to enable 2FA */
|
|
113
|
-
should_prompt_2fa?: boolean;
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
* Response with OAuth authorization URL.
|
|
117
|
+
* Error response for OAuth endpoints.
|
|
118
118
|
*
|
|
119
119
|
* Response model (includes read-only fields).
|
|
120
120
|
*/
|
|
121
|
-
export interface
|
|
122
|
-
/**
|
|
123
|
-
|
|
124
|
-
/**
|
|
125
|
-
|
|
121
|
+
export interface OAuthError {
|
|
122
|
+
/** Error code */
|
|
123
|
+
error: string;
|
|
124
|
+
/** Human-readable error description */
|
|
125
|
+
error_description?: string;
|
|
126
126
|
}
|
|
127
127
|
|
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
// Auto-generated by DjangoCFG - see CLAUDE.md
|
|
3
|
+
/**
|
|
4
|
+
* Serializer for updating user profile.
|
|
5
|
+
*
|
|
6
|
+
* Request model (no read-only fields).
|
|
7
|
+
*/
|
|
8
|
+
export interface UserProfileUpdateRequest {
|
|
9
|
+
first_name?: string;
|
|
10
|
+
last_name?: string;
|
|
11
|
+
company?: string;
|
|
12
|
+
phone?: string;
|
|
13
|
+
position?: string;
|
|
14
|
+
language?: string;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* Request model (no read-only fields).
|
|
20
|
+
*/
|
|
21
|
+
export interface CfgAccountsProfileAvatarCreateRequest {
|
|
22
|
+
/** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
|
|
23
|
+
avatar: File | Blob;
|
|
24
|
+
}
|
|
25
|
+
|
|
3
26
|
/**
|
|
4
27
|
* Serializer for user details.
|
|
5
28
|
*
|
|
@@ -36,7 +59,7 @@ export interface User {
|
|
|
36
59
|
*
|
|
37
60
|
* Request model (no read-only fields).
|
|
38
61
|
*/
|
|
39
|
-
export interface
|
|
62
|
+
export interface PatchedUserProfileUpdateRequest {
|
|
40
63
|
first_name?: string;
|
|
41
64
|
last_name?: string;
|
|
42
65
|
company?: string;
|
|
@@ -45,15 +68,6 @@ export interface UserProfileUpdateRequest {
|
|
|
45
68
|
language?: string;
|
|
46
69
|
}
|
|
47
70
|
|
|
48
|
-
/**
|
|
49
|
-
*
|
|
50
|
-
* Request model (no read-only fields).
|
|
51
|
-
*/
|
|
52
|
-
export interface CfgAccountsProfileAvatarCreateRequest {
|
|
53
|
-
/** Avatar image file (JPEG, PNG, GIF, WebP, max 5MB) */
|
|
54
|
-
avatar: File | Blob;
|
|
55
|
-
}
|
|
56
|
-
|
|
57
71
|
/**
|
|
58
72
|
* Response serializer for account deletion.
|
|
59
73
|
*
|
|
@@ -66,20 +80,6 @@ export interface AccountDeleteResponse {
|
|
|
66
80
|
message: string;
|
|
67
81
|
}
|
|
68
82
|
|
|
69
|
-
/**
|
|
70
|
-
* Serializer for updating user profile.
|
|
71
|
-
*
|
|
72
|
-
* Request model (no read-only fields).
|
|
73
|
-
*/
|
|
74
|
-
export interface PatchedUserProfileUpdateRequest {
|
|
75
|
-
first_name?: string;
|
|
76
|
-
last_name?: string;
|
|
77
|
-
company?: string;
|
|
78
|
-
phone?: string;
|
|
79
|
-
position?: string;
|
|
80
|
-
language?: string;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
83
|
/**
|
|
84
84
|
* Nested serializer for Centrifugo WebSocket connection token.
|
|
85
85
|
*
|
|
@@ -1,28 +1,23 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
// Auto-generated by DjangoCFG - see CLAUDE.md
|
|
3
3
|
/**
|
|
4
|
-
*
|
|
4
|
+
* Channel history response.
|
|
5
5
|
*
|
|
6
|
-
*
|
|
6
|
+
* Response model (includes read-only fields).
|
|
7
7
|
*/
|
|
8
|
-
export interface
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
/** Maximum number of messages to return */
|
|
12
|
-
limit?: number | null;
|
|
13
|
-
since?: CentrifugoStreamPosition | null;
|
|
14
|
-
/** Reverse message order (newest first) */
|
|
15
|
-
reverse?: boolean | null;
|
|
8
|
+
export interface CentrifugoHistoryResponse {
|
|
9
|
+
error?: CentrifugoError | null;
|
|
10
|
+
result?: CentrifugoHistoryResult | null;
|
|
16
11
|
}
|
|
17
12
|
|
|
18
13
|
/**
|
|
19
|
-
*
|
|
14
|
+
* Channel presence response.
|
|
20
15
|
*
|
|
21
|
-
*
|
|
16
|
+
* Response model (includes read-only fields).
|
|
22
17
|
*/
|
|
23
|
-
export interface
|
|
24
|
-
|
|
25
|
-
|
|
18
|
+
export interface CentrifugoPresenceResponse {
|
|
19
|
+
error?: CentrifugoError | null;
|
|
20
|
+
result?: CentrifugoPresenceResult | null;
|
|
26
21
|
}
|
|
27
22
|
|
|
28
23
|
/**
|
|
@@ -36,75 +31,82 @@ export interface CentrifugoInfoResponse {
|
|
|
36
31
|
}
|
|
37
32
|
|
|
38
33
|
/**
|
|
39
|
-
*
|
|
34
|
+
* Request to get channel presence.
|
|
40
35
|
*
|
|
41
|
-
*
|
|
36
|
+
* Request model (no read-only fields).
|
|
42
37
|
*/
|
|
43
|
-
export interface
|
|
44
|
-
|
|
45
|
-
|
|
38
|
+
export interface CentrifugoPresenceRequestRequest {
|
|
39
|
+
/** Channel name */
|
|
40
|
+
channel: string;
|
|
46
41
|
}
|
|
47
42
|
|
|
48
43
|
/**
|
|
49
|
-
*
|
|
44
|
+
* List of active channels response.
|
|
50
45
|
*
|
|
51
|
-
*
|
|
46
|
+
* Response model (includes read-only fields).
|
|
52
47
|
*/
|
|
53
|
-
export interface
|
|
54
|
-
|
|
55
|
-
|
|
48
|
+
export interface CentrifugoChannelsResponse {
|
|
49
|
+
error?: CentrifugoError | null;
|
|
50
|
+
result?: CentrifugoChannelsResult | null;
|
|
56
51
|
}
|
|
57
52
|
|
|
58
53
|
/**
|
|
59
|
-
*
|
|
54
|
+
* Request to get channel presence statistics.
|
|
60
55
|
*
|
|
61
|
-
*
|
|
56
|
+
* Request model (no read-only fields).
|
|
62
57
|
*/
|
|
63
|
-
export interface
|
|
64
|
-
|
|
65
|
-
|
|
58
|
+
export interface CentrifugoPresenceStatsRequestRequest {
|
|
59
|
+
/** Channel name */
|
|
60
|
+
channel: string;
|
|
66
61
|
}
|
|
67
62
|
|
|
68
63
|
/**
|
|
69
|
-
*
|
|
64
|
+
* Request to get channel history.
|
|
70
65
|
*
|
|
71
|
-
*
|
|
66
|
+
* Request model (no read-only fields).
|
|
72
67
|
*/
|
|
73
|
-
export interface
|
|
74
|
-
|
|
75
|
-
|
|
68
|
+
export interface CentrifugoHistoryRequestRequest {
|
|
69
|
+
/** Channel name */
|
|
70
|
+
channel: string;
|
|
71
|
+
/** Maximum number of messages to return */
|
|
72
|
+
limit?: number | null;
|
|
73
|
+
since?: CentrifugoStreamPosition | null;
|
|
74
|
+
/** Reverse message order (newest first) */
|
|
75
|
+
reverse?: boolean | null;
|
|
76
76
|
}
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
*
|
|
79
|
+
* Request to list active channels.
|
|
80
80
|
*
|
|
81
|
-
*
|
|
81
|
+
* Request model (no read-only fields).
|
|
82
82
|
*/
|
|
83
|
-
export interface
|
|
84
|
-
|
|
85
|
-
|
|
83
|
+
export interface CentrifugoChannelsRequestRequest {
|
|
84
|
+
/** Pattern to filter channels (e.g., 'user:*') */
|
|
85
|
+
pattern?: string | null;
|
|
86
86
|
}
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Channel presence stats response.
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
* Response model (includes read-only fields).
|
|
92
92
|
*/
|
|
93
|
-
export interface
|
|
94
|
-
|
|
95
|
-
|
|
93
|
+
export interface CentrifugoPresenceStatsResponse {
|
|
94
|
+
error?: CentrifugoError | null;
|
|
95
|
+
result?: CentrifugoPresenceStatsResult | null;
|
|
96
96
|
}
|
|
97
97
|
|
|
98
98
|
/**
|
|
99
|
-
*
|
|
99
|
+
* History result wrapper.
|
|
100
100
|
*
|
|
101
101
|
* Response model (includes read-only fields).
|
|
102
102
|
*/
|
|
103
|
-
export interface
|
|
104
|
-
/**
|
|
105
|
-
|
|
106
|
-
/**
|
|
103
|
+
export interface CentrifugoHistoryResult {
|
|
104
|
+
/** List of publications */
|
|
105
|
+
publications: Array<CentrifugoPublication>;
|
|
106
|
+
/** Current stream epoch */
|
|
107
107
|
epoch: string;
|
|
108
|
+
/** Latest stream offset */
|
|
109
|
+
offset: number;
|
|
108
110
|
}
|
|
109
111
|
|
|
110
112
|
/**
|
|
@@ -119,6 +121,16 @@ export interface CentrifugoError {
|
|
|
119
121
|
message?: string;
|
|
120
122
|
}
|
|
121
123
|
|
|
124
|
+
/**
|
|
125
|
+
* Presence result wrapper.
|
|
126
|
+
*
|
|
127
|
+
* Response model (includes read-only fields).
|
|
128
|
+
*/
|
|
129
|
+
export interface CentrifugoPresenceResult {
|
|
130
|
+
/** Map of client IDs to client info */
|
|
131
|
+
presence: Record<string, CentrifugoClientInfo>;
|
|
132
|
+
}
|
|
133
|
+
|
|
122
134
|
/**
|
|
123
135
|
* Info result wrapper.
|
|
124
136
|
*
|
|
@@ -130,49 +142,68 @@ export interface CentrifugoInfoResult {
|
|
|
130
142
|
}
|
|
131
143
|
|
|
132
144
|
/**
|
|
133
|
-
*
|
|
145
|
+
* Channels result wrapper.
|
|
134
146
|
*
|
|
135
147
|
* Response model (includes read-only fields).
|
|
136
148
|
*/
|
|
137
|
-
export interface
|
|
138
|
-
/**
|
|
139
|
-
|
|
140
|
-
/** Number of unique users */
|
|
141
|
-
num_users: number;
|
|
149
|
+
export interface CentrifugoChannelsResult {
|
|
150
|
+
/** Map of channel names to channel info */
|
|
151
|
+
channels: Record<string, CentrifugoChannelInfo>;
|
|
142
152
|
}
|
|
143
153
|
|
|
144
154
|
/**
|
|
145
|
-
*
|
|
155
|
+
* Stream position for pagination.
|
|
146
156
|
*
|
|
147
157
|
* Response model (includes read-only fields).
|
|
148
158
|
*/
|
|
149
|
-
export interface
|
|
150
|
-
/**
|
|
151
|
-
|
|
159
|
+
export interface CentrifugoStreamPosition {
|
|
160
|
+
/** Stream offset */
|
|
161
|
+
offset: number;
|
|
162
|
+
/** Stream epoch */
|
|
163
|
+
epoch: string;
|
|
152
164
|
}
|
|
153
165
|
|
|
154
166
|
/**
|
|
155
|
-
*
|
|
167
|
+
* Presence stats result.
|
|
156
168
|
*
|
|
157
169
|
* Response model (includes read-only fields).
|
|
158
170
|
*/
|
|
159
|
-
export interface
|
|
160
|
-
/**
|
|
161
|
-
|
|
171
|
+
export interface CentrifugoPresenceStatsResult {
|
|
172
|
+
/** Number of connected clients */
|
|
173
|
+
num_clients: number;
|
|
174
|
+
/** Number of unique users */
|
|
175
|
+
num_users: number;
|
|
162
176
|
}
|
|
163
177
|
|
|
164
178
|
/**
|
|
165
|
-
*
|
|
179
|
+
* Single publication (message) in channel history.
|
|
166
180
|
*
|
|
167
181
|
* Response model (includes read-only fields).
|
|
168
182
|
*/
|
|
169
|
-
export interface
|
|
170
|
-
/**
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
/** Latest stream offset */
|
|
183
|
+
export interface CentrifugoPublication {
|
|
184
|
+
/** Message payload */
|
|
185
|
+
data: Record<string, any>;
|
|
186
|
+
info?: CentrifugoClientInfo | null;
|
|
187
|
+
/** Message offset in channel stream */
|
|
175
188
|
offset: number;
|
|
189
|
+
/** Optional message tags */
|
|
190
|
+
tags?: Record<string, any> | null;
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* Information about connected client.
|
|
195
|
+
*
|
|
196
|
+
* Response model (includes read-only fields).
|
|
197
|
+
*/
|
|
198
|
+
export interface CentrifugoClientInfo {
|
|
199
|
+
/** User ID */
|
|
200
|
+
user: string;
|
|
201
|
+
/** Client UUID */
|
|
202
|
+
client: string;
|
|
203
|
+
/** Connection metadata */
|
|
204
|
+
conn_info?: Record<string, any> | null;
|
|
205
|
+
/** Channel-specific metadata */
|
|
206
|
+
chan_info?: Record<string, any> | null;
|
|
176
207
|
}
|
|
177
208
|
|
|
178
209
|
/**
|
|
@@ -201,22 +232,6 @@ export interface CentrifugoNodeInfo {
|
|
|
201
232
|
process?: CentrifugoProcess | null;
|
|
202
233
|
}
|
|
203
234
|
|
|
204
|
-
/**
|
|
205
|
-
* Information about connected client.
|
|
206
|
-
*
|
|
207
|
-
* Response model (includes read-only fields).
|
|
208
|
-
*/
|
|
209
|
-
export interface CentrifugoClientInfo {
|
|
210
|
-
/** User ID */
|
|
211
|
-
user: string;
|
|
212
|
-
/** Client UUID */
|
|
213
|
-
client: string;
|
|
214
|
-
/** Connection metadata */
|
|
215
|
-
conn_info?: Record<string, any> | null;
|
|
216
|
-
/** Channel-specific metadata */
|
|
217
|
-
chan_info?: Record<string, any> | null;
|
|
218
|
-
}
|
|
219
|
-
|
|
220
235
|
/**
|
|
221
236
|
* Information about a single channel.
|
|
222
237
|
*
|
|
@@ -228,18 +243,15 @@ export interface CentrifugoChannelInfo {
|
|
|
228
243
|
}
|
|
229
244
|
|
|
230
245
|
/**
|
|
231
|
-
*
|
|
246
|
+
* Server metrics.
|
|
232
247
|
*
|
|
233
248
|
* Response model (includes read-only fields).
|
|
234
249
|
*/
|
|
235
|
-
export interface
|
|
236
|
-
/**
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
offset: number;
|
|
241
|
-
/** Optional message tags */
|
|
242
|
-
tags?: Record<string, any> | null;
|
|
250
|
+
export interface CentrifugoMetrics {
|
|
251
|
+
/** Metrics collection interval */
|
|
252
|
+
interval: number;
|
|
253
|
+
/** Metric name to value mapping */
|
|
254
|
+
items: Record<string, any>;
|
|
243
255
|
}
|
|
244
256
|
|
|
245
257
|
/**
|
|
@@ -254,15 +266,3 @@ export interface CentrifugoProcess {
|
|
|
254
266
|
rss: number;
|
|
255
267
|
}
|
|
256
268
|
|
|
257
|
-
/**
|
|
258
|
-
* Server metrics.
|
|
259
|
-
*
|
|
260
|
-
* Response model (includes read-only fields).
|
|
261
|
-
*/
|
|
262
|
-
export interface CentrifugoMetrics {
|
|
263
|
-
/** Metrics collection interval */
|
|
264
|
-
interval: number;
|
|
265
|
-
/** Metric name to value mapping */
|
|
266
|
-
items: Record<string, any>;
|
|
267
|
-
}
|
|
268
|
-
|