@nhost/nhost-js 3.2.8 → 5.0.0-beta.2

package/dist/src/auth/client.js

@@ -0,0 +1,727 @@
+/**
+ * Generated by orval v7.9.0 🍺
+ * Do not edit manually.
+ * Nhost Authentication API
+ * Comprehensive authentication service for managing user identities, sessions, and authentication methods
+ * OpenAPI spec version: 1.0.0
+ */
+import { createEnhancedFetch } from "../fetch";
+export const createAPIClient = (baseURL, chainFunctions = []) => {
+    let fetch = createEnhancedFetch(chainFunctions);
+    const pushChainFunction = (chainFunction) => {
+        chainFunctions.push(chainFunction);
+        fetch = createEnhancedFetch(chainFunctions);
+    };
+    /**
+     * Verify if the authentication service is operational using HEAD method
+     * @summary Health check (HEAD)
+     */
+    const healthCheckHead = async (options) => {
+        const res = await fetch(getHealthCheckHeadUrl(), {
+            ...options,
+            method: "HEAD",
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getHealthCheckHeadUrl = () => {
+        return baseURL + `/healthz`;
+    };
+    /**
+     * Verify if the authentication service is operational using GET method
+     * @summary Health check (GET)
+     */
+    const healthCheckGet = async (options) => {
+        const res = await fetch(getHealthCheckGetUrl(), {
+            ...options,
+            method: "GET",
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getHealthCheckGetUrl = () => {
+        return baseURL + `/healthz`;
+    };
+    /**
+     * Retrieve version information about the authentication service
+     * @summary Get service version
+     */
+    const getVersion = async (options) => {
+        const res = await fetch(getGetVersionUrl(), {
+            ...options,
+            method: "GET",
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getGetVersionUrl = () => {
+        return baseURL + `/version`;
+    };
+    /**
+     * Generate a new JWT access token using a valid refresh token. The refresh token used will be revoked and a new one will be issued.
+     * @summary Refresh access token
+     */
+    const refreshToken = async (refreshTokenRequest, options) => {
+        const res = await fetch(getRefreshTokenUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(refreshTokenRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getRefreshTokenUrl = () => {
+        return baseURL + `/token`;
+    };
+    /**
+     * @summary Sign out
+     */
+    const signOut = async (signOutSchema, options) => {
+        const res = await fetch(getSignOutUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signOutSchema),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignOutUrl = () => {
+        return baseURL + `/signout`;
+    };
+    /**
+     * Authenticate a user with their email and password. Returns a session object or MFA challenge if two-factor authentication is enabled.
+     * @summary Sign in with email and password
+     */
+    const signInEmailPassword = async (signInEmailPasswordRequest, options) => {
+        const res = await fetch(getSignInEmailPasswordUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInEmailPasswordRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInEmailPasswordUrl = () => {
+        return baseURL + `/signin/email-password`;
+    };
+    /**
+     * Complete the multi-factor authentication by verifying a Time-based One-Time Password (TOTP). Returns a session if validation is successful.
+     * @summary Verify TOTP for MFA
+     */
+    const signInVerifyMfaTotp = async (signInMfaTotpRequest, options) => {
+        const res = await fetch(getSignInVerifyMfaTotpUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInMfaTotpRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInVerifyMfaTotpUrl = () => {
+        return baseURL + `/signin/mfa/totp`;
+    };
+    /**
+     * Initiate passwordless authentication by sending a magic link to the user's email. If the user doesn't exist, a new account will be created with the provided options.
+     * @summary Sign in with magic link email
+     */
+    const signInPasswordlessEmail = async (signInPasswordlessEmailRequest, options) => {
+        const res = await fetch(getSignInPasswordlessEmailUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInPasswordlessEmailRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInPasswordlessEmailUrl = () => {
+        return baseURL + `/signin/passwordless/email`;
+    };
+    /**
+     * Register a new user account with email and password. Returns a session if email verification is not required, otherwise returns null session.
+     * @summary Sign up with email and password
+     */
+    const signUpEmailPassword = async (signUpEmailPasswordRequest, options) => {
+        const res = await fetch(getSignUpEmailPasswordUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signUpEmailPasswordRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignUpEmailPasswordUrl = () => {
+        return baseURL + `/signup/email-password`;
+    };
+    /**
+     * Activate or deactivate multi-factor authentication for the authenticated user
+     * @summary Manage multi-factor authentication
+     */
+    const changeUserMfaVerify = async (userMfaRequest, options) => {
+        const res = await fetch(getChangeUserMfaVerifyUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(userMfaRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getChangeUserMfaVerifyUrl = () => {
+        return baseURL + `/user/mfa`;
+    };
+    /**
+     * Generate a Time-based One-Time Password (TOTP) secret for setting up multi-factor authentication
+     * @summary Generate TOTP secret
+     */
+    const changeUserMfa = async (options) => {
+        const res = await fetch(getChangeUserMfaUrl(), {
+            ...options,
+            method: "GET",
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getChangeUserMfaUrl = () => {
+        return baseURL + `/mfa/totp/generate`;
+    };
+    /**
+     * @summary Get public keys for JWT verification in JWK Set format
+     */
+    const getJWKs = async (options) => {
+        const res = await fetch(getGetJWKsUrl(), {
+            ...options,
+            method: "GET",
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getGetJWKsUrl = () => {
+        return baseURL + `/.well-known/jwks.json`;
+    };
+    /**
+     * @summary Create a Personal Access Token (PAT)
+     */
+    const createPAT = async (createPATRequest, options) => {
+        const res = await fetch(getCreatePATUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(createPATRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getCreatePATUrl = () => {
+        return baseURL + `/pat`;
+    };
+    /**
+     * @summary Sign in anonymously
+     */
+    const signInAnonymous = async (signinAnonymousRequest, options) => {
+        const res = await fetch(getSignInAnonymousUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signinAnonymousRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInAnonymousUrl = () => {
+        return baseURL + `/signin/anonymous`;
+    };
+    /**
+     * @summary Sign in with a one time password sent to user's email. If the user doesn't exist, it will be created. The options object is optional and can be used to configure the user's when signing up a new user. It is ignored if the user already exists.
+     */
+    const signInOTPEmail = async (signInOTPEmailRequest, options) => {
+        const res = await fetch(getSignInOTPEmailUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInOTPEmailRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInOTPEmailUrl = () => {
+        return baseURL + `/signin/otp/email`;
+    };
+    /**
+     * @summary Verify OTP and return a session if validation is successful
+     */
+    const verifySignInOTPEmail = async (signInOTPEmailVerifyRequest, options) => {
+        const res = await fetch(getVerifySignInOTPEmailUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInOTPEmailVerifyRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getVerifySignInOTPEmailUrl = () => {
+        return baseURL + `/signin/otp/email/verify`;
+    };
+    /**
+     * @summary Sign in with Personal Access Token (PAT)
+     */
+    const signInPAT = async (signInPATRequest, options) => {
+        const res = await fetch(getSignInPATUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInPATRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInPATUrl = () => {
+        return baseURL + `/signin/pat`;
+    };
+    /**
+     * @summary Sign in with in an id token
+     */
+    const signInIdToken = async (signInIdTokenRequest, options) => {
+        const res = await fetch(getSignInIdTokenUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(signInIdTokenRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSignInIdTokenUrl = () => {
+        return baseURL + `/signin/idtoken`;
+    };
+    /**
+     * @summary Link a user account with the provider's account using an id token
+     */
+    const linkIdToken = async (linkIdTokenRequest, options) => {
+        const res = await fetch(getLinkIdTokenUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(linkIdTokenRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getLinkIdTokenUrl = () => {
+        return baseURL + `/link/idtoken`;
+    };
+    /**
+     * @summary Deanonymize an anonymous user in adding missing email or email+password, depending on the chosen authentication method. Will send a confirmation email if the server is configured to do so
+     */
+    const deanonymizeUser = async (userDeanonymizeRequest, options) => {
+        const res = await fetch(getDeanonymizeUserUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(userDeanonymizeRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getDeanonymizeUserUrl = () => {
+        return baseURL + `/user/deanonymize`;
+    };
+    /**
+     * @summary Change user email
+     */
+    const changeUserEmail = async (userEmailChangeRequest, options) => {
+        const res = await fetch(getChangeUserEmailUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(userEmailChangeRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getChangeUserEmailUrl = () => {
+        return baseURL + `/user/email/change`;
+    };
+    /**
+     * @summary Send verification email
+     */
+    const sendVerificationEmail = async (userEmailSendVerificationEmailRequest, options) => {
+        const res = await fetch(getSendVerificationEmailUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(userEmailSendVerificationEmailRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSendVerificationEmailUrl = () => {
+        return baseURL + `/user/email/send-verification-email`;
+    };
+    /**
+     * @summary Change user password. The user must be authenticated or provide a ticket
+     */
+    const changeUserPassword = async (userPasswordRequest, options) => {
+        const res = await fetch(getChangeUserPasswordUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(userPasswordRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getChangeUserPasswordUrl = () => {
+        return baseURL + `/user/password`;
+    };
+    /**
+     * @summary Request a password reset. An email with a verification link will be sent to the user's address
+     */
+    const sendPasswordResetEmail = async (userPasswordResetRequest, options) => {
+        const res = await fetch(getSendPasswordResetEmailUrl(), {
+            ...options,
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(userPasswordResetRequest),
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getSendPasswordResetEmailUrl = () => {
+        return baseURL + `/user/password/reset`;
+    };
+    /**
+     * @summary Verify tickets created by email verification, email passwordless authentication (magic link), or password reset
+     */
+    const verifyTicket = async (params, options) => {
+        const res = await fetch(getVerifyTicketUrl(params), {
+            ...options,
+            method: "GET",
+        });
+        const body = [204, 205, 304, 412].includes(res.status)
+            ? null
+            : await res.text();
+        const payload = body ? JSON.parse(body) : {};
+        const response = {
+            body: payload,
+            status: res.status,
+            headers: res.headers,
+        };
+        if (!res.ok) {
+            throw response;
+        }
+        return response;
+    };
+    const getVerifyTicketUrl = (params) => {
+        const normalizedParams = new URLSearchParams();
+        Object.entries(params || {}).forEach(([key, value]) => {
+            if (value !== undefined) {
+                normalizedParams.append(key, value === null ? "null" : value.toString());
+            }
+        });
+        const stringifiedParams = normalizedParams.toString();
+        return stringifiedParams.length > 0
+            ? baseURL + `/verify?${stringifiedParams}`
+            : baseURL + `/verify`;
+    };
+    return {
+        healthCheckHead,
+        healthCheckGet,
+        getVersion,
+        refreshToken,
+        signOut,
+        signInEmailPassword,
+        signInVerifyMfaTotp,
+        signInPasswordlessEmail,
+        signUpEmailPassword,
+        changeUserMfaVerify,
+        changeUserMfa,
+        getJWKs,
+        createPAT,
+        signInAnonymous,
+        signInOTPEmail,
+        verifySignInOTPEmail,
+        signInPAT,
+        signInIdToken,
+        linkIdToken,
+        deanonymizeUser,
+        changeUserEmail,
+        sendVerificationEmail,
+        changeUserPassword,
+        sendPasswordResetEmail,
+        verifyTicket,
+        pushChainFunction,
+        baseURL,
+    };
+};
+//# sourceMappingURL=client.js.map