anzar 1.1.12 → 1.2.6

package/dist/index.d.ts

@@ -1,58 +1,323 @@
-interface AuthError {
-    message: string;
+import * as axios from 'axios';
+import { AxiosInstance, RawAxiosRequestConfig } from 'axios';
+
+/**
+ * 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;
 }
 
-type HttpResult<R> = {
-    ok: true;
-    data: R;
-} | {
-    ok: false;
-    error: AuthError;
-};
+/**
+ * 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);
+}
 
-interface HttpClient {
-    get<R>(url: string): Promise<HttpResult<R>>;
-    post<T, R>(url: string, obj: T): Promise<HttpResult<R>>;
+/**
+ * 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 SessionTokens {
+    'access': string;
+    'refresh': string;
 }
 
-type Session = {
-    _id: string | null;
-    userId: string;
-    issuedAt: string;
-    expiresAt: string;
-    usedAt: string | null;
-    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.
+ */
+declare const Role: {
+    readonly User: "User";
+    readonly Admin: "Admin";
 };
+type Role = typeof Role[keyof typeof Role];
+
+/**
+ * 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 enum Role {
-    Admin = "Admin",
-    User = "User"
+interface User {
+    '_id'?: string | null;
+    'createdAt': string;
+    'email': string;
+    'role': Role;
+    'username': string;
+    'verified': boolean;
 }
-type User = {
-    _id: string | null;
-    username: string;
-    email: string;
-    role: Role;
-    verified: boolean;
-    createdAt: string;
-};
 
-type ResetLink = {
-    link: string;
-    expires_at: string;
-};
-type Verification = {
-    token: string;
-    link: string;
-};
-type AuthPayload = {
-    user: User;
-    verification: Verification | null;
-};
-type AuthUser = {
-    user: User;
-    session: Session | 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.
+ */
+/**
+ * Verification model
+ */
+interface Verification {
+    'link': 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 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 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 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;
+}
+
+/**
+ * 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",
@@ -124,20 +389,24 @@ type AnzarConfig = {
     auth: Authentication | null;
 };
 
-declare class AnzarAuth {
-    private httpClient;
-    private config;
-    constructor(httpClient: HttpClient, config: AnzarConfig);
-    auth: {
-        login: (email: string, password: string) => Promise<AuthPayload | AuthError>;
-        register: (username: string, email: string, password: string) => Promise<AuthPayload | AuthError>;
-        logout: () => Promise<null | AuthError>;
-        session: () => Promise<AuthError | AuthUser>;
-        isLoggedIn: () => Promise<boolean>;
-        resetPassword: (email: string) => Promise<ResetLink | AuthError>;
-    };
+interface SdkOptions {
+    getToken: () => string | null;
+    getRefreshToken: () => string | null;
+    onTokenRefresh?: (tokens: SessionTokens) => void;
+    onSessionExpired?: () => void;
+    onLogout?: () => void;
 }
 
-declare function Anzar(config: AnzarConfig): AnzarAuth;
+declare function Anzar(anzarConfig: AnzarConfig, options?: SdkOptions): {
+    Auth: {
+        session?: (() => Promise<axios.AxiosResponse<Session, any, {}>>) | undefined;
+        login: (body: LoginRequest) => Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
+        register: (body: RegisterRequest) => Promise<axios.AxiosResponse<AuthResponse, any, {}>>;
+        logout: () => Promise<void>;
+        resetPassword: (body: EmailRequest) => void;
+    };
+    User: UsersApi;
+    Email: EmailApi;
+};
 
 export { Anzar };