The best way to control Claude Code, Codex and more from any computer or phone

main
ts 288 lines 11.5 KB
Raw
1 import type * as cip from "@distilled.cloud/aws/cognito-identity-provider";
2 import * as Binding from "alchemy/Binding";
3 import type * as Effect from "effect/Effect";
4 import type { UserPool } from "./UserPool.ts";
5
6 export interface AdminCreateUserRequest extends Omit<cip.AdminCreateUserRequest, "UserPoolId"> {}
7 export interface AdminGetUserRequest extends Omit<cip.AdminGetUserRequest, "UserPoolId"> {}
8 export interface AdminSetUserPasswordRequest extends Omit<
9 cip.AdminSetUserPasswordRequest,
10 "UserPoolId"
11 > {}
12 export interface AdminUpdateUserAttributesRequest extends Omit<
13 cip.AdminUpdateUserAttributesRequest,
14 "UserPoolId"
15 > {}
16 export interface AdminDeleteUserRequest extends Omit<cip.AdminDeleteUserRequest, "UserPoolId"> {}
17 export interface AdminConfirmSignUpRequest extends Omit<
18 cip.AdminConfirmSignUpRequest,
19 "UserPoolId"
20 > {}
21 export interface AdminDisableUserRequest extends Omit<cip.AdminDisableUserRequest, "UserPoolId"> {}
22 export interface AdminEnableUserRequest extends Omit<cip.AdminEnableUserRequest, "UserPoolId"> {}
23 export interface AdminResetUserPasswordRequest extends Omit<
24 cip.AdminResetUserPasswordRequest,
25 "UserPoolId"
26 > {}
27 export interface AdminInitiateAuthRequest extends Omit<
28 cip.AdminInitiateAuthRequest,
29 "UserPoolId"
30 > {}
31 export interface AdminRespondToAuthChallengeRequest extends Omit<
32 cip.AdminRespondToAuthChallengeRequest,
33 "UserPoolId"
34 > {}
35 export interface AdminUserGlobalSignOutRequest extends Omit<
36 cip.AdminUserGlobalSignOutRequest,
37 "UserPoolId"
38 > {}
39 export interface AdminAddUserToGroupRequest extends Omit<
40 cip.AdminAddUserToGroupRequest,
41 "UserPoolId"
42 > {}
43 export interface AdminRemoveUserFromGroupRequest extends Omit<
44 cip.AdminRemoveUserFromGroupRequest,
45 "UserPoolId"
46 > {}
47 export interface ListUsersRequest extends Omit<cip.ListUsersRequest, "UserPoolId"> {}
48 export interface ListUsersInGroupRequest extends Omit<cip.ListUsersInGroupRequest, "UserPoolId"> {}
49 export interface AdminDeleteUserAttributesRequest extends Omit<
50 cip.AdminDeleteUserAttributesRequest,
51 "UserPoolId"
52 > {}
53 export interface AdminListGroupsForUserRequest extends Omit<
54 cip.AdminListGroupsForUserRequest,
55 "UserPoolId"
56 > {}
57 export interface AdminSetUserMFAPreferenceRequest extends Omit<
58 cip.AdminSetUserMFAPreferenceRequest,
59 "UserPoolId"
60 > {}
61 export interface AdminLinkProviderForUserRequest extends Omit<
62 cip.AdminLinkProviderForUserRequest,
63 "UserPoolId"
64 > {}
65 export interface AdminDisableProviderForUserRequest extends Omit<
66 cip.AdminDisableProviderForUserRequest,
67 "UserPoolId"
68 > {}
69 export interface AdminGetDeviceRequest extends Omit<cip.AdminGetDeviceRequest, "UserPoolId"> {}
70 export interface AdminListDevicesRequest extends Omit<cip.AdminListDevicesRequest, "UserPoolId"> {}
71 export interface AdminForgetDeviceRequest extends Omit<
72 cip.AdminForgetDeviceRequest,
73 "UserPoolId"
74 > {}
75 export interface AdminUpdateDeviceStatusRequest extends Omit<
76 cip.AdminUpdateDeviceStatusRequest,
77 "UserPoolId"
78 > {}
79 export interface AdminListUserAuthEventsRequest extends Omit<
80 cip.AdminListUserAuthEventsRequest,
81 "UserPoolId"
82 > {}
83 export interface AdminUpdateAuthEventFeedbackRequest extends Omit<
84 cip.AdminUpdateAuthEventFeedbackRequest,
85 "UserPoolId"
86 > {}
87 export interface ListGroupsRequest extends Omit<cip.ListGroupsRequest, "UserPoolId"> {}
88
89 /**
90 * The typed client returned by binding {@link UserPoolAdmin} to a
91 * `UserPool`. Every method automatically injects the user pool ID and is
92 * authorized by IAM (`cognito-idp:Admin*` on the pool ARN).
93 */
94 export interface UserPoolAdminClient {
95 /** Create a user as an administrator (optionally suppressing the invite). */
96 adminCreateUser: (
97 request: AdminCreateUserRequest,
98 ) => Effect.Effect<cip.AdminCreateUserResponse, cip.AdminCreateUserError>;
99 /** Fetch a user's profile and status by username. */
100 adminGetUser: (
101 request: AdminGetUserRequest,
102 ) => Effect.Effect<cip.AdminGetUserResponse, cip.AdminGetUserError>;
103 /** Set a user's password (permanent or temporary). */
104 adminSetUserPassword: (
105 request: AdminSetUserPasswordRequest,
106 ) => Effect.Effect<cip.AdminSetUserPasswordResponse, cip.AdminSetUserPasswordError>;
107 /** Update (or add) user attributes as an administrator. */
108 adminUpdateUserAttributes: (
109 request: AdminUpdateUserAttributesRequest,
110 ) => Effect.Effect<cip.AdminUpdateUserAttributesResponse, cip.AdminUpdateUserAttributesError>;
111 /** Delete a user as an administrator. */
112 adminDeleteUser: (
113 request: AdminDeleteUserRequest,
114 ) => Effect.Effect<cip.AdminDeleteUserResponse, cip.AdminDeleteUserError>;
115 /** Confirm a user's sign-up without a confirmation code. */
116 adminConfirmSignUp: (
117 request: AdminConfirmSignUpRequest,
118 ) => Effect.Effect<cip.AdminConfirmSignUpResponse, cip.AdminConfirmSignUpError>;
119 /** Disable a user (prevents sign-in and revokes tokens). */
120 adminDisableUser: (
121 request: AdminDisableUserRequest,
122 ) => Effect.Effect<cip.AdminDisableUserResponse, cip.AdminDisableUserError>;
123 /** Re-enable a disabled user. */
124 adminEnableUser: (
125 request: AdminEnableUserRequest,
126 ) => Effect.Effect<cip.AdminEnableUserResponse, cip.AdminEnableUserError>;
127 /** Force a password reset on next sign-in. */
128 adminResetUserPassword: (
129 request: AdminResetUserPasswordRequest,
130 ) => Effect.Effect<cip.AdminResetUserPasswordResponse, cip.AdminResetUserPasswordError>;
131 /** Start an auth flow with admin credentials (e.g. `ADMIN_USER_PASSWORD_AUTH`). */
132 adminInitiateAuth: (
133 request: AdminInitiateAuthRequest,
134 ) => Effect.Effect<cip.AdminInitiateAuthResponse, cip.AdminInitiateAuthError>;
135 /** Answer an auth challenge from `adminInitiateAuth`. */
136 adminRespondToAuthChallenge: (
137 request: AdminRespondToAuthChallengeRequest,
138 ) => Effect.Effect<cip.AdminRespondToAuthChallengeResponse, cip.AdminRespondToAuthChallengeError>;
139 /** Sign a user out of all devices. */
140 adminUserGlobalSignOut: (
141 request: AdminUserGlobalSignOutRequest,
142 ) => Effect.Effect<cip.AdminUserGlobalSignOutResponse, cip.AdminUserGlobalSignOutError>;
143 /** Add a user to a group. */
144 adminAddUserToGroup: (
145 request: AdminAddUserToGroupRequest,
146 ) => Effect.Effect<cip.AdminAddUserToGroupResponse, cip.AdminAddUserToGroupError>;
147 /** Remove a user from a group. */
148 adminRemoveUserFromGroup: (
149 request: AdminRemoveUserFromGroupRequest,
150 ) => Effect.Effect<cip.AdminRemoveUserFromGroupResponse, cip.AdminRemoveUserFromGroupError>;
151 /** List users in the pool (optionally filtered). */
152 listUsers: (
153 request?: ListUsersRequest,
154 ) => Effect.Effect<cip.ListUsersResponse, cip.ListUsersError>;
155 /** List the users in a group. */
156 listUsersInGroup: (
157 request: ListUsersInGroupRequest,
158 ) => Effect.Effect<cip.ListUsersInGroupResponse, cip.ListUsersInGroupError>;
159 /** Delete attributes from a user's profile as an administrator. */
160 adminDeleteUserAttributes: (
161 request: AdminDeleteUserAttributesRequest,
162 ) => Effect.Effect<cip.AdminDeleteUserAttributesResponse, cip.AdminDeleteUserAttributesError>;
163 /** List the groups a user belongs to. */
164 adminListGroupsForUser: (
165 request: AdminListGroupsForUserRequest,
166 ) => Effect.Effect<cip.AdminListGroupsForUserResponse, cip.AdminListGroupsForUserError>;
167 /** Set a user's MFA preferences (SMS / TOTP / email) as an administrator. */
168 adminSetUserMFAPreference: (
169 request: AdminSetUserMFAPreferenceRequest,
170 ) => Effect.Effect<cip.AdminSetUserMFAPreferenceResponse, cip.AdminSetUserMFAPreferenceError>;
171 /** Link a federated identity to an existing native user. */
172 adminLinkProviderForUser: (
173 request: AdminLinkProviderForUserRequest,
174 ) => Effect.Effect<cip.AdminLinkProviderForUserResponse, cip.AdminLinkProviderForUserError>;
175 /** Unlink a federated identity from a user. */
176 adminDisableProviderForUser: (
177 request: AdminDisableProviderForUserRequest,
178 ) => Effect.Effect<cip.AdminDisableProviderForUserResponse, cip.AdminDisableProviderForUserError>;
179 /** Fetch one of a user's remembered devices. */
180 adminGetDevice: (
181 request: AdminGetDeviceRequest,
182 ) => Effect.Effect<cip.AdminGetDeviceResponse, cip.AdminGetDeviceError>;
183 /** List a user's remembered devices. */
184 adminListDevices: (
185 request: AdminListDevicesRequest,
186 ) => Effect.Effect<cip.AdminListDevicesResponse, cip.AdminListDevicesError>;
187 /** Forget (deregister) one of a user's remembered devices. */
188 adminForgetDevice: (
189 request: AdminForgetDeviceRequest,
190 ) => Effect.Effect<cip.AdminForgetDeviceResponse, cip.AdminForgetDeviceError>;
191 /** Mark a user's device as remembered or not remembered. */
192 adminUpdateDeviceStatus: (
193 request: AdminUpdateDeviceStatusRequest,
194 ) => Effect.Effect<cip.AdminUpdateDeviceStatusResponse, cip.AdminUpdateDeviceStatusError>;
195 /** List a user's sign-in auth events (threat protection history). */
196 adminListUserAuthEvents: (
197 request: AdminListUserAuthEventsRequest,
198 ) => Effect.Effect<cip.AdminListUserAuthEventsResponse, cip.AdminListUserAuthEventsError>;
199 /** Provide valid/invalid feedback on a user's auth event. */
200 adminUpdateAuthEventFeedback: (
201 request: AdminUpdateAuthEventFeedbackRequest,
202 ) => Effect.Effect<
203 cip.AdminUpdateAuthEventFeedbackResponse,
204 cip.AdminUpdateAuthEventFeedbackError
205 >;
206 /** List the groups in the pool. */
207 listGroups: (
208 request?: ListGroupsRequest,
209 ) => Effect.Effect<cip.ListGroupsResponse, cip.ListGroupsError>;
210 }
211
212 /**
213 * Runtime binding for administrative Cognito user pool operations.
214 *
215 * Bind this to a `UserPool` inside a function runtime to get a typed client
216 * for user management and admin auth flows. The binding grants the
217 * corresponding `cognito-idp:*` IAM actions scoped to the pool's ARN and
218 * injects the pool ID into every call.
219 * ### Managing Users
220 * **Example:** Create a User with a Permanent Password
221 * ```typescript
222 * const admin = yield* Cognito.UserPoolAdmin(pool);
223 *
224 * yield* admin.adminCreateUser({
225 * Username: "user@example.com",
226 * MessageAction: "SUPPRESS",
227 * UserAttributes: [
228 * { Name: "email", Value: "user@example.com" },
229 * { Name: "email_verified", Value: "true" },
230 * ],
231 * });
232 * yield* admin.adminSetUserPassword({
233 * Username: "user@example.com",
234 * Password: "Sup3r-secret!",
235 * Permanent: true,
236 * });
237 * ```
238 *
239 * **Example:** Look Up and Delete a User
240 * ```typescript
241 * const user = yield* admin.adminGetUser({ Username: "user@example.com" });
242 * yield* admin.adminDeleteUser({ Username: "user@example.com" });
243 * ```
244 *
245 * ### Groups
246 * **Example:** Manage Group Membership
247 * ```typescript
248 * yield* admin.adminAddUserToGroup({
249 * Username: "user@example.com",
250 * GroupName: "Admins",
251 * });
252 * const admins = yield* admin.listUsersInGroup({ GroupName: "Admins" });
253 * const groups = yield* admin.adminListGroupsForUser({
254 * Username: "user@example.com",
255 * });
256 * ```
257 *
258 * ### Federation and Devices
259 * **Example:** Link a Federated Identity to a Native User
260 * ```typescript
261 * yield* admin.adminLinkProviderForUser({
262 * DestinationUser: {
263 * ProviderName: "Cognito",
264 * ProviderAttributeValue: "user@example.com",
265 * },
266 * SourceUser: {
267 * ProviderName: "Google",
268 * ProviderAttributeName: "Cognito_Subject",
269 * ProviderAttributeValue: googleSub,
270 * },
271 * });
272 * ```
273 *
274 * **Example:** List a User's Remembered Devices
275 * ```typescript
276 * const devices = yield* admin.adminListDevices({
277 * Username: "user@example.com",
278 * });
279 * ```
280 *
281 * @binding
282 */
283 export interface UserPoolAdmin extends Binding.Service<
284 UserPoolAdmin,
285 "AWS.Cognito.UserPoolAdmin",
286 <P extends UserPool>(pool: P) => Effect.Effect<UserPoolAdminClient>
287 > {}
288 export const UserPoolAdmin = Binding.Service<UserPoolAdmin>("AWS.Cognito.UserPoolAdmin");