Skip to main content

waveless_runtime/
internal_endpoints.rs

1// Waveless
2// Copyright (C) 2026 Oscar Alvarez Gonzalez
3
4use crate::*;
5
6pub const CONN_UPGRADE_WEBSOCKETS_ENDPOINT_ID: &str = "ConnUpgradeWebSockets";
7
8pub const LOGIN_ENDPOINT_ID: &str = "Login";
9pub const SIGNUP_ENDPOINT_ID: &str = "SignUp";
10pub const LOGOUT_ENDPOINT_ID: &str = "Logout";
11pub const LOGOUT_ALL_ENDPOINT_ID: &str = "LogoutAll";
12
13/// Internal endpoints provided by the executor.
14pub const INTERNAL_ENDPOINTS: LazyCell<[(InternalEndpointKind, Endpoint); 5]> = LazyCell::new(
15    || {
16        [
17            (InternalEndpointKind::ConnectionUpgrade,
18                EndpointBuilder::default()
19                    .id(CONN_UPGRADE_WEBSOCKETS_ENDPOINT_ID.into())
20                    .execution_target(ExecutionTarget::Http(
21                        HttpTargetBuilder::default()
22                            .route("websockets".into())
23                            .method(HttpMethod::Get)
24                            .version("upgrade".into())
25                            .auto_generated(true)
26                            .build()
27                            .unwrap()
28                    ))
29                    .description("Handles connection upgrading to WebSockets.".into())
30                    .auth(AuthBuilder::default().level(AuthLevel::InjectWhenAvailable).build().unwrap())
31                    .build()
32                    .unwrap()
33            ),
34            (
35                InternalEndpointKind::Authentication,
36                EndpointBuilder::default()
37                    .id(LOGIN_ENDPOINT_ID.into())
38                    .execution_target(ExecutionTarget::Http(
39                        HttpTargetBuilder::default()
40                            .route("login".into())
41                            .method(HttpMethod::Post)
42                            .version("internal".into())
43                            .capture_all_params(true)
44                            .auto_generated(true)
45                            .build()
46                            .unwrap()
47                    ))
48                    .description("Login a user capturing all parameters and forwarding them to the underlying authentication method.".into())
49                    .build()
50                    .unwrap()
51            ),
52            (
53                InternalEndpointKind::Authentication,
54                EndpointBuilder::default()
55                    .id(SIGNUP_ENDPOINT_ID.into())
56                    .execution_target(ExecutionTarget::Http(
57                        HttpTargetBuilder::default()
58                            .route("signup".into())
59                            .method(HttpMethod::Post)
60                            .version("internal".into())
61                            .capture_all_params(true)
62                            .auto_generated(true)
63                            .build()
64                            .unwrap()
65                    ))
66                    .description("Create a new user capturing all parameters and forwarding them to the underlying authentication method.".into())
67                    .build()
68                    .unwrap()
69            ),
70            (
71                InternalEndpointKind::Authentication,
72                EndpointBuilder::default()
73                    .id(LOGOUT_ENDPOINT_ID.into())
74                    .execution_target(ExecutionTarget::Http(
75                        HttpTargetBuilder::default()
76                            .route("logout".into())
77                            .method(HttpMethod::Get)
78                            .version("internal".into())
79                            .auto_generated(true)
80                            .build()
81                            .unwrap()
82                    ))
83                    .description("Invalidate the current authorization token.".into())
84                    .auth(AuthBuilder::default().level(AuthLevel::Required).build().unwrap())
85                    .build()
86                    .unwrap()
87            ),
88            (
89                InternalEndpointKind::Authentication,
90                EndpointBuilder::default()
91                    .id(LOGOUT_ALL_ENDPOINT_ID.into())
92                    .execution_target(ExecutionTarget::Http(
93                        HttpTargetBuilder::default()
94                            .route("logout/all".into())
95                            .method(HttpMethod::Get)
96                            .version("internal".into())
97                            .auto_generated(true)
98                            .build()
99                            .unwrap()
100                    ))
101                    .description("Invalidate all the authorization tokens of the current user.".into())
102                    .auth(AuthBuilder::default().level(AuthLevel::Required).build().unwrap())
103                    .build()
104                    .unwrap()
105            )
106        ]
107    },
108);
109
110/// Specifies the kind of an internal endpoint.
111#[derive(PartialEq, Debug)]
112pub enum InternalEndpointKind {
113    Authentication,
114    ConnectionUpgrade,
115    Other,
116}