@yl546/core-api 1.0.0

package/dist/Api.d.ts

@@ -0,0 +1,48 @@
+import EventEmitter from 'eventemitter3';
+import { App, InjectionKey } from 'vue';
+import { ApiEndpointConstructor, ApiEvent, ApiOptions, ApiRequestConfig, AuthAdapter, LoginParams, LoginResponse } from './types';
+import { WebSocketClient, WebSocketEventRawListeners } from './WebSocketClient';
+export type ApiWithEndpoints<Instance extends Api, Endpoints extends ApiEndpoints = any> = Instance & Endpoints;
+export declare interface ApiEndpoints {
+}
+export type InitWebSocketOptions = {
+    override?: boolean;
+    protocols?: string | string[];
+    listeners?: WebSocketEventRawListeners;
+};
+export type ApiInstance = ApiWithEndpoints<Api, ApiEndpoints>;
+declare module 'vue' {
+    interface ComponentCustomProperties {
+        $api: ApiInstance;
+    }
+}
+export declare const API_CONTEXT_KEY: InjectionKey<ApiInstance>;
+export declare const useApi: () => ApiInstance;
+export declare class Api extends EventEmitter<ApiEvent> {
+    static VERSION: string;
+    readonly version: string;
+    readonly options: Readonly<ApiOptions>;
+    readonly auth: AuthAdapter;
+    readonly sockets: Record<string, WebSocketClient>;
+    private _axios;
+    static install: (app: App, options: ApiOptions) => void;
+    private _responseFields;
+    constructor(options: ApiOptions);
+    get host(): string;
+    use(EndPoint: ApiEndpointConstructor | Array<ApiEndpointConstructor>): ThisType<Api>;
+    addEndPoint(name: string, endPoint: any, enumerable?: boolean): ThisType<Api>;
+    /** 登录 */
+    login(params: LoginParams): Promise<LoginResponse>;
+    /** 登出 */
+    logout(): Promise<void>;
+    /** 取消所有请求 */
+    cancelAllRequest(): void;
+    $request<D = any>(config: ApiRequestConfig): Promise<D>;
+    $post<D = any>(url: string, data?: any, config?: Partial<ApiRequestConfig>): Promise<D>;
+    $get<D = any, Q = any>(url: string, query?: Q, config?: Partial<ApiRequestConfig>): Promise<D>;
+    $put<D = any>(url: string, data?: any, config?: Partial<ApiRequestConfig>): Promise<D>;
+    $delete<D = any, Q = any>(url: string, query?: Q, config?: Partial<ApiRequestConfig>): Promise<D>;
+    private _requestInterceptor;
+    private _responseInterceptor;
+    setWebSocket: (name: string, endpoint: string, options_?: InitWebSocketOptions) => Promise<WebSocketClient>;
+}

package/dist/ApiError.d.ts

@@ -0,0 +1,14 @@
+import { AxiosResponse } from "axios";
+import { ApiRequestConfig } from "./types";
+export type ApiErrorOptions<D> = Partial<{
+    data: D;
+    requestConfig: ApiRequestConfig;
+    response: AxiosResponse;
+}>;
+export declare class ApiError<D> extends Error {
+    readonly code: number;
+    readonly requestConfig?: ApiRequestConfig;
+    readonly response?: AxiosResponse;
+    readonly data?: D;
+    constructor(message: string, code: number, options?: ApiErrorOptions<D>);
+}

package/dist/EventSourceClient.d.ts

@@ -0,0 +1,41 @@
+import EventEmitter from 'eventemitter3';
+export declare enum EventSourceEventType {
+    Connected = "connected",
+    Message = "message",
+    RawMessage = "raw-message",
+    Error = "error",
+    Disconnected = "disconnected"
+}
+export type EventSourceEventListener = (...args: any[]) => any;
+export type EventSourceEventValue = `${EventSourceEventType}`;
+export type EventSourceEventRawListeners = Partial<Record<EventSourceEventValue, Array<EventSourceEventListener>>>;
+export type EventSourceClientOptions = {
+    withCredentials?: boolean;
+    reconnectInterval?: number;
+    /** 是否在实例化时自动连接，默认 true */
+    autoConnect?: boolean;
+};
+export declare class EventSourceClient extends EventEmitter<EventSourceEventType> {
+    private _endPoint;
+    private _options;
+    private _rawListeners?;
+    private _source?;
+    private _active;
+    private _reconnectTimer?;
+    constructor(endPoint: string, options?: EventSourceClientOptions, rawListeners?: EventSourceEventRawListeners);
+    /** 手动建立连接（已连接或连接中时跳过） */
+    connect(): void;
+    /** 重新连接 */
+    reconnect(): void;
+    /** 禁用连接 */
+    deactivate(): void;
+    private _connect;
+    private _destroySource;
+    private _clearReconnectTimer;
+    private _scheduleReconnect;
+    private _handleOpen;
+    private _handleMessage;
+    private _handleError;
+    private _bindRawListeners;
+    private _parseMessage;
+}

package/dist/WebSocketClient.d.ts

@@ -0,0 +1,31 @@
+import EventEmitter from 'eventemitter3';
+export declare enum WebSocketEventType {
+    Connected = "connected",// 连接成功
+    Message = "message",// 接受信息,处理之后的信息
+    RawMessage = "raw-message",// 原始信息
+    Error = "error",//错误的时候
+    Disconnected = "disconnected"
+}
+export type WebSocketEventListener = (...args: any[]) => any;
+export type WebSocketEventValue = `${WebSocketEventType}`;
+export type WebSocketEventRawListeners = Partial<Record<WebSocketEventValue, Array<WebSocketEventListener>>>;
+export declare class WebSocketClient extends EventEmitter<WebSocketEventType> {
+    private _endPoint;
+    private _protocols?;
+    private _rawListeners?;
+    private _socket;
+    private _loopAnimationRequestId?;
+    private _loopSocketHeartBeatTimestamp;
+    private _socketHeartBeatInterval;
+    constructor(endPoint: string, protocols?: string | Array<string>, rawListeners?: WebSocketEventRawListeners);
+    reconnect(): void;
+    deactivate(): void;
+    send(val: string): void;
+    private _handleOpen;
+    private _handleMessage;
+    private _handleError;
+    private _handleClose;
+    private _initListeners;
+    private _resolveMessageEvent;
+    private _loop;
+}

package/dist/constants.d.ts

@@ -0,0 +1,14 @@
+/** 认证成功业务码 */
+export declare const AUTHORIZED_CODE = 200;
+/** 认证失败业务码 */
+export declare const UNAUTHORIZED_CODE = 401;
+/** 响应字段默认取值 key */
+export declare const DEFAULT_RESPONSE_FIELDS: {
+    readonly code: "code";
+    readonly msg: "msg";
+    readonly data: "data";
+    readonly items: "items";
+    readonly total: "total";
+    readonly pageNum: "pageNum";
+    readonly pageSize: "pageSize";
+};

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './Api';
+export * from './ApiError';
+export * from './constants';
+export * from './types';
+export * from './utils/formatResponseData';
+export * from './utils/resolveResponseFields';
+export * from './WebSocketClient';
+export * from './EventSourceClient';