iboot-http-client 1.0.0

package/dist/types/HttpClient.d.ts

@@ -0,0 +1,65 @@
+export declare const defaultLocale = "zh-CN";
+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 {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly userType;
+    private readonly userFrom;
+    private readonly deviceId;
+    private readonly version;
+    private readonly lang;
+    private readonly websiteId?;
+    private readonly websiteNo?;
+    private readonly _isDebug;
+    constructor({ deviceId, lang, webId, webNo, userType }: Readonly<HttpOpts>);
+    isDebug(): boolean;
+    encrypt(data: string): string;
+    decrypt(data: string): string;
+    getDeviceId(): string;
+    private convertUrlParameter;
+    private sign;
+    private assemblyParameter;
+    private assemblyHeader;
+    private helloIboot;
+    private getApiUrl;
+    get<T>({ url, data, token }: Readonly<{
+        url: string;
+        data?: Record<string, any>;
+        token?: Readonly<HttpToken>;
+    }>): Promise<ResultModel<T>>;
+    csrf(): Promise<string | undefined>;
+    post<T>({ url, data, token }: Readonly<{
+        url: string;
+        data?: Record<string, any>;
+        token?: Readonly<HttpToken>;
+    }>): Promise<ResultModel<T>>;
+    stream({ url, data, token }: Readonly<{
+        url: string;
+        data?: Record<string, any>;
+        token?: Readonly<HttpToken>;
+    }>): Promise<Response>;
+    getUserInfo(cookies: IbootCookieStore): User | null;
+    getToken(cookies: IbootCookieStore): HttpToken;
+    getTokenByCookies: (cookies: IbootReadonlyCookies) => HttpToken;
+    setToken(data: User & {
+        token: string;
+        extFields: Record<string, any>;
+    }, response: {
+        cookies: IbootWritableCookie;
+    }): {
+        cookies: IbootWritableCookie;
+    };
+    cleanToken(response: {
+        cookies: IbootWritableCookie;
+    }): {
+        cookies: IbootWritableCookie;
+    };
+}

package/dist/types/index.d.ts

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

package/dist/types/utils.d.ts

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

package/dist/vite.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "iboot-http-client",
+  "private": false,
+  "version": "1.0.0",
+  "description": "A simple HTTP client library for making HTTP requests",
+  "type": "module",
+  "main": "./dist/iboot-http-client.cjs",
+  "module": "./dist/iboot-http-client.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",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "test": "vitest run",
+    "preview": "vite preview",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "http",
+    "client",
+    "request",
+    "axios",
+    "fetch",
+    "api",
+    "rest"
+  ],
+  "author": "szygnet@qq.com",
+  "license": "MIT",
+  "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",
+    "vitest": "^1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rockychen2016/iboot-http-client.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rockychen2016/iboot-http-client/issues"
+  },
+  "homepage": "https://github.com/rockychen2016/iboot-http-client#readme",
+  "dependencies": {
+    "crypto-js": "^4.2.0"
+  }
+}