@snail-js/api 0.1.0 → 0.1.2

package/dist/strategies/jwtStrategy.d.ts

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

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

@@ -1,28 +1,9 @@
-import { RequestBody } from "./request.body";
-import { Api } from "../core/api";
-import { ResponseErrorData, ResponseSuccessData, PaginationData } from "./response.data";
-export interface PipeResult {
-    data: RequestBody | undefined;
-    headers: Record<string, string>;
-}
-export type RequestPipe = (data: RequestBody | undefined, headers: Record<string, string>) => PipeResult;
-export interface ApiConfig<R = any> {
-    name?: string;
+import { RequestMethod } from "./request.method";
+export interface ApiConfig {
     timeout?: number;
     version?: string;
-    transform?: (data: R | PaginationData<R>) => R | PaginationData<R>;
-    headers?: Record<string, string>;
-    params?: Record<string, string>;
-    hitSource?: string | Api;
-}
-export interface SendOptions {
-    params?: Record<string, string>;
-    data?: RequestBody;
-    version?: string;
 }
-export interface ApiResponse<T, E> {
-    error: ResponseErrorData<E> | null;
-    data: ResponseSuccessData<T> | null;
-    hitCache: boolean;
-    Catch: (error: any) => any;
+export interface MethodOption {
+    method: RequestMethod;
+    path: string;
 }

package/dist/typings/apiProxy.d.ts

@@ -0,0 +1,11 @@
+export type ApiResponse<T> = Promise<{
+    data: T | null;
+    error: Error | null;
+}>;
+export type ApiProxy<T, R extends {
+    data: any;
+}> = {
+    [K in keyof T]: T[K] extends (...args: infer A) => any ? <D = any, E = any>(...args: A) => ApiResponse<R & {
+        data: D;
+    }> : T[K];
+};

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

@@ -0,0 +1,19 @@
+export declare enum CacheType {
+    Memory = 0,
+    IndexDB = 1,
+    LocalStorage = 2
+}
+interface MemoryCacheOption {
+    type: CacheType.Memory;
+}
+interface IndexDBCacheOption {
+    type: CacheType.IndexDB;
+}
+interface LocalStorageCacheOption {
+    type: CacheType.LocalStorage;
+}
+interface CacheCommonOption {
+    ttl?: number;
+}
+export type CacheManagementOption = CacheCommonOption & (MemoryCacheOption | IndexDBCacheOption | LocalStorageCacheOption);
+export {};

package/dist/typings/index.d.ts

@@ -1,8 +1,10 @@
 export * from "./request.body";
 export * from "./request.method";
-export * from "./snail.config";
+export * from "./snail.option";
 export * from "./api.config";
-export * from "./versioning.config";
-export * from "./cache.management.config";
+export * from "./versioning.option";
+export * from "./cache.management.option";
 export * from "./cache.type";
 export * from "./response.data";
+export * from "./strategy";
+export * from "./apiProxy";

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

@@ -1,4 +1,4 @@
-export interface ResponseErrorData<E = any> {
+export interface ResponseErrorData<E> {
     code: number;
     message: string;
     data: E;
@@ -9,9 +9,9 @@ export interface PaginationData<T> {
     size: number;
     record: T[];
 }
-export interface ResponseSuccessData<T = any> {
+export interface ResponseSuccessData<T> {
     code: 0;
     message: string;
     data: T | PaginationData<T>;
 }
-export type ResponseData<T, E> = ResponseSuccessData<T> | ResponseErrorData<E>;
+export type ResponseData<T = any, E = any> = ResponseSuccessData<T> | ResponseErrorData<E>;

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

@@ -0,0 +1,9 @@
+import { CacheManagementOption } from "./cache.management.option";
+import { VersioningOption } from "./versioning.option";
+export interface SnailOption {
+    baseURL?: string;
+    Versioning?: VersioningOption;
+    CacheManage?: CacheManagementOption;
+    enableLog?: boolean;
+    timeout?: number;
+}

package/dist/typings/strategy.d.ts

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1,30 @@
+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) => {
+        url: string;
+        headers: Record<string, any>;
+    };
+}
+export type VersioningOption = VersioningUriOption | VersioningHeaderOption | VersioningQueryOption | VersioningCustomOption;
+export {};

package/dist/utils/function.d.ts

@@ -7,5 +7,3 @@ export declare const apiKey: <T extends {
     headers?: Record<string, any>;
 }>(apiInstance: T) => string;
 export declare function recordToString(record: Record<string, any>): string;
-export declare function getResponseDataFromCache(cacheKey: string): string;
-export declare function deepCopy<T>(obj: T): T;

package/dist/versioning/versioning.d.ts

@@ -1,7 +1,8 @@
-import { VersioningConfig } from "../typings";
+import { VersioningOption } from "../typings";
 interface VersioningResult {
     url?: string;
     headers?: Record<string, any>;
+    params?: Record<string, any>;
 }
-export declare function applyVersioning(version: string, versioning: VersioningConfig): VersioningResult;
+export declare function applyVersioning(version: string, versioning: VersioningOption): VersioningResult;
 export {};

package/package.json

@@ -1,21 +1,28 @@
 {
   "name": "@snail-js/api",
-  "version": "0.1.0",
-  "description": "",
-  "main": "index.ts",
+  "version": "0.1.2",
+  "description": "Http Request with Decorators Api, build on axios",
+  "type": "module",
+  "main": "./src/index.ts",
   "exports": {
     ".": {
-      "import": "./dist/snail-api.js",
+      "import": "./dist/snail-api.mjs",
       "require": "./dist/snail-api.umd.cjs",
       "types": "./dist/index.d.ts"
     }
   },
   "scripts": {
     "clean:dist": "rimraf ./dist",
-    "build": "pnpm run clean:dist && vite build",
+    "build": "pnpm run clean:dist && vite build && pnpm run build:type",
+    "build:type": "vue-tsc -p tsconfig.build.json --composite false --declaration --emitDeclarationOnly",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "keywords": [],
+  "keywords": [
+    "Decorators",
+    "api",
+    "Request",
+    "axios"
+  ],
   "author": "",
   "license": "MIT",
   "peerDependencies": {
@@ -24,5 +31,8 @@
   "files": [
     "README.md",
     "dist"
-  ]
+  ],
+  "dependencies": {
+    "reflect-metadata": "^0.2.2"
+  }
 }

package/dist/core/api.d.ts

@@ -1,40 +0,0 @@
-import { RequestBody, RequestMethod, ApiConfig, SendOptions, ApiResponse, RequestPipe } from "../typings";
-import { Snail } from "./snail";
-/**
- * 泛型 R response success 时 返回的data类型
- * 泛型 E error 时 返回的error类型
- * 泛型 D error 时 返回error携带的data类型
- */
-export declare class Api<R = any, E = any, D = any> {
-    baseURL: string;
-    url: string;
-    data?: RequestBody;
-    params?: Record<string, any>;
-    headers?: Record<string, any>;
-    private key;
-    method: RequestMethod;
-    private hitCache;
-    context: Snail;
-    version?: string;
-    private versioning?;
-    private name?;
-    private hitSource?;
-    private timeout;
-    private transform?;
-    private pipes;
-    constructor(method: RequestMethod, url: string, context?: any, config?: ApiConfig<R>);
-    private handleVersioning;
-    /**
-     *
-     * @param options 发送配置：子项params,data
-     * 泛型<R = any, E = any>R返回数据类型, E返回错误类型(code!=0)
-     * @returns
-     */
-    send(options?: SendOptions): Promise<ApiResponse<R, E>>;
-    private checkCache;
-    delCache(version?: string): Promise<void>;
-    use(pipe: RequestPipe): void;
-    private processRequestPipes;
-    private sendRequest;
-    private lapsed;
-}

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

@@ -1,19 +0,0 @@
-export declare enum CacheType {
-    Memory = 0,
-    IndexDB = 1,
-    LocalStorage = 2
-}
-interface MemoryCacheConfig {
-    type: CacheType.Memory;
-}
-interface IndexDBCacheConfig {
-    type: CacheType.IndexDB;
-}
-interface LocalStorageCacheConfig {
-    type: CacheType.LocalStorage;
-}
-interface CacheCommonConfig {
-    ttl?: number;
-}
-export type CacheManagementConfig = CacheCommonConfig & (MemoryCacheConfig | IndexDBCacheConfig | LocalStorageCacheConfig);
-export {};

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

@@ -1,21 +0,0 @@
-import { AxiosInterceptorOptions, AxiosResponse, InternalAxiosRequestConfig } from "axios";
-import { CacheManagementConfig } from "./cache.management.config";
-import { VersioningConfig } from "./versioning.config";
-export type AxiosRequestInterceptor<T = any> = {
-    onFulfilled?: ((value: InternalAxiosRequestConfig<T>) => InternalAxiosRequestConfig<T> | Promise<InternalAxiosRequestConfig<T>>) | null;
-    onRejected?: ((error: any) => any) | null;
-    options?: AxiosInterceptorOptions;
-};
-export type AxiosResponseInterceptor<T = any> = {
-    onFulfilled?: ((response: AxiosResponse<T>) => AxiosResponse<T> | Promise<AxiosResponse<T>>) | null;
-    onRejected?: ((error: any) => any) | null;
-};
-export interface SnailConfig {
-    baseURL?: string;
-    Versioning?: VersioningConfig;
-    CacheManage?: CacheManagementConfig;
-    enableLog?: boolean;
-    timeout?: number;
-    requestInterceptors?: AxiosRequestInterceptor;
-    responseInterceptors?: AxiosResponseInterceptor;
-}

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

@@ -1,30 +0,0 @@
-export declare enum VersioningType {
-    Uri = 0,
-    Header = 1,
-    Query = 2,
-    Custom = 3
-}
-interface VersioningCommonConfig {
-    defaultVersion: string;
-}
-export interface VersioningUriConfig extends VersioningCommonConfig {
-    type: VersioningType.Uri;
-    prefix?: string;
-}
-export interface VersioningHeaderConfig extends VersioningCommonConfig {
-    type: VersioningType.Header;
-    header: string;
-}
-export interface VersioningQueryConfig extends VersioningCommonConfig {
-    type: VersioningType.Query;
-    key?: string;
-}
-export interface VersioningCustomConfig extends VersioningCommonConfig {
-    type: VersioningType.Custom;
-    extractor: (requestOptions: unknown) => {
-        url: string;
-        headers: Record<string, any>;
-    };
-}
-export type VersioningConfig = VersioningUriConfig | VersioningHeaderConfig | VersioningQueryConfig | VersioningCustomConfig;
-export {};