authula 0.2.0

package/dist/plugins/index.d.ts

@@ -0,0 +1,417 @@
+import { h as User, l as Plugin, p as Account, t as ClientWithPlugins, u as AuthulaClient } from "../sdk-BWoai6MP.js";
+import { z } from "zod";
+
+//#region src/plugins/admin/types.d.ts
+declare const adminUserStateSchema: z.ZodObject<{
+  userId: z.ZodString;
+  isBanned: z.ZodBoolean;
+  bannedAt: z.ZodNullable<z.ZodISODateTime>;
+  bannedUntil: z.ZodNullable<z.ZodISODateTime>;
+  bannedReason: z.ZodNullable<z.ZodString>;
+  bannedByUserId: z.ZodNullable<z.ZodString>;
+  createdAt: z.ZodISODateTime;
+  updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+type AdminUserState = z.infer<typeof adminUserStateSchema>;
+declare const adminSessionStateSchema: z.ZodObject<{
+  sessionId: z.ZodString;
+  revokedAt: z.ZodNullable<z.ZodISODateTime>;
+  revokedReason: z.ZodNullable<z.ZodString>;
+  revokedByUserId: z.ZodNullable<z.ZodString>;
+  impersonatorUserId: z.ZodNullable<z.ZodString>;
+  impersonationReason: z.ZodNullable<z.ZodString>;
+  impersonationExpiresAt: z.ZodNullable<z.ZodISODateTime>;
+  createdAt: z.ZodISODateTime;
+  updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+type AdminSessionState = z.infer<typeof adminSessionStateSchema>;
+declare const adminUserSessionSchema: z.ZodObject<{
+  session: z.ZodObject<{
+    id: z.ZodUUID;
+    userId: z.ZodString;
+    token: z.ZodString;
+    expiresAt: z.ZodISODateTime;
+    ipAddress: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    userAgent: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+  }, z.core.$strip>;
+  state: z.ZodNullable<z.ZodObject<{
+    sessionId: z.ZodString;
+    revokedAt: z.ZodNullable<z.ZodISODateTime>;
+    revokedReason: z.ZodNullable<z.ZodString>;
+    revokedByUserId: z.ZodNullable<z.ZodString>;
+    impersonatorUserId: z.ZodNullable<z.ZodString>;
+    impersonationReason: z.ZodNullable<z.ZodString>;
+    impersonationExpiresAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+type AdminUserSession = z.infer<typeof adminUserSessionSchema>;
+declare const impersonationSchema: z.ZodObject<{
+  id: z.ZodString;
+  actorUserId: z.ZodString;
+  targetUserId: z.ZodString;
+  actorSessionId: z.ZodNullable<z.ZodString>;
+  impersonationSessionId: z.ZodNullable<z.ZodString>;
+  reason: z.ZodString;
+  startedAt: z.ZodISODateTime;
+  expiresAt: z.ZodISODateTime;
+  endedAt: z.ZodNullable<z.ZodISODateTime>;
+  endedByUserId: z.ZodNullable<z.ZodString>;
+  createdAt: z.ZodISODateTime;
+  updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+type Impersonation = z.infer<typeof impersonationSchema>;
+type CreateUserRequest = {
+  name: string;
+  email: string;
+  emailVerified?: boolean;
+  image?: string;
+  metadata?: Record<string, unknown>;
+};
+type CreateUserResponse = {
+  user: User;
+};
+type GetAllUsersResponse = {
+  users: Array<User>;
+  nextCursor?: string | null;
+};
+type GetUserByIdResponse = {
+  user: User;
+};
+type UpdateUserRequest = {
+  name?: string;
+  email?: string;
+  emailVerified?: boolean;
+  image?: string;
+  metadata?: Record<string, unknown>;
+};
+type UpdateUserResponse = {
+  user: User;
+};
+type DeleteUserResponse = {
+  message: string;
+};
+type CreateAccountRequest = {
+  providerId: string;
+  accountId: string;
+  accessToken?: string;
+  refreshToken?: string;
+  idToken?: string;
+  accessTokenExpiresAt?: string;
+  refreshTokenExpiresAt?: string;
+  scope?: string;
+  password?: string;
+};
+type CreateAccountResponse = {
+  account: Account;
+};
+type GetUserAccountsResponse = {
+  accounts: Array<Account>;
+};
+type GetAccountByIdResponse = {
+  account: Account;
+};
+type UpdateAccountRequest = {
+  providerId?: string;
+  accountId?: string;
+  accessToken?: string;
+  refreshToken?: string;
+  idToken?: string;
+  accessTokenExpiresAt?: string;
+  refreshTokenExpiresAt?: string;
+  scope?: string;
+  password?: string;
+};
+type UpdateAccountResponse = {
+  account: Account;
+};
+type DeleteAccountResponse = {
+  message: string;
+};
+type GetUserStateResponse = {
+  state: AdminUserState;
+};
+type CreateUserStateRequest = {
+  banned: boolean;
+  bannedUntil?: string;
+  bannedReason?: string;
+};
+type UpdateUserStateRequest = {
+  banned: boolean;
+  bannedUntil?: string;
+  bannedReason?: string;
+};
+type CreateUserStateResponse = {
+  userState: AdminUserState;
+};
+type UpdateUserStateResponse = {
+  userState: AdminUserState;
+};
+type DeleteUserStateResponse = {
+  message: string;
+};
+type GetBannedUserStatesResponse = Array<AdminUserState>;
+type BanUserRequest = {
+  bannedUntil?: string;
+  reason?: string;
+};
+type BanUserResponse = {
+  state: AdminUserState;
+};
+type UnbanUserResponse = {
+  state: AdminUserState;
+};
+type GetUserAdminSessionsResponse = Array<AdminUserSession>;
+type GetSessionStateResponse = {
+  state: AdminSessionState;
+};
+type CreateSessionStateRequest = {
+  revoke: boolean;
+  revokedReason?: string;
+  impersonatorUserId?: string;
+  impersonationReason?: string;
+  impersonationExpiresAt?: string;
+};
+type UpdateSessionStateRequest = {
+  revoke: boolean;
+  revokedReason?: string;
+  impersonatorUserId?: string;
+  impersonationReason?: string;
+  impersonationExpiresAt?: string;
+};
+type CreateSessionStateResponse = {
+  state: AdminSessionState;
+};
+type UpdateSessionStateResponse = {
+  state: AdminSessionState;
+};
+type DeleteSessionStateResponse = {
+  message: string;
+};
+type GetRevokedSessionStatesResponse = Array<AdminSessionState>;
+type RevokeSessionRequest = {
+  reason?: string;
+};
+type RevokeSessionResponse = {
+  sessionState: AdminSessionState;
+};
+type GetAllImpersonationsResponse = Array<Impersonation>;
+type GetImpersonationByIdResponse = {
+  impersonation: Impersonation;
+};
+type StartImpersonationRequest = {
+  targetUserId: string;
+  reason: string;
+  expiresInSeconds?: number;
+};
+type StartImpersonationResponse = {
+  impersonation: Impersonation;
+};
+type StopImpersonationResponse = {
+  message: string;
+};
+//#endregion
+//#region src/plugins/admin/plugin.d.ts
+declare class AdminPlugin implements Plugin {
+  readonly id = "admin";
+  constructor();
+  init(client: AuthulaClient): {
+    createUser: (data: CreateUserRequest) => Promise<CreateUserResponse>;
+    getAllUsers: (limit?: number) => Promise<GetAllUsersResponse>;
+    getUserById: (userId: string) => Promise<GetUserByIdResponse>;
+    updateUser: (userId: string, data: UpdateUserRequest) => Promise<UpdateUserResponse>;
+    deleteUser: (userId: string) => Promise<DeleteUserResponse>;
+    createAccount: (userId: string, data: CreateAccountRequest) => Promise<CreateAccountResponse>;
+    getUserAccounts: (userId: string) => Promise<GetUserAccountsResponse>;
+    getAccountById: (id: string) => Promise<GetAccountByIdResponse>;
+    updateAccount: (id: string, data: UpdateAccountRequest) => Promise<UpdateAccountResponse>;
+    deleteAccount: (id: string) => Promise<DeleteAccountResponse>;
+    getUserState: (userId: string) => Promise<GetUserStateResponse>;
+    createUserState: (userId: string, data: CreateUserStateRequest) => Promise<CreateUserStateResponse>;
+    updateUserState: (userId: string, data: UpdateUserStateRequest) => Promise<UpdateUserStateResponse>;
+    deleteUserState: (userId: string) => Promise<DeleteUserStateResponse>;
+    getBannedUserStates: () => Promise<GetBannedUserStatesResponse>;
+    banUser: (userId: string, data: BanUserRequest) => Promise<BanUserResponse>;
+    unbanUser: (userId: string) => Promise<UnbanUserResponse>;
+    getUserAdminSessions: (userId: string) => Promise<GetUserAdminSessionsResponse>;
+    getSessionState: (sessionId: string) => Promise<GetSessionStateResponse>;
+    createSessionState: (sessionId: string, data: CreateSessionStateRequest) => Promise<CreateSessionStateResponse>;
+    updateSessionState: (sessionId: string, data: UpdateSessionStateRequest) => Promise<UpdateSessionStateResponse>;
+    deleteSessionState: (sessionId: string) => Promise<DeleteSessionStateResponse>;
+    getRevokedSessionStates: () => Promise<GetRevokedSessionStatesResponse>;
+    revokeSession: (sessionId: string, data: RevokeSessionRequest) => Promise<RevokeSessionResponse>;
+    getAllImpersonations: () => Promise<GetAllImpersonationsResponse>;
+    getImpersonationById: (impersonationId: string) => Promise<GetImpersonationByIdResponse>;
+    startImpersonation: (data: StartImpersonationRequest) => Promise<StartImpersonationResponse>;
+    stopImpersonation: (impersonationId: string) => Promise<StopImpersonationResponse>;
+  };
+}
+//#endregion
+//#region src/plugins/bearer/types.d.ts
+type BearerPluginOptions = {
+  headerName?: string;
+};
+type JWTTokensResponse = {
+  accessToken: string;
+  refreshToken: string;
+};
+//#endregion
+//#region src/plugins/jwt/types.d.ts
+type TokenRefreshRequest = {
+  refreshToken: string;
+};
+type TokenRefreshResponse = {
+  accessToken: string;
+  refreshToken: string;
+};
+type JWTAlgorithm = "eddsa" | "rs256" | "ps256" | "es256" | "es512" | "ecdh-es";
+type JWKSKey = {
+  alg: JWTAlgorithm;
+  crv: string;
+  kid: string;
+  kty: string;
+  x: string;
+};
+//#endregion
+//#region src/plugins/jwt/plugin.d.ts
+declare class JWTPlugin implements Plugin {
+  readonly id = "jwt";
+  constructor();
+  init(client: AuthulaClient): {
+    refreshToken: (data: TokenRefreshRequest) => Promise<TokenRefreshResponse>;
+    getJWKSKeys: () => Promise<Array<JWKSKey>>;
+  };
+}
+//#endregion
+//#region src/plugins/bearer/plugin.d.ts
+declare class BearerPlugin implements Plugin {
+  private readonly options?;
+  readonly id = "bearer";
+  private refreshPromise;
+  constructor(options?: BearerPluginOptions | undefined);
+  init(client: ClientWithPlugins<[JWTPlugin]>): {};
+}
+//#endregion
+//#region src/plugins/csrf/types.d.ts
+type CSRFPluginOptions = {
+  cookieName: string;
+  headerName: string;
+};
+//#endregion
+//#region src/plugins/csrf/plugin.d.ts
+declare class CSRFPlugin implements Plugin {
+  private readonly options;
+  readonly id = "csrf";
+  constructor(options: CSRFPluginOptions);
+  init(client: AuthulaClient): {};
+  private cookies?;
+  attachCookies(fn: () => Promise<any>): void;
+}
+//#endregion
+//#region src/plugins/email-password/types.d.ts
+type SignUpRequest = {
+  name: string;
+  email: string;
+  password: string;
+  callbackUrl?: string;
+};
+type SignInRequest = {
+  email: string;
+  password: string;
+  callbackUrl?: string;
+};
+type VerifyEmailRequest = {
+  token: string;
+  callbackUrl?: string;
+};
+type SendEmailVerificationRequest = {
+  email: string;
+  callbackUrl?: string;
+};
+type RequestPasswordResetRequest = {
+  email: string;
+  callbackUrl?: string;
+};
+type ChangePasswordRequest = {
+  token: string;
+  password: string;
+};
+type RequestEmailChangeRequest = {
+  email: string;
+  callbackUrl?: string;
+};
+//#endregion
+//#region src/plugins/email-password/plugin.d.ts
+declare class EmailPasswordPlugin implements Plugin {
+  readonly id = "emailPassword";
+  init(client: AuthulaClient): {
+    signUp: <T>(data: SignUpRequest) => Promise<T>;
+    signIn: <T>(data: SignInRequest) => Promise<T>;
+    sendEmailVerification: (data: SendEmailVerificationRequest) => Promise<void>;
+    requestPasswordReset: (data: RequestPasswordResetRequest) => Promise<void>;
+    changePassword: (data: ChangePasswordRequest) => Promise<void>;
+    requestEmailChange: (data: RequestEmailChangeRequest) => Promise<void>;
+  };
+}
+//#endregion
+//#region src/plugins/magic-link/types.d.ts
+type MagicLinkSignInRequest = {
+  email: string;
+  name?: string;
+  callbackUrl?: string;
+};
+type MagicLinkSignInResponse = {
+  message: string;
+};
+type MagicLinkVerifyRequest = {
+  token: string;
+  callbackUrl?: string;
+};
+type MagicLinkVerifyResponse = {
+  message: string;
+  token: string;
+};
+type MagicLinkExchangeRequest = {
+  token: string;
+};
+//#endregion
+//#region src/plugins/magic-link/plugin.d.ts
+declare class MagicLinkPlugin implements Plugin {
+  readonly id = "magicLink";
+  constructor();
+  init(client: AuthulaClient): {
+    signIn: (data: MagicLinkSignInRequest) => Promise<MagicLinkSignInResponse>;
+    verify: (data: MagicLinkVerifyRequest) => Promise<MagicLinkVerifyResponse>;
+    exchange: <T>(data: MagicLinkExchangeRequest) => Promise<T>;
+  };
+}
+//#endregion
+//#region src/plugins/oauth2/types.d.ts
+/**
+ * OAuth2 provider types supported by Authula
+ */
+type OAuth2ProviderType = "discord" | "github" | "google";
+/**
+ * OAuth2 authorization options
+ */
+type SignInWithOAuth2Request = {
+  /** OAuth2 provider to use */provider: OAuth2ProviderType;
+  redirectTo?: string;
+};
+type SignInWithOAuth2Response = {
+  authUrl: string;
+};
+//#endregion
+//#region src/plugins/oauth2/plugin.d.ts
+declare class OAuth2Plugin implements Plugin {
+  readonly id = "oauth2";
+  init(client: AuthulaClient): {
+    signIn: (data: SignInWithOAuth2Request) => Promise<SignInWithOAuth2Response>;
+  };
+}
+//#endregion
+export { AdminPlugin, AdminSessionState, AdminUserSession, AdminUserState, BanUserRequest, BanUserResponse, BearerPlugin, BearerPluginOptions, CSRFPlugin, CSRFPluginOptions, ChangePasswordRequest, CreateAccountRequest, CreateAccountResponse, CreateSessionStateRequest, CreateSessionStateResponse, CreateUserRequest, CreateUserResponse, CreateUserStateRequest, CreateUserStateResponse, DeleteAccountResponse, DeleteSessionStateResponse, DeleteUserResponse, DeleteUserStateResponse, EmailPasswordPlugin, GetAccountByIdResponse, GetAllImpersonationsResponse, GetAllUsersResponse, GetBannedUserStatesResponse, GetImpersonationByIdResponse, GetRevokedSessionStatesResponse, GetSessionStateResponse, GetUserAccountsResponse, GetUserAdminSessionsResponse, GetUserByIdResponse, GetUserStateResponse, Impersonation, JWKSKey, JWTAlgorithm, JWTPlugin, JWTTokensResponse, MagicLinkExchangeRequest, MagicLinkPlugin, MagicLinkSignInRequest, MagicLinkSignInResponse, MagicLinkVerifyRequest, MagicLinkVerifyResponse, OAuth2Plugin, OAuth2ProviderType, RequestEmailChangeRequest, RequestPasswordResetRequest, RevokeSessionRequest, RevokeSessionResponse, SendEmailVerificationRequest, SignInRequest, SignInWithOAuth2Request, SignInWithOAuth2Response, SignUpRequest, StartImpersonationRequest, StartImpersonationResponse, StopImpersonationResponse, TokenRefreshRequest, TokenRefreshResponse, UnbanUserResponse, UpdateAccountRequest, UpdateAccountResponse, UpdateSessionStateRequest, UpdateSessionStateResponse, UpdateUserRequest, UpdateUserResponse, UpdateUserStateRequest, UpdateUserStateResponse, VerifyEmailRequest, adminSessionStateSchema, adminUserSessionSchema, adminUserStateSchema, impersonationSchema };
+//# sourceMappingURL=index.d.ts.map