@snail-js/api 0.1.0

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

@@ -0,0 +1,28 @@
+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;
+    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;
+}

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

@@ -0,0 +1,19 @@
+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/cache.type.d.ts

@@ -0,0 +1,8 @@
+import MemoryCache from "../cache/memoryCache";
+import LocalStorageCache from "../cache/localstorageCache";
+import IndexDBCache from "../cache/indexDBCache";
+export interface CacheData<T = any> {
+    data: T;
+    exp: number;
+}
+export type CacheStorage = MemoryCache | LocalStorageCache | IndexDBCache;

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

@@ -0,0 +1,5 @@
+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/index.d.ts

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

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

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

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

@@ -0,0 +1,9 @@
+export declare enum RequestMethod {
+    GET = "GET",
+    HEAD = "HEAD",
+    POST = "POST",
+    PUT = "PUT",
+    DELETE = "DELETE",
+    PATCH = "PATCH",
+    OPTIONS = "OPTIONS"
+}

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

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

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

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

@@ -0,0 +1,30 @@
+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 {};

package/dist/utils/function.d.ts

@@ -0,0 +1,11 @@
+export declare const apiKey: <T extends {
+    url: string;
+    method: string;
+    data?: any;
+    version?: string;
+    params?: Record<string, any>;
+    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/utils/index.d.ts

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

package/dist/versioning/versioning.d.ts

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

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@snail-js/api",
+  "version": "0.1.0",
+  "description": "",
+  "main": "index.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/snail-api.js",
+      "require": "./dist/snail-api.umd.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "clean:dist": "rimraf ./dist",
+    "build": "pnpm run clean:dist && vite build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "peerDependencies": {
+    "axios": "^1.7.9"
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ]
+}