skapi-js 1.2.14-beta.3 → 1.2.14-beta.6

package/js/main/skapi.d.ts

@@ -1,443 +0,0 @@
-import { DatabaseResponse, Connection, ProgressCallback, GetRecordQuery, FetchOptions, RecordData, Condition, UserAttributes, UserProfile, Newsletter, Form, PostRecordConfig, UserPublic, UserProfilePublicSettings, FileInfo, RTCEvent, RealtimeCallback, RTCConnectorParams, RTCConnector, DelRecordQuery, ConnectionInfo, Table, Index, Tag, UniqueId, Subscription } from '../Types';
-import { terminatePendingRequests } from '../utils/network';
-import { extractFormData, fromBase62, generateRandom, toBase62, MD5, decodeServiceId, formatServiceId } from '../utils/utils';
-type Options = {
-    autoLogin: boolean;
-    requestBatchSize?: number;
-    eventListener?: {
-        onLogin?: (user: UserProfile | null) => void;
-        onUserUpdate?: (user: UserProfile | null) => void;
-        onBatchProcess?: (process: {
-            batchToProcess: number;
-            itemsToProcess: number;
-            completed: any[];
-        }) => void;
-    };
-};
-export default class Skapi {
-    private __version;
-    service: string;
-    owner: string;
-    session: Record<string, any> | null;
-    connection: Connection | null;
-    private __my_unique_ids;
-    private userPool;
-    private __socket;
-    private __mediaStream;
-    private host;
-    private hostDomain;
-    private target_cdn;
-    private customApiDomain;
-    private requestBatchSize;
-    private __disabledAccount;
-    private __cached_requests;
-    private __startKeyHistory;
-    private __request_signup_confirmation;
-    private __private_access_key;
-    private __class_properties_has_been_cached;
-    private __user;
-    get user(): UserProfile | null;
-    set user(value: UserProfile | null);
-    private _userProfileListeners;
-    private _onLoginListeners;
-    get onLogin(): Function[];
-    set onLogin(listener: (user: UserProfile | null) => void);
-    get onUserUpdate(): Function[];
-    set onUserUpdate(listener: (user: UserProfile | null) => void);
-    private _runOnUserUpdateListeners;
-    private _runOnLoginListeners;
-    private admin_endpoint;
-    private record_endpoint;
-    private _onBatchProcessListeners;
-    get onBatchProcess(): ((process: {
-        batchToProcess: number;
-        itemsToProcess: number;
-        completed: any[];
-    }) => void)[];
-    set onBatchProcess(listener: (process: {
-        batchToProcess: number;
-        itemsToProcess: number;
-        completed: any[];
-    }) => void);
-    validate: {
-        userId(val: string): boolean;
-        url(val: string | string[]): boolean;
-        phoneNumber(val: string): boolean;
-        birthdate(val: string): boolean;
-        email(val: string): boolean;
-        params(val: any, schema: Record<string, any>, required?: string[]): any;
-    };
-    util: {
-        MD5: typeof MD5;
-        generateRandom: typeof generateRandom;
-        toBase62: typeof toBase62;
-        fromBase62: typeof fromBase62;
-        decodeServiceId: typeof decodeServiceId;
-        formatServiceId: typeof formatServiceId;
-        extractFormData: typeof extractFormData;
-        terminatePendingRequests: typeof terminatePendingRequests;
-        request: (url: string, data?: Form<any>, options?: {
-            fetchOptions?: FetchOptions;
-            auth?: boolean;
-            method?: string;
-            bypassAwaitConnection?: boolean;
-            responseType?: "json" | "blob" | "text" | "arrayBuffer" | "formData" | "document";
-            contentType?: string;
-        }) => Promise<any>;
-    };
-    private __connection;
-    private __authConnection;
-    private __network_logs;
-    private __endpoint_version;
-    private __public_identifier;
-    private bearerToken;
-    private _alert;
-    constructor(service: string, owner?: string | Options, options?: Options | any, __etc?: any);
-    getConnectionInfo(): Promise<ConnectionInfo>;
-    private _updateConnection;
-    private registerTicket;
-    private unregisterTicket;
-    version(): Promise<string>;
-    private log;
-    getFeed(params?: {
-        access_group?: number;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RecordData>>;
-    closeRTC(params: {
-        cid?: string;
-        close_all?: boolean;
-    }): Promise<void>;
-    connectRTC(params: RTCConnectorParams, callback?: RTCEvent): Promise<RTCConnector>;
-    connectRealtime(callback: RealtimeCallback): Promise<WebSocket>;
-    spellcast(params: any): Promise<any>;
-    getspell(params: any): Promise<any>;
-    dopamine(params: any): Promise<void>;
-    getUniqueId(params: Form<{
-        unique_id?: string;
-        condition?: Condition;
-    }>, fetchOptions?: FetchOptions): Promise<DatabaseResponse<UniqueId>>;
-    resendInvitation(params: Form<{
-        email: string;
-        confirmation_url?: string;
-    }>): Promise<"SUCCESS: Invitation has been re-sent. (User ID: xxx...)">;
-    cancelInvitation(params: Form<{
-        email: string;
-    }>): Promise<"SUCCESS: Invitation has been canceled.">;
-    getInvitations(params: Form<{
-        email?: string;
-    }>, fetchOptions: FetchOptions): Promise<DatabaseResponse<UserProfile>>;
-    openIdLogin(params: {
-        token: string;
-        id: string;
-        merge?: boolean | string[];
-    }): Promise<{
-        userProfile: UserProfile;
-        openid: {
-            [attribute: string]: string;
-        };
-    }>;
-    loginWithToken(params: {
-        idToken: string;
-        accessToken?: string;
-        refreshToken?: string;
-    }): Promise<UserProfile>;
-    registerNewsletterGroup(params: Form<{
-        group: string;
-        restriction: number;
-    }>): Promise<"SUCCESS: Your newsletter group has been registered.">;
-    clientSecretRequest(params: {
-        url: string;
-        clientSecretName: string;
-        method: 'GET' | 'POST' | 'DELETE' | 'PUT';
-        headers?: {
-            [key: string]: string;
-        };
-        data?: {
-            [key: string]: any;
-        };
-        params?: {
-            [key: string]: string;
-        };
-    }): Promise<any>;
-    consumeTicket(params: {
-        ticket_id: string;
-        method: string;
-        auth?: boolean;
-        data?: {
-            [key: string]: any;
-        };
-    }): Promise<any>;
-    getConsumedTickets(params: {
-        ticket_id?: string;
-    }, fetchOptions: FetchOptions): Promise<DatabaseResponse<any[]>>;
-    getTickets(params: {
-        ticket_id?: string;
-    }, fetchOptions: FetchOptions): Promise<DatabaseResponse<any[]>>;
-    closeRealtime(): Promise<void>;
-    getRealtimeUsers(params: {
-        group: string;
-        user_id?: string;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<{
-        user_id: string;
-        cid: string;
-    }[]>>;
-    sendInquiry(data: Form<{
-        name: string;
-        email: string;
-        subject: string;
-        message: string;
-    }>): Promise<"SUCCESS: Inquiry has been sent.">;
-    blockAccount(form: {
-        user_id: string;
-    }): Promise<"SUCCESS: The user has been blocked.">;
-    unblockAccount(form: {
-        user_id: string;
-    }): Promise<"SUCCESS: The user has been unblocked.">;
-    deleteAccount(form: {
-        user_id: string;
-    }): Promise<"SUCCESS: Account has been deleted.">;
-    inviteUser(form: {
-        email: string;
-    } & UserAttributes & UserProfilePublicSettings, options?: {
-        confirmation_url?: string;
-        email_subscription?: boolean;
-        template?: {
-            url: string;
-            subject: string;
-        };
-    }): Promise<'SUCCESS: Invitation has been sent.'>;
-    createAccount(form: {
-        email: string;
-        password: string;
-    } & UserAttributes & UserProfilePublicSettings): Promise<UserProfile & UserPublic & {
-        email_admin: string;
-        approved: string;
-        log: number;
-        username: string;
-    }>;
-    grantAccess(params: {
-        user_id: string;
-        access_group: number;
-    }): Promise<'SUCCESS: Access has been granted to the user.'>;
-    getRealtimeGroups(params?: {
-        searchFor: 'group' | 'number_of_users';
-        value: string | number;
-        condition?: '>' | '>=' | '=' | '<' | '<=' | '!=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte' | 'ne';
-        range?: string | number;
-    } | null, fetchOptions?: FetchOptions): Promise<DatabaseResponse<{
-        group: string;
-        number_of_users: number;
-    }>>;
-    newsletterGroupEndpoint(params: any): Promise<any>;
-    postRealtime(message: any, recipient: string, notification?: {
-        config?: {
-            always: boolean;
-        };
-        title: string;
-        body: string;
-    }): Promise<{
-        type: 'success';
-        message: 'Message sent.';
-    }>;
-    joinRealtime(params: {
-        group: string | null;
-    }): Promise<{
-        type: 'success';
-        message: string;
-    }>;
-    getConnection(): Promise<Connection>;
-    getProfile(options?: {
-        refreshToken: boolean;
-    }): Promise<UserProfile | null>;
-    getFile(url: string, config?: {
-        dataType?: 'base64' | 'download' | 'endpoint' | 'blob' | 'text' | 'info';
-        expires?: number;
-        progress?: ProgressCallback;
-    }): Promise<Blob | string | void | FileInfo>;
-    secureRequest<Params = {
-        url: string;
-        data?: any;
-        sync?: boolean;
-    }, Response = {
-        response: any;
-        statusCode: number;
-        url: string;
-    }>(params: Params[] | Form<Params>, url?: string): Promise<Response | Response[]>;
-    getFormResponse(): Promise<any>;
-    getRecords(query: GetRecordQuery, fetchOptions?: FetchOptions): Promise<DatabaseResponse<RecordData>>;
-    getTables(query: {
-        table: string;
-        condition?: Condition;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Table>>;
-    getIndexes(query: {
-        table: string;
-        index?: string;
-        order?: {
-            by: 'average_number' | 'total_number' | 'number_count' | 'average_bool' | 'total_bool' | 'bool_count' | 'string_count' | 'index_name';
-            value?: number | boolean | string;
-            condition?: Condition;
-        };
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Index>>;
-    getTags(query: {
-        table: string;
-        tag?: string;
-        condition?: Condition;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Tag>>;
-    deleteRecords(params: DelRecordQuery, fetchOptions?: FetchOptions): Promise<string | DatabaseResponse<RecordData>>;
-    resendSignupConfirmation(): Promise<'SUCCESS: Signup confirmation e-mail has been sent.'>;
-    recoverAccount(redirect?: boolean | string): Promise<"SUCCESS: Recovery e-mail has been sent.">;
-    getUsers(params?: {
-        searchFor: 'user_id' | 'email' | 'phone_number' | 'locale' | 'name' | 'address' | 'gender' | 'birthdate' | 'subscribers' | 'timestamp' | 'approved';
-        value: string | number | boolean | string[];
-        condition?: '>' | '>=' | '=' | '<' | '<=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte';
-        range?: string | number | boolean;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<UserPublic>>;
-    disableAccount(): Promise<'SUCCESS: account has been disabled.'>;
-    lastVerifiedEmail(params?: {
-        revert: boolean;
-    }): Promise<string | UserProfile>;
-    unsubscribeNewsletter(params: {
-        group: number | 'public' | 'authorized' | null;
-    }): Promise<string>;
-    adminNewsletterRequest(params: any): Promise<any>;
-    subscribeNotification(endpoint: string, keys: {
-        p256dh: string;
-        auth: string;
-    }): Promise<'SUCCESS: Subscribed to receive notifications.'>;
-    unsubscribeNotification(endpoint: string, keys: {
-        p256dh: string;
-        auth: string;
-    }): Promise<'SUCCESS: Unsubscribed from notifications.'>;
-    vapidPublicKey(): Promise<{
-        VAPIDPublicKey: string;
-    }>;
-    pushNotification(form: {
-        title: string;
-        body: string;
-    }, user_ids?: string | string[]): Promise<"SUCCESS: Notification sent.">;
-    getNewsletters(params?: {
-        searchFor: 'message_id' | 'timestamp' | 'read' | 'complaint' | 'subject';
-        value: string | number;
-        range: string | number;
-        condition?: '>' | '>=' | '=' | '<' | '<=' | 'gt' | 'gte' | 'eq' | 'lt' | 'lte';
-        group: 'public' | 'authorized' | number;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Newsletter>>;
-    getNewsletterSubscription(params: {
-        group?: number | 'public' | 'authorized';
-    }, fetchOptions?: FetchOptions): Promise<{
-        active: boolean;
-        timestamp: number;
-        group: number;
-        subscribed_email: string;
-    }[]>;
-    requestUsernameChange(params: {
-        redirect?: string;
-        username: string;
-    }): Promise<'SUCCESS: confirmation e-mail has been sent.'>;
-    grantPrivateRecordAccess(params: {
-        record_id: string;
-        user_id: string | string[];
-    }): Promise<string>;
-    removePrivateRecordAccess(params: {
-        record_id: string;
-        user_id: string | string[];
-    }): Promise<string>;
-    listPrivateRecordAccess(params: {
-        record_id?: string;
-        user_id?: string | string[];
-    }): Promise<DatabaseResponse<{
-        record_id: string;
-        user_id: string;
-    }>>;
-    requestPrivateRecordAccessKey(params: {
-        record_id: string;
-        reference_id?: string;
-    }): Promise<string>;
-    deleteFiles(params: {
-        endpoints: string | string[];
-    }): Promise<RecordData[]>;
-    uploadFiles(fileList: FormData | HTMLFormElement | SubmitEvent, params: {
-        record_id: string;
-        progress?: ProgressCallback;
-    }): Promise<{
-        completed: File[];
-        failed: File[];
-        bin_endpoints: string[];
-    }>;
-    mock(data: Form<any | {
-        raise: 'ERR_INVALID_REQUEST' | 'ERR_INVALID_PARAMETER' | 'SOMETHING_WENT_WRONG' | 'ERR_EXISTS' | 'ERR_NOT_EXISTS';
-    }>, options?: {
-        auth?: boolean;
-        method?: string;
-        responseType?: 'blob' | 'json' | 'text' | 'arrayBuffer' | 'formData' | 'document';
-        contentType?: string;
-        progress?: ProgressCallback;
-    }): Promise<{
-        [key: string]: any;
-    }>;
-    login(form: Form<{
-        username?: string;
-        email: string;
-        password: string;
-    }>): Promise<UserProfile>;
-    logout(form?: Form<{
-        global: boolean;
-    }>): Promise<'SUCCESS: The user has been logged out.'>;
-    signup(form: Form<{
-        email: String;
-        password: String;
-        username?: string;
-    } & UserAttributes>, option?: {
-        signup_confirmation?: boolean | string;
-        email_subscription?: boolean;
-        login?: boolean;
-    }): Promise<UserProfile | "SUCCESS: The account has been created. User's signup confirmation is required." | 'SUCCESS: The account has been created.'>;
-    resetPassword(form: Form<{
-        email: string;
-        code: string | number;
-        new_password: string;
-    }>): Promise<"SUCCESS: New password has been set.">;
-    verifyEmail(form?: Form<{
-        code: string;
-    }>): Promise<string>;
-    verifyPhoneNumber(form?: Form<{
-        code: string;
-    }>): Promise<string>;
-    forgotPassword(form: Form<{
-        email: string;
-    }>): Promise<"SUCCESS: Verification code has been sent.">;
-    changePassword(params: {
-        new_password: string;
-        current_password: string;
-    }): Promise<'SUCCESS: Password has been changed.'>;
-    updateProfile(form: Form<UserAttributes>): Promise<UserProfile>;
-    postRecord(form: Form<Record<string, any>> | null | undefined, config: PostRecordConfig, files?: {
-        name: string;
-        file: File;
-    }[]): Promise<RecordData>;
-    getSubscriptions(params: {
-        subscriber?: string;
-        subscription?: string;
-        blocked?: boolean;
-    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<Subscription>>;
-    subscribe(params: {
-        user_id: string;
-        get_feed?: boolean;
-        get_notified?: boolean;
-        get_email?: boolean;
-    }): Promise<Subscription>;
-    unsubscribe(params: {
-        user_id: string;
-    }): Promise<'SUCCESS: The user has unsubscribed.'>;
-    blockSubscriber(params: {
-        user_id: string;
-    }): Promise<'SUCCESS: Blocked user ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".'>;
-    unblockSubscriber(params: {
-        user_id: string;
-    }): Promise<'SUCCESS: Unblocked user ID "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".'>;
-    subscribeNewsletter(params: Form<{
-        email?: string;
-        group: number | 'public' | 'authorized' | 'admin';
-        redirect?: string;
-    }>): Promise<string>;
-}
-export {};