iboot-http-client 1.0.0 → 1.0.2

package/dist/types/{HttpClient.d.ts → http-client.d.ts}

@@ -1,14 +1,17 @@
-export declare const defaultLocale = "zh-CN";
-export declare const setDefaultRequestHeader: (deviceId: string, website: CurWebsite) => void;
+import { ClientGetParams, ClientPostParams, CurWebsite, HttpClientOpts, HttpToken, IbootCookieStore, IbootReadonlyCookies, IbootWritableCookie, ResultModel } 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 setDefaultRequestHeader: (deviceId: string, website?: CurWebsite) => void;
 export declare const get: <T>(url: string, opts?: ClientGetParams) => Promise<ResultModel<T>>;
 export declare const iGet: <T>(url: string, opts?: ClientGetParams) => Promise<T | undefined>;
 export declare const post: <T>(url: string, opts?: ClientPostParams) => Promise<ResultModel<T>>;
 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 getHttpClientOpts: (request: Request) => HttpOpts;
-export declare const getHttpOptsByHeaders: (cookie: IbootReadonlyCookies) => HttpOpts;
-export declare const getHttpClientOptsByCookie: (cookie: IbootReadonlyCookies) => HttpOpts;
-export declare class HttpClient {
+export declare const getHttpClientOpts: (request: Request) => HttpClientOpts;
+export declare const getHttpClientOptsByCookie: (cookie: IbootReadonlyCookies) => HttpClientOpts;
+export default class HttpClient {
     private readonly baseUrl;
     private readonly apiKey;
     private readonly userType;
@@ -19,7 +22,8 @@ export declare class HttpClient {
     private readonly websiteId?;
     private readonly websiteNo?;
     private readonly _isDebug;
-    constructor({ deviceId, lang, webId, webNo, userType }: Readonly<HttpOpts>);
+    private readonly logger;
+    constructor({ deviceId, lang, websiteId, websiteNo, userType }: Readonly<HttpClientOpts>);
     isDebug(): boolean;
     encrypt(data: string): string;
     decrypt(data: string): string;

package/dist/types/index.d.ts

@@ -1,432 +1,3 @@
-declare type UIFormEntities<T = any> =  { [k: string]: T; }
-declare const ACCOUNT_TYPE: {
-    GENERAL : 0,
-    PHONE : 1,
-    EMAIL : 2
-}
-
-declare const USER_TYPE: {
-    TYPE_MGT : 0,
-    TYPE_C : 1,
-    TYPE_B : 2
-};
-
-declare const USER_FORM: {
-    FROM_WEB : 1,
-    FROM_PC : 2,
-    FROM_WX_MINI_PRO : 3,
-    FROM_WX_PLU : 4,
-    FROM_WX_E : 5,
-    FROM_APP : 6,
-    FROM_DEVICE : 7
-}
-
-declare const USER_SEX: {
-    unknown:0,
-    male:1,
-    female:2,
-}
-
-declare type ACCOUNT_TYPE = typeof ACCOUNT_TYPE[keyof typeof ACCOUNT_TYPE];
-declare type USER_TYPE = typeof USER_TYPE[keyof typeof USER_TYPE];
-declare type USER_FORM = typeof USER_FORM[keyof typeof USER_FORM];
-declare type USER_SEX = typeof USER_SEX[keyof typeof USER_SEX];
-
-
-declare interface User {
-    id: string,
-    status: 0 | 1
-    name: string,
-    sex: USER_SEX,
-    username: string,
-    phone?: string,
-    email?: string,
-    accountType: ACCOUNT_TYPE,
-    birthday?: string,
-    headImg?: string,
-    nickname?: string,
-    motto?: string,
-    enabled: boolean,
-    userType: USER_TYPE,
-    userFrom: USER_FORM,
-    needToReview: boolean,
-    socketOnline: boolean,
-    unionId?: string,
-    openId?: string,
-    wxPid?: string,
-    createTime: string,
-    lastLoginTime?: string,
-    lastLogoutTime?: string,
-    latitude?: number,
-    longitude?: number,
-    deviceId?: string,
-    tokenExpired?:number,
-    mustChangePwd?:boolean
-}
-
-declare type CurWebsite = {
-    websiteId?:string,
-    websiteNo?:string,
-    language:string,
-}
-
-declare type CSRFToken = {
-    csrfToken: string,
-    csrfHeader: string,
-}
-
-declare interface Cookie {
-    name: string;
-    value: string;
-    path?: string;
-    httpOnly?: boolean;
-    secure?: boolean;
-    maxAge?: number;
-    expires?: Date;
-    sameSite?: boolean | 'lax' | 'strict' | 'none';
-    domain?: string;
-}
-
-declare interface IbootReadonlyCookies {
-    get(name: string): Cookie | undefined;
-    getAll(): Cookie[];
-    has(name: string): boolean;
-    [Symbol.iterator](): IterableIterator<Cookie>;
-}
-
-declare interface IbootWritableCookie {
-    set(name: string, value: string, options?: Partial<Cookie>): void;
-    delete(name: string, options?: { path?: string; domain?: string }): void;
-}
-
-declare interface IbootCookieStore {
-    get(name: string): Cookie | undefined;
-    getAll(): Cookie[];
-    has(name: string): boolean;
-    set(name: string, value: string, options?: Partial<Cookie>): void;
-    delete(name: string, options?: { path?: string; domain?: string }): void;
-    [Symbol.iterator](): IterableIterator<Cookie>;
-}
-
-declare type HttpOpts = {
-    "deviceId"?: string,
-    "lang"?: string,
-    "webId"?: string,
-    "webNo"?: string,
-    "userType"?: USER_TYPE
-}
-
-declare type HttpToken = { username: string, token: string, utype: USER_TYPE, xcsrf?: CSRFToken };
-
-declare interface ResultModel<T> {
-    code: number,
-    success: boolean,
-    msg?: string,
-    data?: T,
-    host?: string,
-    errorCode?: string
-}
-
-declare type ResultStream = ReadableStream<Uint8Array>
-
-declare interface ClientGetParams {
-    data?: Record<string, string>,
-    useCache?: boolean,
-    heads?: Record<string, string>,
-    showError?: (error: string) => void
-}
-
-declare interface ClientPostParams {
-    data?: Record<string, string> | FormData | UIFormEntities,
-    heads?: Record<string, string>,
-    showError?: (error: string) => void,
-    showSuccess?:(msg:string)=>void
-}
-declare type UIFormEntities<T = any> =  { [k: string]: T; }
-declare const ACCOUNT_TYPE: {
-    GENERAL : 0,
-    PHONE : 1,
-    EMAIL : 2
-}
-
-declare const USER_TYPE: {
-    TYPE_MGT : 0,
-    TYPE_C : 1,
-    TYPE_B : 2
-};
-
-declare const USER_FORM: {
-    FROM_WEB : 1,
-    FROM_PC : 2,
-    FROM_WX_MINI_PRO : 3,
-    FROM_WX_PLU : 4,
-    FROM_WX_E : 5,
-    FROM_APP : 6,
-    FROM_DEVICE : 7
-}
-
-declare const USER_SEX: {
-    unknown:0,
-    male:1,
-    female:2,
-}
-
-declare type ACCOUNT_TYPE = typeof ACCOUNT_TYPE[keyof typeof ACCOUNT_TYPE];
-declare type USER_TYPE = typeof USER_TYPE[keyof typeof USER_TYPE];
-declare type USER_FORM = typeof USER_FORM[keyof typeof USER_FORM];
-declare type USER_SEX = typeof USER_SEX[keyof typeof USER_SEX];
-
-
-declare interface User {
-    id: string,
-    status: 0 | 1
-    name: string,
-    sex: USER_SEX,
-    username: string,
-    phone?: string,
-    email?: string,
-    accountType: ACCOUNT_TYPE,
-    birthday?: string,
-    headImg?: string,
-    nickname?: string,
-    motto?: string,
-    enabled: boolean,
-    userType: USER_TYPE,
-    userFrom: USER_FORM,
-    needToReview: boolean,
-    socketOnline: boolean,
-    unionId?: string,
-    openId?: string,
-    wxPid?: string,
-    createTime: string,
-    lastLoginTime?: string,
-    lastLogoutTime?: string,
-    latitude?: number,
-    longitude?: number,
-    deviceId?: string,
-    tokenExpired?:number,
-    mustChangePwd?:boolean
-}
-
-declare type CurWebsite = {
-    websiteId?:string,
-    websiteNo?:string,
-    language:string,
-}
-
-declare type CSRFToken = {
-    csrfToken: string,
-    csrfHeader: string,
-}
-
-declare interface Cookie {
-    name: string;
-    value: string;
-    path?: string;
-    httpOnly?: boolean;
-    secure?: boolean;
-    maxAge?: number;
-    expires?: Date;
-    sameSite?: boolean | 'lax' | 'strict' | 'none';
-    domain?: string;
-}
-
-declare interface IbootReadonlyCookies {
-    get(name: string): Cookie | undefined;
-    getAll(): Cookie[];
-    has(name: string): boolean;
-    [Symbol.iterator](): IterableIterator<Cookie>;
-}
-
-declare interface IbootWritableCookie {
-    set(name: string, value: string, options?: Partial<Cookie>): void;
-    delete(name: string, options?: { path?: string; domain?: string }): void;
-}
-
-declare interface IbootCookieStore {
-    get(name: string): Cookie | undefined;
-    getAll(): Cookie[];
-    has(name: string): boolean;
-    set(name: string, value: string, options?: Partial<Cookie>): void;
-    delete(name: string, options?: { path?: string; domain?: string }): void;
-    [Symbol.iterator](): IterableIterator<Cookie>;
-}
-
-declare type HttpOpts = {
-    "deviceId"?: string,
-    "lang"?: string,
-    "webId"?: string,
-    "webNo"?: string,
-    "userType"?: USER_TYPE
-}
-
-declare type HttpToken = { username: string, token: string, utype: USER_TYPE, xcsrf?: CSRFToken };
-
-declare interface ResultModel<T> {
-    code: number,
-    success: boolean,
-    msg?: string,
-    data?: T,
-    host?: string,
-    errorCode?: string
-}
-
-declare type ResultStream = ReadableStream<Uint8Array>
-
-declare interface ClientGetParams {
-    data?: Record<string, string>,
-    useCache?: boolean,
-    heads?: Record<string, string>,
-    showError?: (error: string) => void
-}
-
-declare interface ClientPostParams {
-    data?: Record<string, string> | FormData | UIFormEntities,
-    heads?: Record<string, string>,
-    showError?: (error: string) => void,
-    showSuccess?:(msg:string)=>void
-}
-declare type UIFormEntities<T = any> =  { [k: string]: T; }
-declare const ACCOUNT_TYPE: {
-    GENERAL : 0,
-    PHONE : 1,
-    EMAIL : 2
-}
-
-declare const USER_TYPE: {
-    TYPE_MGT : 0,
-    TYPE_C : 1,
-    TYPE_B : 2
-};
-
-declare const USER_FORM: {
-    FROM_WEB : 1,
-    FROM_PC : 2,
-    FROM_WX_MINI_PRO : 3,
-    FROM_WX_PLU : 4,
-    FROM_WX_E : 5,
-    FROM_APP : 6,
-    FROM_DEVICE : 7
-}
-
-declare const USER_SEX: {
-    unknown:0,
-    male:1,
-    female:2,
-}
-
-declare type ACCOUNT_TYPE = typeof ACCOUNT_TYPE[keyof typeof ACCOUNT_TYPE];
-declare type USER_TYPE = typeof USER_TYPE[keyof typeof USER_TYPE];
-declare type USER_FORM = typeof USER_FORM[keyof typeof USER_FORM];
-declare type USER_SEX = typeof USER_SEX[keyof typeof USER_SEX];
-
-
-declare interface User {
-    id: string,
-    status: 0 | 1
-    name: string,
-    sex: USER_SEX,
-    username: string,
-    phone?: string,
-    email?: string,
-    accountType: ACCOUNT_TYPE,
-    birthday?: string,
-    headImg?: string,
-    nickname?: string,
-    motto?: string,
-    enabled: boolean,
-    userType: USER_TYPE,
-    userFrom: USER_FORM,
-    needToReview: boolean,
-    socketOnline: boolean,
-    unionId?: string,
-    openId?: string,
-    wxPid?: string,
-    createTime: string,
-    lastLoginTime?: string,
-    lastLogoutTime?: string,
-    latitude?: number,
-    longitude?: number,
-    deviceId?: string,
-    tokenExpired?:number,
-    mustChangePwd?:boolean
-}
-
-declare type CurWebsite = {
-    websiteId?:string,
-    websiteNo?:string,
-    language:string,
-}
-
-declare type CSRFToken = {
-    csrfToken: string,
-    csrfHeader: string,
-}
-
-declare interface Cookie {
-    name: string;
-    value: string;
-    path?: string;
-    httpOnly?: boolean;
-    secure?: boolean;
-    maxAge?: number;
-    expires?: Date;
-    sameSite?: boolean | 'lax' | 'strict' | 'none';
-    domain?: string;
-}
-
-declare interface IbootReadonlyCookies {
-    get(name: string): Cookie | undefined;
-    getAll(): Cookie[];
-    has(name: string): boolean;
-    [Symbol.iterator](): IterableIterator<Cookie>;
-}
-
-declare interface IbootWritableCookie {
-    set(name: string, value: string, options?: Partial<Cookie>): void;
-    delete(name: string, options?: { path?: string; domain?: string }): void;
-}
-
-declare interface IbootCookieStore {
-    get(name: string): Cookie | undefined;
-    getAll(): Cookie[];
-    has(name: string): boolean;
-    set(name: string, value: string, options?: Partial<Cookie>): void;
-    delete(name: string, options?: { path?: string; domain?: string }): void;
-    [Symbol.iterator](): IterableIterator<Cookie>;
-}
-
-declare type HttpOpts = {
-    "deviceId"?: string,
-    "lang"?: string,
-    "webId"?: string,
-    "webNo"?: string,
-    "userType"?: USER_TYPE
-}
-
-declare type HttpToken = { username: string, token: string, utype: USER_TYPE, xcsrf?: CSRFToken };
-
-declare interface ResultModel<T> {
-    code: number,
-    success: boolean,
-    msg?: string,
-    data?: T,
-    host?: string,
-    errorCode?: string
-}
-
-declare type ResultStream = ReadableStream<Uint8Array>
-
-declare interface ClientGetParams {
-    data?: Record<string, string>,
-    useCache?: boolean,
-    heads?: Record<string, string>,
-    showError?: (error: string) => void
-}
-
-declare interface ClientPostParams {
-    data?: Record<string, string> | FormData | UIFormEntities,
-    heads?: Record<string, string>,
-    showError?: (error: string) => void,
-    showSuccess?:(msg:string)=>void
-}
+export * from './types/http';
+export * from './types/user';
+export * from './http-client';

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

@@ -0,0 +1,90 @@
+import { USER_TYPE } from './user';
+export type UIFormEntities<T = any> = {
+    [k: string]: T;
+};
+export type CSRFToken = {
+    csrfToken: string;
+    csrfHeader: string;
+};
+export type HttpClientOpts = {
+    "deviceId"?: string;
+    "lang"?: string;
+    "websiteId"?: string;
+    "websiteNo"?: string;
+    "userType"?: USER_TYPE;
+};
+export type HttpHeaderNames = 'Device-Id' | 'Website-Id' | 'Website-No' | 'Lang';
+export type HttpHeaders = {
+    "Device-Id"?: string;
+    "Website-Id"?: string;
+    "Website-No"?: string;
+    "Lang"?: string;
+};
+export type CookieNames = 'IBOOT_DEVICE_ID' | 'IBOOT_LOCALE' | 'IBOOT_WEBSITE_ID' | 'IBOOT_WEBSITE_NO' | 'token' | 'user';
+export type HttpToken = {
+    username: string;
+    token: string;
+    utype: USER_TYPE;
+    xcsrf?: CSRFToken;
+};
+export type ResultStream = ReadableStream<Uint8Array>;
+export type CurWebsite = {
+    websiteId?: string;
+    websiteNo?: string;
+    language: string;
+};
+export interface Cookie {
+    name: string;
+    value: string;
+    path?: string;
+    httpOnly?: boolean;
+    secure?: boolean;
+    maxAge?: number;
+    expires?: Date;
+    sameSite?: boolean | 'lax' | 'strict' | 'none';
+    domain?: string;
+}
+export interface IbootReadonlyCookies {
+    get(name: string): Cookie | undefined;
+    getAll(): Cookie[];
+    has(name: string): boolean;
+    [Symbol.iterator](): IterableIterator<Cookie>;
+}
+export interface IbootWritableCookie {
+    set(name: string, value: string, options?: Partial<Cookie>): void;
+    delete(name: string, options?: {
+        path?: string;
+        domain?: string;
+    }): void;
+}
+export interface IbootCookieStore {
+    get(name: string): Cookie | undefined;
+    getAll(): Cookie[];
+    has(name: string): boolean;
+    set(name: string, value: string, options?: Partial<Cookie>): void;
+    delete(name: string, options?: {
+        path?: string;
+        domain?: string;
+    }): void;
+    [Symbol.iterator](): IterableIterator<Cookie>;
+}
+export interface ResultModel<T> {
+    code: number;
+    success: boolean;
+    msg?: string;
+    data?: T;
+    host?: string;
+    errorCode?: string;
+}
+export interface ClientGetParams {
+    data?: Record<string, string>;
+    useCache?: boolean;
+    heads?: Record<string, string>;
+    showError?: (error: string) => void;
+}
+export interface ClientPostParams {
+    data?: Record<string, string> | FormData | UIFormEntities;
+    heads?: Record<string, string>;
+    showError?: (error: string) => void;
+    showSuccess?: (msg: string) => void;
+}

package/dist/types/types/user.d.ts

@@ -0,0 +1,48 @@
+export declare const ACCOUNT_TYPE_MAP: {
+    GENERAL: number;
+    PHONE: number;
+    EMAIL: number;
+};
+export declare const USER_TYPE_MAP: {
+    TYPE_MGT: number;
+    TYPE_C: number;
+    TYPE_B: number;
+};
+export declare const USER_FORM_MAP: {
+    FROM_WEB: number;
+    FROM_PC: number;
+    FROM_WX_MINI_PRO: number;
+    FROM_WX_PLU: number;
+    FROM_WX_E: number;
+    FROM_APP: number;
+    FROM_DEVICE: number;
+};
+export declare const USER_SEX_MAP: {
+    unknown: number;
+    male: number;
+    female: number;
+};
+export type ACCOUNT_TYPE = typeof ACCOUNT_TYPE_MAP[keyof typeof ACCOUNT_TYPE_MAP];
+export type USER_TYPE = typeof USER_TYPE_MAP[keyof typeof USER_TYPE_MAP];
+export type USER_FORM = typeof USER_FORM_MAP[keyof typeof USER_FORM_MAP];
+export type USER_SEX = typeof USER_SEX_MAP[keyof typeof USER_SEX_MAP];
+export interface User {
+    id: string;
+    name: string;
+    username: string;
+    nickname: string;
+    sex: USER_SEX;
+    headImg: string;
+    lastLoginTime: string;
+    tokenExpired: string;
+    deviceId: string;
+    userType: USER_TYPE;
+    status: number;
+    accountType: number;
+    enabled: boolean;
+    userFrom: USER_FORM;
+    needToReview: boolean;
+    socketOnline: boolean;
+    createTime: string;
+    mustChangePwd: boolean;
+}

package/dist/types/utils.d.ts

@@ -1,30 +1,8 @@
 export declare const isArray: (obj: unknown) => boolean;
-export declare const arrayIndexOf: <T>(arr: Array<T>, value: string | number, keyOrPredicate?: keyof T | ((item: T) => boolean)) => number;
-export declare const removeArrayItem: <T>(arr: Array<T>, value: string | number, keyOrPredicate?: keyof T | ((item: T) => boolean)) => boolean;
-export declare const strFormat: (str: string, ...args: string[]) => string;
-export declare const strTrim: (str?: string) => string;
-export declare const strLTrim: (str?: string) => string;
-export declare const strRTrim: (str?: string) => string;
 /**
  * 生成指定长度的随机串
  * @param {Object} len
  */
 export declare const randomString: (len: number) => string;
-/**
- * 生成指定长度的uuid
- * @param {Object} len
- * @param {Object} radix 2,10,16进制
- */
-export declare const uuidStr: (len: number, radix?: number) => string;
-export declare const cleanHtml: (str?: string) => string;
-export declare const simpleMarkdownToText: (markdown?: string) => string;
-export declare const substring: (str: string, len: number) => string;
-export declare const decrypt: (data: string, apikey: string) => string;
 export declare const urlParamToJson: (urlQueryParams: string, exclude?: string[]) => Record<string, string>;
-export declare const urlDecode: (value: string | null | undefined) => string;
-/**
- * 首字符大写
- * @param str
- * @returns
- */
-export declare const capitalizeFirstLetter: (str: string) => string;
+export declare const urlEncode: (value: string | null | undefined) => string;

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "iboot-http-client",
   "private": false,
-  "version": "1.0.0",
-  "description": "A simple HTTP client library for making HTTP requests",
+  "version": "1.0.2",
+  "description": "iBoot.xin 相关应用的客户端Http封装",
   "type": "module",
-  "main": "./dist/iboot-http-client.cjs",
-  "module": "./dist/iboot-http-client.js",
+  "main": "./dist/iboot-http-client.cjs.js",
+  "module": "./dist/iboot-http-client.es.js",
   "browser": "./dist/iboot-http-client.umd.js",
   "exports": {
     ".": {
-      "import": "./dist/iboot-http-client.js",
-      "require": "./dist/iboot-http-client.cjs"
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/iboot-http-client.es.js",
+      "require": "./dist/iboot-http-client.cjs.js",
+      "default": "./dist/iboot-http-client.es.js"
     }
   },
   "types": "./dist/types/index.d.ts",
@@ -20,6 +22,7 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
     "test": "vitest run",
     "preview": "vite preview",
     "prepublishOnly": "npm run build"
@@ -28,7 +31,6 @@
     "http",
     "client",
     "request",
-    "axios",
     "fetch",
     "api",
     "rest"
@@ -38,7 +40,6 @@
   "devDependencies": {
     "@types/crypto-js": "^4.2.2",
     "@types/node": "^25.0.3",
-    "js-md5": "^0.8.3",
     "typescript": "~5.9.3",
     "vite": "^7.2.4",
     "vite-plugin-dts": "^4.5.4",
@@ -53,6 +54,8 @@
   },
   "homepage": "https://github.com/rockychen2016/iboot-http-client#readme",
   "dependencies": {
-    "crypto-js": "^4.2.0"
+    "crypto-js": "^4.2.0",
+    "js-md5": "^0.8.3",
+    "pino": "^10.1.0"
   }
 }