@jctrans-materials/shared 1.0.40-beta.10 → 1.0.40-beta.12

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { Emitter } from 'mitt';
 
 declare type ActionKeys = (typeof MODAL_ACTION)[keyof typeof MODAL_ACTION];
 
-declare interface ApiResponse<T = any> {
+export declare interface ApiResponse<T = any> {
     code: number;
     msg: string;
     data: T;
@@ -16,10 +16,6 @@ export declare interface AppointSearch {
 
 export declare type AppointSearchName = "continentId" | "countryId" | "cityId" | "provinceId" | "seaportId" | "airportId" | "allCityByCountryId";
 
-/**
- * 1-1-2.TGC自动登录
- * @returns
- */
 export declare function autoLoginByTGC(data: {
     toSys: string;
     path: string;
@@ -41,18 +37,8 @@ export declare interface BaseResponse<T = any> {
  */
 export declare type BeforeSendCallback = (event: GioEvent) => GioEvent;
 
-/**
- * 验证验证码绑定第三方应用
- * @param data
- * @returns
- */
 export declare function bindThirdPartyByCodeApi(data: any): Promise<any>;
 
-/**
- * 验证密码绑定第三方应用
- * @param data
- * @returns
- */
 export declare function bindThirdPartyByPwdApi(data: any): Promise<any>;
 
 declare interface CarrierRequestPayload {
@@ -64,29 +50,14 @@ declare interface CarrierRequestPayload {
     [key: string]: any;
 }
 
-/**
- * 检查账号是否存在(忘记密码专用)
- * @param data
- * @returns
- */
 export declare function checkAccountExistsFPApi(data: any): Promise<any>;
 
-/**
- * 验证邮件验证码
- * @param data
- * @returns
- */
 export declare function checkEmailCodeApi(data: {
     uuid: string;
     code: string;
     target: string;
 }): Promise<any>;
 
-/**
- * 验证手机验证码
- * @param data
- * @returns
- */
 export declare function checkMobileCodeApi(data: {
     code: string;
     uuid: string;
@@ -107,6 +78,22 @@ export declare interface ClientIdPluginOptions {
     headerName?: string;
 }
 
+/**
+ * 2. 可配置的常量定义
+ */
+export declare interface CommonKeysConfig {
+    TokenKey: string;
+    HasLoginKey: string;
+    PrjId: string;
+    ExpiresInKey: string;
+    ExpiresInTimeKey: string;
+    RefreshTokenKey: string;
+    RefreshExpiresInKey: string;
+    RefreshExpiresInTimeKey: string;
+    RememberMeAccountKey: string;
+    RememberMePasswordKey: string;
+}
+
 export declare interface CommonParams {
     current?: number;
     size?: number;
@@ -124,18 +111,8 @@ export declare interface CompanyOption {
     compName: string;
 }
 
-/**
- * 完善公司信息跳转
- * @param {*} data
- * @returns
- */
 export declare function completeCompRedirectApi(data: any): Promise<any>;
 
-/**
- * 完善信息加入公司
- * @param data
- * @returns
- */
 export declare function completeJoinCompanyRedirectApi(data: any): Promise<any>;
 
 /**
@@ -184,7 +161,7 @@ export declare function Decrypt(word: string): string;
  */
 export declare type DeviceIdCallback = (deviceId: string) => void;
 
-export declare type DisplayInfo = "Continent" | "Country" | "Province" | "City" | "Seaport" | "Airport";
+export declare type DisplayInfo = "Continent" | "Country" | "Region" | "Province" | "City" | "Seaport" | "Airport";
 
 export declare const emitter: Emitter<ModalEvents>;
 
@@ -195,9 +172,9 @@ export declare const emitter: Emitter<ModalEvents>;
  */
 export declare function Encrypt(word: string): string;
 
-export declare const ExpiresInKey = "JC-Expires-In";
+export declare const ExpiresInKey: string;
 
-export declare const ExpiresInTimeKey = "JC-Expires-Time-In";
+export declare const ExpiresInTimeKey: string;
 
 /**
  * Fetch API ClientId 拦截器
@@ -219,15 +196,10 @@ export declare interface FetchClientIdOptions {
  * @param data
  * @returns
  */
-export declare function findDictAPi(data?: {
+export declare function findDictApi(data?: {
     size: number;
 }): Promise<any>;
 
-/**
- * 根据手机邮箱获取重复列表
- * @param data
- * @returns
- */
 export declare function findListByMobileEmailApi(data: any): Promise<any>;
 
 /**
@@ -235,7 +207,7 @@ export declare function findListByMobileEmailApi(data: any): Promise<any>;
  * @param data
  * @returns
  */
-export declare function findPAreaCodeAPi(data?: {
+export declare function findPAreaCodeApi(data?: {
     size: number;
 }): Promise<any>;
 
@@ -264,10 +236,6 @@ export declare function getAirport(params?: {
  */
 export declare function getAppId(): string;
 
-/**
- * 全局获取 session
- * @returns
- */
 export declare function getAuthSessionItems(): {
     activityCode: string | null;
     referenceUserId: string | null;
@@ -305,6 +273,11 @@ export declare function getCity(params?: {
     countryId?: number;
 }): Promise<BaseResponse<UnifiedItem>>;
 
+/**
+ * 获取当前的常量配置
+ */
+export declare const getCommonKeys: () => CommonKeysConfig;
+
 export declare const getCompanyOptionApi: (data: CompanyOption) => Promise<any>;
 
 /** 保留对外兼容函数：getContinent/getCountry/getCity/getProvince/getSeaport/getAirport */
@@ -334,10 +307,6 @@ export declare function getExpiresTimeIn(): number;
  */
 export declare function getFirstDomain(): string | undefined;
 
-/**
- * 全局获取 GIO 相关 session
- * @returns
- */
 export declare function getGioSessionItems(): {
     registerEntry: string | null;
 };
@@ -348,11 +317,6 @@ export declare function getGioSessionItems(): {
  */
 export declare const getIsEn: () => boolean;
 
-/**
- * 获取用户加入公司信息
- * @param data
- * @returns
- */
 export declare function getJoinCompanyApi(data: any): Promise<any>;
 
 /**
@@ -368,25 +332,10 @@ export declare function getLanguage(): string | undefined;
  */
 export declare function getLocalIpDataApi(data: any): Promise<any>;
 
-/**
- * 获取登录微信二维码
- * @param data
- * @returns
- */
 export declare function getLoginQrCode(data?: {}): Promise<any>;
 
-/**
- * 忘记密码发送验证码
- * @param data
- * @returns
- */
 export declare function getMEVCodeApi(data: any): Promise<any>;
 
-/**
- * 根据用户 id 获取手机号
- * @param data
- * @returns
- */
 export declare function getMobileEmailApi(data: {
     id: string;
 }): Promise<any>;
@@ -414,12 +363,6 @@ export declare function getProvince(params?: {
     countryId?: number;
 }): Promise<BaseResponse<UnifiedItem>>;
 
-/**
- * 跳转其他站
- * @param appId
- * @param path
- * @returns
- */
 export declare function getRedirectPathApi(appId: string, path: string): Promise<any>;
 
 /**
@@ -482,11 +425,6 @@ export declare function getToken(): string | undefined;
  */
 export declare function getTracker<T extends GioTracker>(trackerInstance?: T): T | null;
 
-/**
- * 获取用户手机号邮箱信息
- * @param data
- * @returns
- */
 export declare function getUserInfoApi(data: any): Promise<any>;
 
 export declare const GIO_CLICK_PAGE_REQUIRED_FIELDS: readonly ["companyID_var", "contactPerson_var", "inquiryID_var", "modulePosition_var", "moduleType_var", "pageCode_var", "pageClickName_var", "moduleName_var"];
@@ -590,6 +528,8 @@ export declare interface GioInitOptions {
     ignoreFields?: string[];
     /** 曝光比例（0-1），与曝光插件结合使用，默认 0 */
     impressionScale?: number;
+    /** 性能采集插件配置。集成后默认开启首屏加载监控和错误监控，默认关闭网络监控 */
+    performance?: GioPerformanceOptions;
     /** 与小程序打通时的配置项，SDK >= 4.3.0 支持 */
     embeddedAdapter?: {
         /** 圈选服务器地址，SaaS 客户不需要配置 */
@@ -608,6 +548,38 @@ export declare interface GioPageProps {
     title: string;
 }
 
+/**
+ * 性能采集 - 网络监控排除配置
+ */
+declare interface GioPerformanceNetwork {
+    /**
+     * 请求监控排除名单
+     * 值可以是域名字符串、正则表达式，或由两者组成的数组
+     * 配置此项即视为开启请求监控
+     * 注意：使用纯字符串校验时应尽可能使用长且准确的字符，过短的字符串可能会误过滤其他请求
+     */
+    exclude?: string | RegExp | Array<string | RegExp>;
+}
+
+/**
+ * 性能采集配置项
+ * 集成性能采集插件后，默认开启首屏加载监控和错误监控，默认关闭网络监控
+ */
+declare interface GioPerformanceOptions {
+    /** 是否开启首屏加载监控，默认 true */
+    monitor?: boolean;
+    /** 是否开启错误监控，默认 true */
+    exception?: boolean;
+    /**
+     * 网络监控配置
+     * - 不配置时默认关闭网络监控
+     * - 设为 true 开启网络监控
+     * - 设为对象时开启网络监控并配置排除名单
+     * 注意：请求监控强制过滤了 Gio 上报的请求
+     */
+    network?: boolean | GioPerformanceNetwork;
+}
+
 /**
  * 事件计时器 ID 类型
  */
@@ -870,7 +842,12 @@ export declare interface GioUserAttributes {
     [key: string]: GioAttributeValue;
 }
 
-export declare const HasLoginKey = "hasLogin";
+export declare const HasLoginKey: string;
+
+/**
+ * 全局初始化方法，在项目入口调用
+ */
+export declare const initCommonKeys: (newKeys: Partial<CommonKeysConfig>) => void;
 
 /**
  * 全局初始化方法，在项目入口调用
@@ -901,14 +878,9 @@ export declare function installClientIdPlugin(instance: AxiosInstance, options?:
  */
 export declare function installFetchClientId(options?: FetchClientIdOptions): void;
 
-/**
- * 获取邀请加入公司信息
- * @param data
- * @returns
- */
 export declare function inviteJoinGetCompApi(data: any): Promise<any>;
 
-declare interface IResponse<T> {
+export declare interface IResponse<T> {
     data: T;
 }
 
@@ -1184,39 +1156,14 @@ export declare interface LocationUnifiedItem {
     [key: string]: unknown;
 }
 
-/**
- * 用户登录
- * @param loginData
- * @returns
- */
 export declare function loginApi(loginData: LoginDataParams): Promise<IResponse<ApiResponse<LoginResponseData>>>;
 
-/**
- * 验证码登录注册
- * @param data
- * @returns
- */
 export declare function loginByEmailOrMobileCodeApi(data: any): Promise<IResponse<ApiResponse<LoginResponseData>>>;
 
-/**
- * Facebook 登录
- * @param data
- * @returns
- */
 export declare function loginByFacebookApi(data: any): Promise<IResponse<ApiResponse<ThirdResponseData>>>;
 
-/**
- * LinkedIn 登录
- * @param data
- * @returns
- */
 export declare function loginByLinkedinApi(data: any): Promise<IResponse<ApiResponse<ThirdResponseData>>>;
 
-/**
- * 微信二维码登录(1s轮询)
- * @param data
- * @returns
- */
 export declare function loginByQrCode(data: {
     uniqueCode: string;
     appId: string;
@@ -1226,14 +1173,9 @@ export declare function loginByQrCode(data: {
     formEntry?: string;
 }): Promise<any>;
 
-/**
- * 微信二维码登录绑定用户(验证码)
- * @param data
- * @returns
- */
 export declare function loginCodeBindWechatApi(data: any): Promise<any>;
 
-declare interface LoginDataParams {
+export declare interface LoginDataParams {
     username: string;
     password: string;
     appId: string;
@@ -1245,14 +1187,9 @@ declare interface LoginDataParams {
     referenceUserId: string;
 }
 
-/**
- * 微信二维码登录绑定用户(账号密码)
- * @param data
- * @returns
- */
 export declare function loginPwdBindWechatApi(data: any): Promise<any>;
 
-declare interface LoginResponseData {
+export declare interface LoginResponseData {
     redirect: boolean;
     redirectPath?: string;
     tgc?: string;
@@ -1260,7 +1197,7 @@ declare interface LoginResponseData {
     hasLogon?: boolean;
 }
 
-declare interface LoginResult {
+export declare interface LoginResult {
     accessToken: string;
     expireIn: number;
     refreshToken: string;
@@ -1296,59 +1233,29 @@ export declare interface PageParams {
     size?: number;
 }
 
-export declare const PrjId = "prjId";
+export declare const PrjId: string;
 
-export declare const RefreshExpiresInKey = "JC-Refresh-Expires-In";
+export declare const RefreshExpiresInKey: string;
 
-export declare const RefreshExpiresInTimeKey = "JC-Refresh-Expires-Time-In";
+export declare const RefreshExpiresInTimeKey: string;
 
-export declare const RefreshTokenKey = "JC-Refresh-Token";
+export declare const RefreshTokenKey: string;
 
-/**
- * 国际站峰会注册
- * @param data
- * @returns
- */
 export declare function registerApi(data: any): Promise<any>;
 
-/**
- * 使用第三方应用注册用户公司
- * @param data
- * @returns
- */
 export declare function registerByThirdPartyApi(data: any): Promise<any>;
 
-/**
- * 用户注册加入公司
- * @param data
- * @returns
- */
 export declare function registerJoinCompanyApi(data: any): Promise<any>;
 
-/**
- * 微信二维码登录用户注册加入公司 🍉
- * @param data
- * @returns
- */
 export declare function registerJoinCompanyBindWechatApi(data: any): Promise<any>;
 
-/**
- * 第三方应用注册加入公司
- * @param data
- * @returns
- */
 export declare function registerJoinCompByThirdPartyApi(data: any): Promise<any>;
 
-/**
- * 微信二维码登录注册用户公司
- * @param data
- * @returns
- */
 export declare function registerUserCompBindWechatApi(data: any): Promise<any>;
 
-export declare const RememberMeAccountKey = "JC-Remember-Account";
+export declare const RememberMeAccountKey: string;
 
-export declare const RememberMePasswordKey = "JC-Remember-Password";
+export declare const RememberMePasswordKey: string;
 
 export declare interface reportNewTypeData {
     reportData: string;
@@ -1379,22 +1286,10 @@ declare interface RequestOptions {
     fetch?: typeof fetch;
 }
 
-/**
- * 重置 session
- */
 export declare function resetAuthSessionItems(): void;
 
-/**
- * 重置 GIO 相关 session
- * @returns
- */
 export declare function resetGioSessionItems(): void;
 
-/**
- * 重置密码
- * @param data
- * @returns
- */
 export declare function resetPasswordApi(data: any): Promise<any>;
 
 /**
@@ -1481,11 +1376,6 @@ export declare interface SearchWithScopeParams extends SearchByNameParams {
     provinceId?: number;
 }
 
-/**
- * 发送邮箱验证码
- * @param data
- * @returns
- */
 export declare function sendEmailCodeApi(data: {
     target: string;
     countryId?: number;
@@ -1493,11 +1383,6 @@ export declare function sendEmailCodeApi(data: {
     uuid?: string;
 }): Promise<any>;
 
-/**
- * 发送手机验证码
- * @param data
- * @returns
- */
 export declare function sendMobileCodeApi(data: {
     target: string;
     countryId?: number;
@@ -1505,10 +1390,6 @@ export declare function sendMobileCodeApi(data: {
     uuid?: string;
 }): Promise<any>;
 
-/**
- * 全局设置 session
- * @param data
- */
 export declare function setAuthSessionItems(data: {
     activityCode?: string | null;
     referenceUserId?: string | null;
@@ -1521,10 +1402,6 @@ export declare function setAuthSessionItems(data: {
     compKey?: string | null;
 }): void;
 
-/**
- * 全局设置 GIO 相关 session
- * @param data
- */
 export declare function setGioSessionItems(data: {
     registerEntry?: string | null;
 }): void;
@@ -1547,6 +1424,7 @@ export declare interface SharedConfig {
     linePath: string;
     allLinePath: string;
     appId?: string;
+    commonKeys?: Partial<CommonKeysConfig>;
 }
 
 /**
@@ -1569,7 +1447,7 @@ export declare function slideGetApi(data: {
     ts: number;
 }): Promise<any>;
 
-declare interface ThirdPartyInfo {
+export declare interface ThirdPartyInfo {
     thirdPartyEmail: string;
     thirdPartyId: string;
     thirdPartyType: string;
@@ -1577,7 +1455,14 @@ declare interface ThirdPartyInfo {
     [property: string]: any;
 }
 
-declare interface ThirdResponseData {
+export declare interface ThirdResponse {
+    code: number;
+    data: ThirdResponseData;
+    msg: string;
+    [property: string]: any;
+}
+
+export declare interface ThirdResponseData {
     /**
      * 手机邮箱匹配列表 (修正为数组)
      */
@@ -1601,7 +1486,7 @@ declare interface ThirdResponseData {
     [property: string]: any;
 }
 
-declare interface ThirdResponseMobileEmailList {
+export declare interface ThirdResponseMobileEmailList {
     account: string;
     cityId: number;
     cityNameCn: string;
@@ -1631,10 +1516,7 @@ export declare interface TokenData {
     refreshTokenExpireIn?: number;
 }
 
-/**
- * 2. 常量定义 (补全所有业务 Key)
- */
-export declare const TokenKey = "JC-JAVA-Token-Root";
+export declare const TokenKey: string;
 
 export declare function toSafeHeaderValue(value: string): string;
 
@@ -1654,27 +1536,12 @@ export declare interface UnifiedItem {
     raw?: any;
 }
 
-/**
- * 获取用户信息
- * @param data
- * @returns
- */
 export declare function userCompPermsApi(data: any): Promise<any>;
 
-/**
- * 验证账号是否存在 /auth/validateAccountExist
- * @param data
- * @returns
- */
 export declare function validateAccountExistApi(data: {
     target: string;
 }): Promise<any>;
 
-/**
- * 校验注册公司是否重名
- * @param data
- * @returns
- */
 export declare function validateCompanyApi(data: {
     countryId: number;
     cityId: number;