larapi 0.2.44 → 0.2.46

package/dist/index.d.mts

@@ -0,0 +1,258 @@
+import EventEmitter, { EventListener } from 'easy-event-emitter';
+export { EventListener } from 'easy-event-emitter';
+
+type TCacheBody = {
+    data: any;
+    group?: string;
+    time: number;
+};
+type TUser = {
+    id: number;
+    [index: string]: any;
+};
+type TError = {
+    message?: string;
+};
+type TData = Record<string, any>;
+type TGroupsData = {
+    [index: string]: TData;
+};
+type TRequestHeaders = Record<string, string>;
+type TMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'CONNECT' | 'TRACE';
+type TCacheControll = string | {
+    group: string;
+    fieldKey: string;
+};
+type TRequestProgress = {
+    percent: number;
+    total: number;
+    loaded: number;
+};
+type TConfigDataReviver = {
+    [index: string]: (value: any) => any;
+};
+type TConfig = {
+    host: string;
+    reviver?: (this: any, key: string, value: any) => any;
+    tryRequest?: number;
+    tryRequestDelay?: number;
+    dataReviver?: TConfigDataReviver;
+    headers?: TRequestHeaders;
+    clearUndifinedData?: boolean;
+    timeout?: number;
+    globalDataWithoutDataPrepare?: boolean;
+};
+type TResponseData = {
+    success: TData;
+    error?: TError;
+    fail?: TError;
+};
+type TInferRequest<D> = D extends (...args: infer A) => any ? (A extends [infer R, ...any[]] ? R : any) : any;
+type TInferResponse<D> = D extends (...args: any[]) => infer R ? R : D;
+type TParams<P = string | keyof TResponseData['success'], D = TResponseData['success']['?'], M extends TMethod = TMethod, E extends TError = TError, F extends TError = TError> = Partial<TConfig> & {
+    path: P;
+    data?: TInferRequest<D>;
+    /**
+     * FileReader file object.
+     * If present, the file will be sent in chunks.
+    */
+    file?: ArrayBuffer;
+    /**
+     * When uploading a file, get the ID from the server.
+     * You can pass `true` — then the variable will be named `file_id`,
+     * or pass a string like `id_file`, `filename`, etc.
+     */
+    fileIdByServer?: boolean | string;
+    fileSizeChunk?: number;
+    fileType?: 'binary' | 'multipart';
+    /**
+     * default true
+     */
+    requestAsync?: boolean;
+    /**
+     * Receive data as a stream.
+     * On success, the response will contain the object `body?.getReader()`.
+     */
+    stream?: boolean;
+    body?: XMLHttpRequestBodyInit;
+    /**
+     * Enable data caching.
+     * You can pass `true`, or a string key to work with the cache later.
+     */
+    cache?: string | boolean;
+    cacheUpdate?: TCacheControll | TCacheControll[];
+    cacheClear?: TCacheControll | TCacheControll[];
+    forceRequest?: boolean;
+    globalName?: string;
+    queueThrottling?: boolean;
+    success?: (data: TInferResponse<D>, xhr: XMLHttpRequest) => void;
+    error?: (error: E) => void;
+    fail?: (fail: F) => void;
+    complete?: (complete: any) => void;
+    progress?: (progress: TRequestProgress) => void;
+    abort?: (error: E) => void;
+};
+type TListenerEvents = {
+    'api-request-success': any;
+    'api-request-abort': any;
+    'api-request-fail': any;
+    'api-request-error': any;
+    'api-request-complete': any;
+    'api-request-progress': any;
+    'login': {
+        user: any;
+        token: string;
+    };
+    'logout': any;
+    'user-set': any;
+    'user-update': any;
+    'token-update': string;
+    'csrf-token-update': string;
+};
+
+declare abstract class Core {
+    private cache;
+    initData: TGroupsData;
+    protected readonly events: EventEmitter;
+    protected config: TConfig;
+    protected headers: TRequestHeaders;
+    constructor(context?: Core);
+    protected setConfig(config: TConfig): void;
+    protected getConfig(): TConfig;
+    protected getCache(key: string): TData | undefined;
+    protected isJsonString(str: string): boolean;
+    private compileRevivers;
+    private applyObjectRevivers;
+    dataPrepare(data: unknown): any;
+    jsonParse(str: string): any;
+    setHost(host: string): void;
+    setHeader(name: string, value: string): void;
+    getHeader(name: string): string;
+    getHeaders(): {
+        name: string;
+        value: string;
+    }[];
+    hasHeader(name: string): boolean;
+    deleteHeader(name: string): void;
+    protected setCache(key: string, data: TData, group?: string): void;
+    protected groupFromArray<T = string>(groups: T | T[], callback: (group: T, params?: string[]) => void, withoutSplit?: boolean): void;
+    triggerByCacheGroup(groups: string | string[]): void;
+    clearCacheGroup(groups: string | string[], data?: TData, fieldKey?: string | null): void;
+    private setDataTree;
+    updateCacheGroup(groups: string | string[], data: TData, fieldKey?: string | null): void;
+    appendCacheGroup(group: string, data: TData): void;
+    protected getCacheByIndex(index: string): TCacheBody;
+    protected deleteCache(key: string): void;
+    setGlobalInitData(name: string, data: TGroupsData): void;
+    setInitData(data: TGroupsData): void;
+}
+
+declare class Http<D extends TResponseData = TResponseData, PATH = any, DATA = any> extends Core {
+    private cacheIndex;
+    private currentCache?;
+    private currentEvents;
+    private requestParams;
+    private method;
+    private params;
+    private path;
+    private queue;
+    private queueName;
+    private _promise;
+    private xhr?;
+    private tryRequestCount;
+    private tryRequestTimeout?;
+    constructor(method: TMethod, params: TParams<PATH, DATA>, context?: Core);
+    private initRequest;
+    private initCache;
+    get host(): string | undefined;
+    get promise(): Promise<DATA>;
+    get url(): string;
+    private initQueue;
+    private setEmit;
+    handleSuccess(data: any): void;
+    handleAbort(data: any): void;
+    handleFail(data: any): void;
+    handleError(data: any): void;
+    handleComplete(data: any): void;
+    handleProgress(progress: TRequestProgress): void;
+    private encodeUrlParams;
+    private cuteUndifinedParams;
+    private tryHttpRequest;
+    private fileRequest;
+    private httpRequest;
+    private streamRequest;
+    request(force?: boolean): this;
+    abort(): void;
+    addListener<EVENT extends keyof TListenerEvents, DATA extends TListenerEvents[EVENT]>(event: EVENT, callback: (data: DATA) => void): EventListener;
+    updateCache(data: TData, fieldKey?: string | null): void;
+    clearCache(data?: TData, fieldKey?: string | null): void;
+}
+
+/** Laravel API Client */
+declare class API<D extends TResponseData = TResponseData, U extends TUser = TUser, S extends D['success'] = D['success']> extends Core {
+    private static instance;
+    private _user;
+    private token?;
+    private csrfToken?;
+    constructor(config: TConfig);
+    http<DATA extends S[PATH]['?'], PATH extends keyof S = keyof S>(method: TMethod, params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    get<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA, 'GET'>): Http<D, PATH, DATA>;
+    head<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    post<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    put<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    patch<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    delete<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    options<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    connect<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    trace<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    addListener<EVENT extends keyof TListenerEvents, DATA extends TListenerEvents[EVENT]>(event: EVENT, callback: (data: DATA) => void): EventListener;
+    setToken(token: string): void;
+    setCSRFToken(csrfToken: string): void;
+    getConfig(): TConfig;
+    getToken(): string | undefined;
+    getCSRFToken(): string | undefined;
+    getUid(): number;
+    getUser(): U;
+    get uid(): number;
+    get user(): U;
+    get host(): string;
+    setLogin(user: U, token?: string): void;
+    setUser(user: U): void;
+    updateUser(user: U): void;
+    logout(): Promise<void>;
+    static http: <DATA extends any, PATH extends string = string>(method: TMethod, params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static get: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA, "GET">) => Http<TResponseData, PATH, DATA>;
+    static head: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static post: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static put: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static patch: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static delete: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static options: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static connect: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static trace: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static setConfig: (config: TConfig) => void;
+    static setHost: (host: string) => void;
+    static setUser: (user: TUser) => void;
+    static updateUser: (user: TUser) => void;
+    static logout: () => Promise<void>;
+    static setToken: (token: string) => void;
+    static setLogin: (user: TUser, token?: string) => void;
+    static addListener: <EVENT extends keyof TListenerEvents, DATA extends TListenerEvents[EVENT]>(event: EVENT, callback: (data: DATA) => void) => EventListener;
+    static setInitData: (data: TGroupsData) => void;
+    static setCSRFToken: (csrfToken: string) => void;
+    static getCSRFToken: () => string | undefined;
+    static triggerByCacheGroup: (groups: string | string[]) => void;
+    static clearCacheGroup: (groups: string | string[], data?: TData | undefined, fieldKey?: string | null) => void;
+    static updateCacheGroup: (groups: string | string[], data: TData, fieldKey?: string | null) => void;
+    static getToken: () => string | undefined;
+    static getUid: () => number;
+    static getUser: () => TUser;
+    static user: TUser;
+    static uid: number;
+    /**
+     * @deprecated The method should not be used
+     */
+    static deleteCacheGroup: (groups: string | string[], data?: TData | undefined, fieldKey?: string | null) => void;
+}
+
+export { type TResponseData, API as default };

package/dist/index.d.ts

@@ -0,0 +1,258 @@
+import EventEmitter, { EventListener } from 'easy-event-emitter';
+export { EventListener } from 'easy-event-emitter';
+
+type TCacheBody = {
+    data: any;
+    group?: string;
+    time: number;
+};
+type TUser = {
+    id: number;
+    [index: string]: any;
+};
+type TError = {
+    message?: string;
+};
+type TData = Record<string, any>;
+type TGroupsData = {
+    [index: string]: TData;
+};
+type TRequestHeaders = Record<string, string>;
+type TMethod = 'GET' | 'HEAD' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'CONNECT' | 'TRACE';
+type TCacheControll = string | {
+    group: string;
+    fieldKey: string;
+};
+type TRequestProgress = {
+    percent: number;
+    total: number;
+    loaded: number;
+};
+type TConfigDataReviver = {
+    [index: string]: (value: any) => any;
+};
+type TConfig = {
+    host: string;
+    reviver?: (this: any, key: string, value: any) => any;
+    tryRequest?: number;
+    tryRequestDelay?: number;
+    dataReviver?: TConfigDataReviver;
+    headers?: TRequestHeaders;
+    clearUndifinedData?: boolean;
+    timeout?: number;
+    globalDataWithoutDataPrepare?: boolean;
+};
+type TResponseData = {
+    success: TData;
+    error?: TError;
+    fail?: TError;
+};
+type TInferRequest<D> = D extends (...args: infer A) => any ? (A extends [infer R, ...any[]] ? R : any) : any;
+type TInferResponse<D> = D extends (...args: any[]) => infer R ? R : D;
+type TParams<P = string | keyof TResponseData['success'], D = TResponseData['success']['?'], M extends TMethod = TMethod, E extends TError = TError, F extends TError = TError> = Partial<TConfig> & {
+    path: P;
+    data?: TInferRequest<D>;
+    /**
+     * FileReader file object.
+     * If present, the file will be sent in chunks.
+    */
+    file?: ArrayBuffer;
+    /**
+     * When uploading a file, get the ID from the server.
+     * You can pass `true` — then the variable will be named `file_id`,
+     * or pass a string like `id_file`, `filename`, etc.
+     */
+    fileIdByServer?: boolean | string;
+    fileSizeChunk?: number;
+    fileType?: 'binary' | 'multipart';
+    /**
+     * default true
+     */
+    requestAsync?: boolean;
+    /**
+     * Receive data as a stream.
+     * On success, the response will contain the object `body?.getReader()`.
+     */
+    stream?: boolean;
+    body?: XMLHttpRequestBodyInit;
+    /**
+     * Enable data caching.
+     * You can pass `true`, or a string key to work with the cache later.
+     */
+    cache?: string | boolean;
+    cacheUpdate?: TCacheControll | TCacheControll[];
+    cacheClear?: TCacheControll | TCacheControll[];
+    forceRequest?: boolean;
+    globalName?: string;
+    queueThrottling?: boolean;
+    success?: (data: TInferResponse<D>, xhr: XMLHttpRequest) => void;
+    error?: (error: E) => void;
+    fail?: (fail: F) => void;
+    complete?: (complete: any) => void;
+    progress?: (progress: TRequestProgress) => void;
+    abort?: (error: E) => void;
+};
+type TListenerEvents = {
+    'api-request-success': any;
+    'api-request-abort': any;
+    'api-request-fail': any;
+    'api-request-error': any;
+    'api-request-complete': any;
+    'api-request-progress': any;
+    'login': {
+        user: any;
+        token: string;
+    };
+    'logout': any;
+    'user-set': any;
+    'user-update': any;
+    'token-update': string;
+    'csrf-token-update': string;
+};
+
+declare abstract class Core {
+    private cache;
+    initData: TGroupsData;
+    protected readonly events: EventEmitter;
+    protected config: TConfig;
+    protected headers: TRequestHeaders;
+    constructor(context?: Core);
+    protected setConfig(config: TConfig): void;
+    protected getConfig(): TConfig;
+    protected getCache(key: string): TData | undefined;
+    protected isJsonString(str: string): boolean;
+    private compileRevivers;
+    private applyObjectRevivers;
+    dataPrepare(data: unknown): any;
+    jsonParse(str: string): any;
+    setHost(host: string): void;
+    setHeader(name: string, value: string): void;
+    getHeader(name: string): string;
+    getHeaders(): {
+        name: string;
+        value: string;
+    }[];
+    hasHeader(name: string): boolean;
+    deleteHeader(name: string): void;
+    protected setCache(key: string, data: TData, group?: string): void;
+    protected groupFromArray<T = string>(groups: T | T[], callback: (group: T, params?: string[]) => void, withoutSplit?: boolean): void;
+    triggerByCacheGroup(groups: string | string[]): void;
+    clearCacheGroup(groups: string | string[], data?: TData, fieldKey?: string | null): void;
+    private setDataTree;
+    updateCacheGroup(groups: string | string[], data: TData, fieldKey?: string | null): void;
+    appendCacheGroup(group: string, data: TData): void;
+    protected getCacheByIndex(index: string): TCacheBody;
+    protected deleteCache(key: string): void;
+    setGlobalInitData(name: string, data: TGroupsData): void;
+    setInitData(data: TGroupsData): void;
+}
+
+declare class Http<D extends TResponseData = TResponseData, PATH = any, DATA = any> extends Core {
+    private cacheIndex;
+    private currentCache?;
+    private currentEvents;
+    private requestParams;
+    private method;
+    private params;
+    private path;
+    private queue;
+    private queueName;
+    private _promise;
+    private xhr?;
+    private tryRequestCount;
+    private tryRequestTimeout?;
+    constructor(method: TMethod, params: TParams<PATH, DATA>, context?: Core);
+    private initRequest;
+    private initCache;
+    get host(): string | undefined;
+    get promise(): Promise<DATA>;
+    get url(): string;
+    private initQueue;
+    private setEmit;
+    handleSuccess(data: any): void;
+    handleAbort(data: any): void;
+    handleFail(data: any): void;
+    handleError(data: any): void;
+    handleComplete(data: any): void;
+    handleProgress(progress: TRequestProgress): void;
+    private encodeUrlParams;
+    private cuteUndifinedParams;
+    private tryHttpRequest;
+    private fileRequest;
+    private httpRequest;
+    private streamRequest;
+    request(force?: boolean): this;
+    abort(): void;
+    addListener<EVENT extends keyof TListenerEvents, DATA extends TListenerEvents[EVENT]>(event: EVENT, callback: (data: DATA) => void): EventListener;
+    updateCache(data: TData, fieldKey?: string | null): void;
+    clearCache(data?: TData, fieldKey?: string | null): void;
+}
+
+/** Laravel API Client */
+declare class API<D extends TResponseData = TResponseData, U extends TUser = TUser, S extends D['success'] = D['success']> extends Core {
+    private static instance;
+    private _user;
+    private token?;
+    private csrfToken?;
+    constructor(config: TConfig);
+    http<DATA extends S[PATH]['?'], PATH extends keyof S = keyof S>(method: TMethod, params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    get<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA, 'GET'>): Http<D, PATH, DATA>;
+    head<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    post<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    put<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    patch<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    delete<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    options<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    connect<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    trace<DATA extends S[PATH]['?'] = any, PATH extends keyof S = keyof S>(params: TParams<PATH, DATA>): Http<D, PATH, DATA>;
+    addListener<EVENT extends keyof TListenerEvents, DATA extends TListenerEvents[EVENT]>(event: EVENT, callback: (data: DATA) => void): EventListener;
+    setToken(token: string): void;
+    setCSRFToken(csrfToken: string): void;
+    getConfig(): TConfig;
+    getToken(): string | undefined;
+    getCSRFToken(): string | undefined;
+    getUid(): number;
+    getUser(): U;
+    get uid(): number;
+    get user(): U;
+    get host(): string;
+    setLogin(user: U, token?: string): void;
+    setUser(user: U): void;
+    updateUser(user: U): void;
+    logout(): Promise<void>;
+    static http: <DATA extends any, PATH extends string = string>(method: TMethod, params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static get: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA, "GET">) => Http<TResponseData, PATH, DATA>;
+    static head: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static post: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static put: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static patch: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static delete: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static options: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static connect: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static trace: <DATA extends any = any, PATH extends string = string>(params: TParams<PATH, DATA>) => Http<TResponseData, PATH, DATA>;
+    static setConfig: (config: TConfig) => void;
+    static setHost: (host: string) => void;
+    static setUser: (user: TUser) => void;
+    static updateUser: (user: TUser) => void;
+    static logout: () => Promise<void>;
+    static setToken: (token: string) => void;
+    static setLogin: (user: TUser, token?: string) => void;
+    static addListener: <EVENT extends keyof TListenerEvents, DATA extends TListenerEvents[EVENT]>(event: EVENT, callback: (data: DATA) => void) => EventListener;
+    static setInitData: (data: TGroupsData) => void;
+    static setCSRFToken: (csrfToken: string) => void;
+    static getCSRFToken: () => string | undefined;
+    static triggerByCacheGroup: (groups: string | string[]) => void;
+    static clearCacheGroup: (groups: string | string[], data?: TData | undefined, fieldKey?: string | null) => void;
+    static updateCacheGroup: (groups: string | string[], data: TData, fieldKey?: string | null) => void;
+    static getToken: () => string | undefined;
+    static getUid: () => number;
+    static getUser: () => TUser;
+    static user: TUser;
+    static uid: number;
+    /**
+     * @deprecated The method should not be used
+     */
+    static deleteCacheGroup: (groups: string | string[], data?: TData | undefined, fieldKey?: string | null) => void;
+}
+
+export { type TResponseData, API as default };