iboot-http-client 1.2.4 → 1.2.6

package/dist/types/http-client.d.ts

@@ -1,23 +1,6 @@
-import { ClientGetParams, ClientPostParams, CurWebsite, HttpClientOpts, HttpToken, ResultModel, ServerRequestOptions, ICookies, IStorage } from './types/http';
+import { ClientGetParams, ClientPostParams, CurWebsite, ServerHttpOpts, HttpToken, ResultModel, ServerRequestOptions, ICookies, IStorage, ServerHttpOptsMin } from './types/http';
 import { User } from './types/user';
-export declare const DEFAULT_LOCALE = "zh-CN";
-export declare const DEVICE_ID_KEY = "_device_id_key";
-export declare const CURRENT_WEBSITE_KEY = "_current_website_key";
-export declare const COOKIE_NAMES: {
-    IBOOT_DEVICE_ID: string;
-    IBOOT_LANG: string;
-    IBOOT_WEBSITE_ID: string;
-    IBOOT_WEBSITE_NO: string;
-    IBOOT_TOKEN: string;
-    IBOOT_USER: string;
-};
-export declare const HEADER_NAMES: {
-    DEVICE_ID: string;
-    LANG: string;
-    WEBSITE_ID: string;
-    WEBSITE_NO: string;
-};
-export declare const setDefaultRequestHeader: ({ deviceId, website }: Readonly<{
+export declare const setClientRequestHeader: ({ deviceId, website }: Readonly<{
     deviceId: string;
     website?: CurWebsite;
 }>, storage: IStorage) => void;
@@ -26,7 +9,10 @@ export declare const post: <T>(url: string, opts?: ClientPostParams) => Promise<
 export declare const iGet: <T>(url: string, opts?: ClientGetParams) => Promise<T | undefined>;
 export declare const iPost: <T>(url: string, opts?: ClientPostParams) => Promise<T | undefined>;
 export declare const iPostSuccess: (url: string, opts?: ClientPostParams) => Promise<boolean>;
-export declare const getHttpOpts: (storage: IStorage) => HttpClientOpts;
+export declare const getServerHttpOpts: (storage: IStorage) => ServerHttpOptsMin;
+export declare const setServerHttpHeaders: (storage: IStorage, opts: ServerHttpOptsMin) => void;
+export declare const getServerHttpCookies: (cookies: ICookies) => ServerHttpOptsMin;
+export declare const setServerHttpCookies: (cookies: ICookies, opts: ServerHttpOptsMin) => void;
 export declare const getLoginUser: (cookies: ICookies) => User | undefined;
 export declare const getToken: (cookies: ICookies) => HttpToken | undefined;
 export declare const setToken: (data: User & {
@@ -44,7 +30,7 @@ export declare class HttpClient {
     private readonly lang;
     private readonly websiteId?;
     private readonly websiteNo?;
-    constructor(opts: Readonly<HttpClientOpts>);
+    constructor(opts: Readonly<ServerHttpOpts>);
     encrypt(data: string): string;
     decrypt(data: string): string;
     private convertUrlParameter;

package/dist/types/types/http.d.ts

@@ -6,7 +6,10 @@ export type CSRFToken = {
     csrfToken: string;
     csrfHeader: string;
 };
-export type HttpClientOpts = {
+/**
+ * 服务端HttpClient构造函数形参
+ */
+export type ServerHttpOpts = {
     "deviceId"?: string;
     "lang"?: string;
     "websiteId"?: string;
@@ -14,7 +17,11 @@ export type HttpClientOpts = {
     "userType"?: USER_TYPE;
     "helloURL"?: string;
 };
-export type HttpHeaders = {
+export type ServerHttpOptsMin = Omit<ServerHttpOpts, 'userType' | 'helloURL'>;
+/**
+ * 客户端HTTP请求请求头
+ */
+export type ClientHttpHeaders = {
     "Device-Id"?: string;
     "Website-Id"?: string;
     "Website-No"?: string;
@@ -27,11 +34,17 @@ export type HttpToken = {
     xcsrf?: CSRFToken;
 };
 export type ResultStream = ReadableStream<Uint8Array>;
+/**
+ * 当前访问网站形参
+ */
 export type CurWebsite = {
     websiteId?: string;
     websiteNo?: string;
     language: string;
 };
+/**
+ * HTTP请求出参
+ */
 export interface ResultModel<T> {
     code: number;
     success: boolean;
@@ -41,6 +54,9 @@ export interface ResultModel<T> {
     errorCode?: string;
     headers?: Record<string, string>;
 }
+/**
+ * 客户端GET形参
+ */
 export interface ClientGetParams {
     data?: Record<string, string>;
     useCache?: boolean;
@@ -48,6 +64,9 @@ export interface ClientGetParams {
     showError?: (error: string) => void;
     storage?: IStorage;
 }
+/**
+ * 客户端POST形参
+ */
 export interface ClientPostParams {
     data?: Record<string, string> | FormData | UIFormEntities;
     headers?: Record<string, string>;
@@ -55,12 +74,18 @@ export interface ClientPostParams {
     showError?: (error: string) => void;
     showSuccess?: (msg: string) => void;
 }
+/**
+ * 服务端HttpClient GET/POST 请求形参
+ */
 export type ServerRequestOptions = {
     url: string;
     data?: Record<string, any>;
     token?: Readonly<HttpToken>;
     cache?: RequestCache;
 };
+/**
+ * ICookies存，取，删
+ */
 export interface ICookies {
     get?: (key: string) => string | null | undefined;
     set?: (key: string, value: string, opts?: {
@@ -68,6 +93,9 @@ export interface ICookies {
     }) => void;
     delete?: (key: string) => void;
 }
+/**
+ * 存贮器
+ */
 export interface IStorage {
     get?: (key: string) => string | null | undefined;
     set?: (key: string, value: string) => void;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "iboot-http-client",
   "private": false,
-  "version": "1.2.4",
+  "version": "1.2.6",
   "description": "iBoot.xin 相关应用的客户端Http封装",
   "type": "module",
   "main": "./dist/iboot-http-client.cjs.js",