@snail-js/api 0.1.27 → 1.0.0

package/dist/strategies/jwtStrategy.d.ts

@@ -1,4 +0,0 @@
-import { Strategy } from "../typings";
-export declare class JwtStrategy implements Strategy {
-    applyRequest(request: any): Promise<any>;
-}

package/dist/typings/api.option.d.ts

@@ -1,10 +0,0 @@
-import { SnailServer } from "../core";
-export interface ApiOptions {
-    name?: string;
-    timeout?: number;
-    version?: string;
-}
-export interface ApiInstanceOptions {
-    serverInstance: SnailServer;
-    enableLog?: boolean;
-}

package/dist/typings/apiProxy.d.ts

@@ -1,8 +0,0 @@
-import { SpecialResponseData, StandardResponseData, ResponseJsonData } from "./response.data";
-import { MethodProxy } from "./snail.method";
-export type StandardResponseWithoutData = Omit<StandardResponseData, "data">;
-export type ApiProxy<T extends object, RT extends StandardResponseWithoutData | ResponseJsonData, DK extends string = "data"> = {
-    [K in keyof T]: T[K] extends (...args: infer A) => any ? <RD = unknown>() => MethodProxy<RD extends SpecialResponseData ? RD : RT & {
-        [KK in DK]: RD;
-    }, A extends any[] ? A : []> : T[K];
-};

package/dist/typings/cache.management.option.d.ts

@@ -1,25 +0,0 @@
-import { AdapterConstructor } from "./cache.type";
-export declare enum CacheType {
-    Memory = 0,
-    IndexDB = 1,
-    LocalStorage = 2,
-    Custom = 3
-}
-export type MemoryCacheOption = {
-    type: CacheType.Memory;
-} & CacheCommonOption;
-export type IndexDBCacheOption = {
-    type: CacheType.IndexDB;
-} & CacheCommonOption;
-export type LocalStorageCacheOption = {
-    type: CacheType.LocalStorage;
-} & CacheCommonOption;
-export type CustomCacheOption = {
-    type: CacheType.Custom;
-    adapter: AdapterConstructor;
-    options?: any;
-} & CacheCommonOption;
-export interface CacheCommonOption {
-    ttl?: number;
-}
-export type CacheManagementOption = MemoryCacheOption | IndexDBCacheOption | LocalStorageCacheOption | CustomCacheOption;

package/dist/typings/cache.type.d.ts

@@ -1,23 +0,0 @@
-import MemoryCache from "../cache/memoryCache";
-import LocalStorageCache from "../cache/localstorageCache";
-import IndexDBCache from "../cache/indexDBCache";
-export interface CacheSetData<T = any> {
-    data: T;
-    exp: number;
-}
-export type CacheGetData<T = any> = {
-    error: null;
-    data: T;
-} | {
-    error: Error | Event;
-    data: null;
-};
-export type CacheStorage = MemoryCache | LocalStorageCache | IndexDBCache | CacheStorageAdapter;
-export declare abstract class CacheStorageAdapter {
-    abstract get<T = any>(key: string): Promise<CacheGetData<T>>;
-    abstract set<T = any>(key: string, value: CacheSetData<T>): Promise<boolean>;
-    abstract delete(key: string): Promise<boolean>;
-    abstract clear(): Promise<boolean>;
-    abstract keys(): Promise<string[]>;
-}
-export type AdapterConstructor = new (options?: any) => CacheStorageAdapter;

package/dist/typings/content.type.d.ts

@@ -1,5 +0,0 @@
-export declare enum ContentType {
-    JSON = "application/json;charset=UTF-8",
-    FORM_URLENCODED = "application/x-www-form-urlencoded;charset=UTF-8",
-    FORM_DATA = "multipart/form-data;charset=UTF-8"
-}

package/dist/typings/request.body.d.ts

@@ -1,3 +0,0 @@
-type JsonBody = Record<string, any>;
-export type RequestBody = JsonBody | string | FormData | Blob | ArrayBuffer | URLSearchParams | ReadableStream;
-export {};

package/dist/typings/response.data.d.ts

@@ -1,13 +0,0 @@
-export interface PaginationData<T> {
-    total: number;
-    page: number;
-    records: T[];
-}
-export type ResponseJsonData = Record<string, any> | object;
-export type SpecialResponseData = string | ArrayBuffer | Blob | FormData;
-export type StandardResponseData<T = any> = {
-    code: number;
-    message: string;
-    data: T;
-};
-export type ResponseData = ResponseJsonData | StandardResponseData | SpecialResponseData;

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

@@ -1,6 +0,0 @@
-import { AxiosResponse } from "axios";
-export type SnailSuccessListener<T = any> = (data?: T) => void;
-export type SnailErrorListener<T = any, ErrorData = any> = (response?: AxiosResponse<T> | Error | ErrorData) => void;
-export type SnailHitCacheListener<T = any> = (cacheData?: T) => void;
-export type SnailFinishListener<T = any> = (data?: T) => void;
-export type SnailEventListener<T = any, ErrorData = any> = SnailSuccessListener<T> | SnailErrorListener<T, ErrorData> | SnailHitCacheListener<T> | SnailFinishListener<T>;

package/dist/typings/snail.method.d.ts

@@ -1,14 +0,0 @@
-import { AxiosRequestConfig, Method, AxiosResponse } from "axios";
-import { ResponseData, ResponseJsonData, SpecialResponseData } from "./response.data";
-import { SnailMethod } from "../core";
-export interface MethodSendOptions {
-    name?: string;
-    adapter?: AxiosRequestConfig["adapter"];
-}
-export interface MethodOption extends MethodSendOptions {
-    method: Method;
-    path: string;
-}
-export interface MethodProxy<RD extends ResponseData = ResponseJsonData, ArgsType extends any[] = []> extends SnailMethod<RD> {
-    send: (...args: ArgsType) => Promise<RD extends SpecialResponseData ? AxiosResponse<RD> : RD>;
-}

package/dist/typings/snail.option.d.ts

@@ -1,16 +0,0 @@
-import { CacheManagementOption } from "./cache.management.option";
-import { Method } from "axios";
-export type CacheForType = "All" | "all" | Method | Method[];
-export declare class SnailServerStatusCodeRuleOptions {
-    key?: string;
-    rule: (status: number) => boolean;
-}
-export interface SnailOption {
-    name?: string;
-    baseURL?: string;
-    cacheManage?: CacheManagementOption;
-    cacheFor?: CacheForType;
-    enableLog?: boolean;
-    timeout?: number;
-    serverStatusCodeRule?: SnailServerStatusCodeRuleOptions;
-}

package/dist/typings/sse.d.ts

@@ -1,15 +0,0 @@
-export type SseProxy<T extends object> = {
-    [K in keyof T]: T[K] extends (...args: infer A) => any ? () => () => {
-        close: () => void;
-        eventSource: EventSource;
-    } : T[K];
-};
-export declare class SseEventListener {
-    eventName: string;
-    emit: (event: any) => any;
-    options: boolean | AddEventListenerOptions;
-}
-export declare class SseOptions {
-    withCredentials?: boolean;
-    version?: string;
-}

package/dist/typings/strategy.d.ts

@@ -1,5 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from "axios";
-export declare class Strategy {
-    applyRequest?(request: AxiosRequestConfig): AxiosRequestConfig | Promise<AxiosRequestConfig>;
-    applyResponse?(response: AxiosResponse): AxiosResponse | Promise<AxiosResponse>;
-}

package/dist/typings/versioning.option.d.ts

@@ -1,30 +0,0 @@
-export declare enum VersioningType {
-    Uri = 0,
-    Header = 1,
-    Query = 2,
-    Custom = 3
-}
-interface VersioningCommonOption {
-    defaultVersion: string;
-}
-export interface VersioningUriOption extends VersioningCommonOption {
-    type: VersioningType.Uri;
-    prefix?: string;
-}
-export interface VersioningHeaderOption extends VersioningCommonOption {
-    type: VersioningType.Header;
-    header?: string;
-}
-export interface VersioningQueryOption extends VersioningCommonOption {
-    type: VersioningType.Query;
-    key?: string;
-}
-export interface VersioningCustomOption extends VersioningCommonOption {
-    type: VersioningType.Custom;
-    extractor: (requestOptions: unknown) => {
-        type: VersioningType;
-        result: string | Record<string, any>;
-    };
-}
-export type VersioningOption = VersioningUriOption | VersioningHeaderOption | VersioningQueryOption | VersioningCustomOption;
-export {};

package/dist/utils/function.d.ts

@@ -1,31 +0,0 @@
-import { AxiosRequestConfig, AxiosResponse } from "axios";
-import { Strategy } from "../typings";
-export declare function generateCacheKey(methodName: string, version: string | undefined, request: AxiosRequestConfig): Promise<string>;
-export declare function generateShortUniqueHash(str: string): Promise<string>;
-export declare function recordToString(record: Record<string, any>): string;
-export declare function replacePlaceholders(route: string, values: {
-    [key: string]: any;
-}): string;
-export declare const resolveUrl: (url?: string) => string;
-export declare function applyStrategies<T extends "request">(data: AxiosRequestConfig, strategies: Array<new () => Strategy>, type: T): Promise<AxiosRequestConfig>;
-export declare function applyStrategies<T extends "response">(data: AxiosResponse, strategies: Array<new () => Strategy>, type: T): Promise<AxiosResponse>;
-/**
- * 一个无用函数，避免tsc报错
- */
-export declare const SnailPass: (...args: any) => void;
-interface IJson {
-    [key: string]: any;
-}
-interface IArgs {
-    params: IJson;
-    data: IJson;
-    querys: IJson;
-}
-export declare const buildRequestArgs: (target: any, propertyKey: string, args: any[]) => IArgs;
-/**
- * 判断响应的数据类型是否为 application/json
- * @param {AxiosResponse} response - Axios 的响应对象
- * @returns {boolean} - 如果响应的数据类型是 application/json 则返回 true，否则返回 false
- */
-export declare function isSpecialResponse(response: AxiosResponse): boolean;
-export {};

package/dist/versioning/index.d.ts

@@ -1 +0,0 @@
-export * from './versioning';

package/dist/versioning/versioning.d.ts

@@ -1,12 +0,0 @@
-import { VersioningType, VersioningOption } from "../typings";
-export interface VersioningResult {
-    type: VersioningType;
-    result: string | Record<string, any>;
-}
-/**
- *
- * @param version 版本号
- * @param serverInstance 当前Server的实例
- * @returns serverInstance上未配置版本管理器返回undefined, 否则返回版本管理器的结果
- */
-export declare function applyVersioning(version: string, versioning: VersioningOption): VersioningResult | undefined;