@anzar-auth/client 1.3.6

package/dist/index.d.cts

@@ -0,0 +1,465 @@
+import * as axios from 'axios';
+import { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { S as SessionTokens, B as BaseStorage } from './base_storage-BnHsA4fU.cjs';
+import { U as User, V as Verification, A as AuthResult } from './index-BZFSacf5.cjs';
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface AWSv4Configuration {
+    options?: {
+        region?: string;
+        service?: string;
+    };
+    credentials?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        sessionToken?: string;
+    };
+}
+interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
+    basePath?: string;
+    serverIndex?: number;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
+    /**
+     * override base path
+     */
+    basePath?: string;
+    /**
+     * override server index
+     */
+    serverIndex?: number;
+    /**
+     * base options for axios calls
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+interface AuthResponse {
+    'tokens'?: SessionTokens | null;
+    'user': User;
+    'verification'?: Verification | null;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface EmailRequest {
+    'email': string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface LoginRequest {
+    'email': string;
+    'password': string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface RefreshTokenRequest {
+    'refresh_token': string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface RegisterRequest {
+    'email': string;
+    'password': string;
+    'username': string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface ResetLink {
+    'expires_at': string;
+    'link': string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface ResetPasswordRequest {
+    'csrf_token': string;
+    'password': string;
+    'token': string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface Session {
+    '_id'?: string | null;
+    'expiresAt': string;
+    'issuedAt': string;
+    'token': string;
+    'usedAt'?: string | null;
+    'userId'?: string;
+}
+
+/**
+ * Anzar Software API
+ * REST API for the Anzar platform. All protected routes require a Bearer token.
+ *
+ * The version of the OpenAPI document: 0.6.2
+ * Contact: dev@anzar.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface TokenQuery {
+    'token': string;
+}
+
+/**
+ * AuthApi - object-oriented interface
+ */
+declare class AuthApi extends BaseAPI {
+    /**
+     * Returns the currently authenticated user\'s session data. Requires a valid Bearer token.
+     * @summary Get current session
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSession(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<Session, any, {}>>;
+    /**
+     * Authenticates a user with email and password. Returns an access token and refresh token on success.
+     * @summary User login
+     * @param {LoginRequest} loginRequest User login credentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    login(loginRequest: LoginRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
+    /**
+     * Invalidates the current session and refresh token. The client should discard stored tokens.
+     * @summary Logout
+     * @param {RefreshTokenRequest} refreshTokenRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    logout(refreshTokenRequest: RefreshTokenRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
+    /**
+     * Issues a new access token using a valid refresh token. Rotate refresh tokens on each call.
+     * @summary Refresh access token
+     * @param {RefreshTokenRequest} refreshTokenRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    refreshToken(refreshTokenRequest: RefreshTokenRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
+    /**
+     * Creates a new user account. Sends a verification email upon successful registration.
+     * @summary Register a new user
+     * @param {RegisterRequest} registerRequest User register credentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    register(registerRequest: RegisterRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
+    /**
+     * Validates the reset token from the email link and renders the password reset form.
+     * @summary Render password reset form
+     * @param {TokenQuery} token Password reset token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    renderResetForm(token: TokenQuery, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<string, any, {}>>;
+    /**
+     * Sends a password reset link to the provided email address if an account exists.
+     * @summary Request a password reset
+     * @param {EmailRequest} emailRequest Email address to send the reset link to
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    requestPasswordReset(emailRequest: EmailRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<ResetLink, any, {}>>;
+    /**
+     * Submits a new password using a valid reset token. Invalidates the token after use.
+     * @summary Submit new password
+     * @param {ResetPasswordRequest} resetPasswordRequest Reset token and the new password
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    submitNewPassword(resetPasswordRequest: ResetPasswordRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
+}
+
+/**
+ * EmailApi - object-oriented interface
+ */
+declare class EmailApi extends BaseAPI {
+    /**
+     * Validates the email token and update the user account.
+     * @summary Verify user email
+     * @param {TokenQuery} token Email Verification Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    verifyEmail(token: TokenQuery, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
+}
+
+/**
+ * UsersApi - object-oriented interface
+ */
+declare class UsersApi extends BaseAPI {
+    /**
+     * Returns the currently authenticated user\'s data. Requires a valid Bearer token.
+     * @summary Get current User
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findUser(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<User, any, {}>>;
+}
+
+declare enum DatabaseDriver {
+    SQLite = "SQLite",
+    PostgreSQL = "PostgreSQL",
+    MongoDB = "MongoDB"
+}
+type Database = {
+    driver: DatabaseDriver;
+    connection_string: string;
+};
+type HttpsConfig = {
+    enabled: boolean;
+    port: number;
+    cert_path: string | null;
+    key_path: string | null;
+};
+type CorsConfig = {
+    allowed_origins: string[];
+};
+type Server = {
+    https: HttpsConfig | null;
+    cors: CorsConfig | null;
+};
+declare enum AuthStrategy {
+    Jwt = "Jwt",
+    Session = "Session"
+}
+type JWT = {
+    expires_in: number | null;
+    refresh_expires_in: number | null;
+};
+type EmailVerification = {
+    required: boolean | null;
+    token_expires_in: number | null;
+};
+type EmailConfig = {
+    verification: EmailVerification | null;
+};
+type PasswordRequirements = {
+    min_length: number | null;
+    max_length: number | null;
+};
+type PasswordReset = {
+    token_expires_in: number | null;
+};
+type PasswordSecurity = {
+    max_failed_login_attempts: number | null;
+    lockout_duration: number | null;
+};
+type PasswordConfig = {
+    requirements: PasswordRequirements | null;
+    reset: PasswordReset | null;
+    security: PasswordSecurity | null;
+};
+type Authentication = {
+    strategy: AuthStrategy | null;
+    jwt: JWT | null;
+    email: EmailConfig | null;
+    password: PasswordConfig | null;
+};
+type Security = {
+    secret_key: string;
+};
+type AnzarConfig = {
+    api_url: string;
+    database: Database;
+    security: Security;
+    server: Server | null;
+    auth: Authentication | null;
+};
+
+interface SdkOptions {
+    storage: BaseStorage;
+}
+
+declare class AuthModule {
+    private readonly authApi;
+    private readonly userApi;
+    private readonly strategy;
+    private readonly options?;
+    constructor(authApi: AuthApi, userApi: UsersApi, strategy: AuthStrategy, options?: SdkOptions | undefined);
+    login(body: LoginRequest): Promise<AuthResult>;
+    register(body: RegisterRequest): Promise<AuthResult>;
+    logout(): Promise<void>;
+    resetPassword(body: EmailRequest): void;
+    isAuthenticated(): Promise<boolean>;
+    session(): Promise<Session>;
+}
+
+declare class Anzar {
+    Auth: AuthModule;
+    User: UsersApi;
+    Email: EmailApi;
+    constructor(anzarConfig: AnzarConfig, options?: SdkOptions);
+    private createAxiosInstance;
+    private createApis;
+}
+
+export { Anzar };