@snail-js/api 0.1.28 → 1.0.0

package/dist/core/snailMethod.d.ts

@@ -1,49 +0,0 @@
-import { AxiosResponse, AxiosRequestConfig } from "axios";
-import { Strategy, ResponseData, StandardResponseData, SnailSuccessListener, SnailErrorListener, SnailHitCacheListener, SnailFinishListener } from "../typings";
-import { SnailApi } from "./snailApi";
-/**
- * SnailMethod
- * 泛型参数: RT => response.data类型,默认标准json返回
- *  DK => response.data.data 类型
- */
-export declare class SnailMethod<RT extends ResponseData = StandardResponseData> {
-    private Name;
-    private apiInstance;
-    private target;
-    private strategies;
-    private Request;
-    private Response;
-    private Error;
-    private EventEmit;
-    private propertyKey;
-    private Url;
-    private Path;
-    private Method;
-    private Adapter;
-    private Version?;
-    constructor(apiInstance: SnailApi, target: Object, propertyKey: string | symbol);
-    send: (...args: any) => Promise<unknown>;
-    private init;
-    private initUrl;
-    private initVersion;
-    private getExpireSources;
-    private createRequest;
-    onSuccess: (listener: SnailSuccessListener<RT>) => void;
-    onError: <ErrorData = any>(listener: SnailErrorListener<RT, ErrorData>) => void;
-    onHitCache: (listener: SnailHitCacheListener<RT>) => void;
-    onFinish: (listener: SnailFinishListener<RT>) => void;
-    private getCacheData;
-    private setCacheData;
-    get response(): AxiosResponse<RT, any>;
-    get request(): AxiosRequestConfig<any>;
-    get version(): string | undefined;
-    get name(): string;
-    get error(): any;
-    registerStrategies: (...strategys: Array<new () => Strategy>) => void;
-    private getStrategies;
-    private getMethodOptions;
-    private isNoCache;
-    private enableLog;
-    private applyHitSource;
-    private applyProgress;
-}

package/dist/core/snailServer.d.ts

@@ -1,35 +0,0 @@
-import "reflect-metadata";
-import { AxiosInstance } from "axios";
-import { Strategy, ApiInstanceOptions, VersioningOption, CacheStorage, ApiProxy, StandardResponseWithoutData, SnailServerStatusCodeRuleOptions, ResponseJsonData } from "../typings";
-import { SnailApi } from "./snailApi";
-import { SnailSse } from "./snailSse";
-export declare const CacheStorageMap: Map<string, CacheStorage>;
-export declare const CacheForMap: Map<string, string[]>;
-export declare const ExpireSourceMap: Map<string, Set<string>>;
-export declare const AxiosInstanceMap: Map<string, AxiosInstance>;
-export declare const StrategyMap: Map<string, (new () => Strategy)[]>;
-export declare const VersioningMap: Map<string, VersioningOption>;
-export declare const ServerStatusCodeRuleMap: Map<string, SnailServerStatusCodeRuleOptions>;
-export declare class SnailServer<RT extends StandardResponseWithoutData | ResponseJsonData = StandardResponseWithoutData, DK extends string = "data"> {
-    private Name;
-    private BaseURL;
-    private Version;
-    private EnableLog;
-    constructor();
-    private init;
-    private initServerStatusCodeRule;
-    private initLog;
-    private initStrategy;
-    private initVersioning;
-    registerStrategies: (...strategys: Array<new () => Strategy>) => void;
-    createApi<TApiClass extends SnailApi>(constructor: new (options: ApiInstanceOptions) => TApiClass): ApiProxy<TApiClass, RT, DK>;
-    private initCacheManage;
-    private initExpireSource;
-    private initAxios;
-    private getServerOptions;
-    createSse<T extends SnailSse>(constructor: new (server: SnailServer) => T): SnailSse;
-    get version(): string;
-    get name(): string;
-    get enableLog(): boolean;
-    get baseUrl(): string;
-}

package/dist/core/snailSse.d.ts

@@ -1,20 +0,0 @@
-import { SnailServer } from "./snailServer";
-export declare class SnailSse {
-    private _serverInstance;
-    private _baseUrl;
-    private _url;
-    private _version?;
-    private _withCredentials;
-    private _eventSource;
-    constructor(server: SnailServer);
-    private getSseOptions;
-    private initVersion;
-    open: () => EventSource;
-    close: () => void;
-    private registerSseEvent;
-    private setEvent;
-    on: (eventName: string, callback: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) => void;
-    off: (eventName: string, callback: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions) => void;
-    get url(): string;
-    get eventSource(): EventSource | null;
-}

package/dist/decorators/cache.d.ts

@@ -1,15 +0,0 @@
-import "reflect-metadata";
-export declare const NO_CACHE_KEY: unique symbol;
-export declare const CACHE_EXPIRE_SOURCE_KEY: unique symbol;
-/**
- * 为请求方法或API设置不启用缓存
- * @returns
- */
-export declare const NoCache: () => (target: any, propertyKey?: string) => void;
-/**
- * 为请求方法或API设置失效源,当此源请求成功时，清空被装饰的方法缓存
- * 格式serverName.apiName.methodName
- * @param sources 失效源，字符型数组；
- * @returns
- */
-export declare const HitSource: (...sources: string[]) => (target: any, propertyKey?: string) => void;

package/dist/decorators/method.d.ts

@@ -1,38 +0,0 @@
-import "reflect-metadata";
-import { MethodSendOptions } from "../typings";
-export declare const METHOD_KEY: unique symbol;
-/**
- * 定义装饰的方法为Get请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Get: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;
-/**
- * 定义装饰的方法为Post请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Post: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;
-/**
- * 定义装饰的方法为Put请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Put: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;
-/**
- * 定义装饰的方法为Delete请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Delete: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;
-/**
- * 定义装饰的方法为Patch请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Patch: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;
-/**
- * 定义装饰的方法为Options请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Options: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;
-/**
- * 定义装饰的方法为Head请求
- * @param path 字符型，请求端点，默认为空
- */
-export declare const Head: (path?: string, options?: MethodSendOptions) => (target: any, propertyKey: string | symbol) => void;

package/dist/decorators/sse.d.ts

@@ -1,30 +0,0 @@
-import "reflect-metadata";
-export declare const EVENT_SOURCE_OPTION_KEY: unique symbol;
-import { SseOptions } from "../typings";
-/**
- * 将装饰的方法创建为SSE连接
- * @param path 路径，要连接到服务端sse端点路径
- * @param options 配置选项
- * @returns 调用被装饰的方法可获得返回{close,eventSource}
- */
-export declare const Sse: (path?: string, options?: SseOptions) => (target: object) => void;
-export declare const EVENT_SOURCE_EVENTS_KEY: unique symbol;
-/**
- * 将装饰的方法注册为eventSource的对应事件
- * @param eventName 事件名称，可选，默认处理message事件
- * @param options boolean | AddEventListenerOptions 可选，注册事件选项
- * @returns
- */
-export declare const SseEvent: (eventName?: string, options?: boolean | AddEventListenerOptions) => (target: any, propertyKey: string) => void;
-export declare const EVENT_SOURCE_OPEN_KEY: unique symbol;
-/**
- * 将装饰的方法注册为eventSource.onOpen
- * @returns
- */
-export declare const OnSseOpen: () => (target: any, propertyKey: string) => void;
-export declare const EVENT_SOURCE_ERROR_KEY: unique symbol;
-/**
- * 将装饰的方法注册eventSource.onError
- * @returns
- */
-export declare const OnSseError: () => (target: any, propertyKey: string) => void;

package/dist/decorators/strategy.d.ts

@@ -1,10 +0,0 @@
-import "reflect-metadata";
-import { Strategy } from "../typings";
-export declare const STRATEGY_KEY: unique symbol;
-/**
- * 策略装饰器，为请求添加请求策略或响应策略
- * @param strategies @type Strategy[]
- * - 传入的策略请使用new 实例化
- * @returns
- */
-export declare const UseStrategy: (...strategies: Array<new () => Strategy>) => (target: any, propertyKey?: string) => void;

package/dist/decorators/versioning.d.ts

@@ -1,16 +0,0 @@
-import "reflect-metadata";
-import { VersioningOption } from "../typings";
-export declare const VERSIONING_KEY: unique symbol;
-export declare const VERSION_KEY: unique symbol;
-/**
- * 版本管理装饰器,为请求设置全局版本管理器
- * @param options 版本管理选项
- * @returns
- */
-export declare const Versioning: (options: VersioningOption) => (target: any) => void;
-/**
- * 为方法设置版本
- * @param version 字符型，临时设置被装饰的请求版本
- * @returns
- */
-export declare const Version: (version: string) => (target: any, propertyKey: string) => void;

package/dist/eventEmmit/index.d.ts

@@ -1 +0,0 @@
-export * from "./snail.event";

package/dist/eventEmmit/snail.event.d.ts

@@ -1,10 +0,0 @@
-import { SnailEventListener } from "../typings";
-export declare class SnailEvent<DT = any> {
-    private eventMap;
-    private onceWrapperMap;
-    constructor();
-    on: <ErrorData = any>(eventName: string, listener: SnailEventListener<DT, ErrorData>) => void;
-    off: (eventName: string, listener: SnailEventListener<DT>) => void;
-    once: (eventName: string, listener: SnailEventListener<DT>) => void;
-    emit: (eventName: string, ...args: any) => boolean;
-}