@snail-js/api 0.1.14 → 0.1.15

package/dist/core/index.d.ts

@@ -1 +1,4 @@
-export * from './snail';
+export { SnailServer } from "./snailServer";
+export { SnailMethod } from "./snailMethod";
+export { SnailApi } from "./snailApi";
+export { SnailSse } from "./snailSse";

package/dist/core/snailApi.d.ts

@@ -0,0 +1,22 @@
+import { Strategy, ApiInstanceOptions } from "../typings";
+export declare class SnailApi {
+    private Name;
+    private serverInstance;
+    private Version?;
+    private Url?;
+    private Timeout?;
+    private EnableLog?;
+    constructor(options: ApiInstanceOptions);
+    private init;
+    private initStrategy;
+    registerStrategies(...strategys: Array<new () => Strategy>): void;
+    private initName;
+    private getApiConfig;
+    private isNoCache;
+    get version(): string | undefined;
+    get url(): string | undefined;
+    get name(): string;
+    get noCache(): boolean;
+    get enableLog(): boolean | undefined;
+    get timeout(): number | undefined;
+}

package/dist/core/snailMethod.d.ts

@@ -0,0 +1,54 @@
+import { AxiosResponse, AxiosRequestConfig } from "axios";
+import { EventHandler, Strategy, ResponseData, SendRequest, StandardResponseData, ResponseJsonData, SnailMethodEventType } from "../typings";
+import { SnailApi } from "./snailApi";
+/**
+ * SnailMethod
+ * 泛型参数: RT => response.data类型,默认标准json返回
+ *  DK => response.data.data 类型
+ */
+export declare class SnailMethod<RT extends ResponseData = StandardResponseData<ResponseJsonData>> {
+    private Name;
+    private apiInstance;
+    private target;
+    private strategies;
+    private Request;
+    private Response;
+    private Error;
+    private eventMap;
+    private onceWrapperMap;
+    private propertyKey;
+    private Url;
+    private Path;
+    private Method;
+    private Version?;
+    private Args;
+    constructor(apiInstance: SnailApi, target: Object, propertyKey: string | symbol, args?: []);
+    send: SendRequest<RT>;
+    private init;
+    private initUrl;
+    private initVersion;
+    private getExpireSources;
+    private createRequest;
+    onSuccess(handler: EventHandler<RT>): void;
+    onError(handler: EventHandler<RT>): void;
+    onHitCache(handler: EventHandler<RT>): void;
+    onFinish(handler: EventHandler<RT>): void;
+    on(eventName: SnailMethodEventType, handler: EventHandler<RT>): void;
+    once(eventName: SnailMethodEventType, handler: EventHandler<RT>): void;
+    emit(eventName: SnailMethodEventType, ...args: any): boolean;
+    off(eventName: SnailMethodEventType, handler: EventHandler<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

@@ -0,0 +1,34 @@
+import "reflect-metadata";
+import { AxiosInstance } from "axios";
+import { Strategy, ApiInstanceOptions, VersioningOption, CacheStorage, ApiProxy, ResponseData, StandardResponseData, ResponseJsonData, CacheForType } from "../typings";
+import { SnailApi } from "./snailApi";
+import { SnailSse } from "./snailSse";
+export declare const CacheStorageMap: Map<string, CacheStorage>;
+export declare const CacheTtlMap: Map<string, number>;
+export declare const CacheForMap: Map<string, CacheForType>;
+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 class SnailServer<RT extends ResponseData = StandardResponseData<ResponseJsonData>, DK extends string = "data"> {
+    private Name;
+    private BaseURL;
+    private Version;
+    private EnableLog;
+    constructor();
+    private init;
+    private initLog;
+    private initStrategy;
+    private initVersioning;
+    registerStrategies(...strategys: Array<new () => Strategy>): void;
+    createApi<T extends SnailApi>(constructor: new (options: ApiInstanceOptions) => T): ApiProxy<T, 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

@@ -0,0 +1,20 @@
+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(): void;
+    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/api.d.ts

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

package/dist/decorators/{param.d.ts → args.d.ts}

@@ -6,6 +6,12 @@ export declare const REQUEST_ARGS_KEY: unique symbol;
  * @returns
  */
 export declare const Params: (key?: string) => (target: any, propertyKey: string | symbol, parameterIndex: number) => void;
+/**
+ * 将被装饰的参数定义为查询参数
+ * @param key 可选，查询参数的key，未给定key，则被装饰的参数应为对象
+ * @returns
+ */
+export declare const Query: (key?: string) => (target: any, propertyKey: string | symbol, parameterIndex: number) => void;
 /**
  * 将被装饰的参数定义为请求数据
  * @param key 可选，请求data的key，未给定key，则被装饰的参数应为对象

package/dist/decorators/cache.d.ts

@@ -1,10 +1,15 @@
 import "reflect-metadata";
-export declare const CACHE_OPTIONS_KEY: unique symbol;
+export declare const NO_CACHE_KEY: unique symbol;
+export declare const CACHE_EXPIRE_SOURCE_KEY: unique symbol;
 /**
- * 为请求方法设置失效源，或设置不启用缓存
- * @param hitSource 失效源，字符型|null；
- * - 设置为null时，该请求方法不启用缓存；
- * - 设置为字符时，对应该Api下请求方法名称，当设置的名称方法请求成功时，被装饰的请求方法缓存失效
+ * 为请求方法或API设置不启用缓存
  * @returns
  */
-export declare const Cache: (hitSource: string | null) => (target: any, propertyKey?: string) => void;
+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/sse.d.ts

@@ -1,14 +1,13 @@
 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?: {
-    withCredentials: boolean;
-}) => (target: any, propertyKey: string) => void;
+export declare const Sse: (path?: string, options?: SseOptions) => (target: object) => void;
 export declare const EVENT_SOURCE_EVENTS_KEY: unique symbol;
 /**
  * 将装饰的方法注册为eventSource的对应事件

package/dist/decorators/strategy.d.ts

@@ -7,4 +7,4 @@ export declare const STRATEGY_KEY: unique symbol;
  * - 传入的策略请使用new 实例化
  * @returns
  */
-export declare const UseStrategy: (...strategies: Strategy[]) => (target: any, propertyKey?: string) => void;
+export declare const UseStrategy: (...strategies: Array<new () => Strategy>) => (target: any, propertyKey?: string) => void;

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 export * from "./core";
 export { Server } from "./decorators/server";
 export { Api, Get, Put, Post, Patch, Options, Head, Delete, } from "./decorators/api";
-export { Cache } from "./decorators/cache";
-export { Params, Data } from "./decorators/param";
+export { NoCache, HitSource } from "./decorators/cache";
+export { Params, Data, Query } from "./decorators/args";
 export { UseStrategy } from "./decorators/strategy";
 export { Versioning, Version } from "./decorators/versioning";
 export { Sse, SseEvent, OnSseError, OnSseOpen } from "./decorators/sse";