@jctrans-materials/shared 1.0.40-beta.1 → 1.0.40-beta.11

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>;
 
 /**
@@ -169,6 +146,7 @@ export declare const currentConfig: {
     readonly allLinePath: string;
     readonly oldBasePath: string;
     readonly prefixPath: string;
+    readonly appId: string | undefined;
 };
 
 /**
@@ -183,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>;
 
@@ -194,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 拦截器
@@ -218,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>;
 
 /**
@@ -234,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>;
 
@@ -263,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;
@@ -304,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 */
@@ -333,10 +307,6 @@ export declare function getExpiresTimeIn(): number;
  */
 export declare function getFirstDomain(): string | undefined;
 
-/**
- * 全局获取 GIO 相关 session
- * @returns
- */
 export declare function getGioSessionItems(): {
     registerEntry: string | null;
 };
@@ -347,11 +317,6 @@ export declare function getGioSessionItems(): {
  */
 export declare const getIsEn: () => boolean;
 
-/**
- * 获取用户加入公司信息
- * @param data
- * @returns
- */
 export declare function getJoinCompanyApi(data: any): Promise<any>;
 
 /**
@@ -367,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>;
@@ -413,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>;
 
 /**
@@ -454,6 +398,7 @@ export declare const getSharedConfig: () => {
     readonly allLinePath: string;
     readonly oldBasePath: string;
     readonly prefixPath: string;
+    readonly appId: string | undefined;
 };
 
 /**
@@ -480,13 +425,10 @@ 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"];
+
 /**
  * GIO 属性对象
  */
@@ -609,6 +551,50 @@ export declare interface GioPageProps {
  */
 export declare type GioTimerId = string;
 
+/**
+ * GrowingIO SDK 封装模块
+ * 基于 gio-webjs-sdk npm 包
+ *
+ * @module gio
+ *
+ * @example
+ * ```typescript
+ * import { tracker, type GioAttributes, type GioInitOptions } from '@jctrans-materials/shared';
+ *
+ * // 基础初始化
+ * tracker.init('your-account-id', 'your-datasource-id', {
+ *   debug: true,
+ *   trackPage: false,
+ * });
+ *
+ * // 微信公众号 H5（需要 appId 和 forceLogin）
+ * tracker.init('accountId', 'dataSourceId', 'wx-app-id', {
+ *   forceLogin: true,
+ *   debug: true,
+ * });
+ *
+ * // 设置登录用户 ID
+ * tracker.setUserId('user-123');
+ * tracker.setUserId('user-123', 'user_id', () => {
+ *   console.log('set user id with userKey done');
+ * });
+ *
+ * // 埋点事件
+ * tracker.track('order_submit', {
+ *   order_type: 'freight',
+ *   price: 5000,
+ *   services: ['ocean', 'customs']
+ * });
+ *
+ * // 设置全局属性
+ * tracker.setGeneralProps({
+ *   platform: 'jctrans_web',
+ *   locale: 'zh-CN'
+ * });
+ * ```
+ */
+export declare type GioTrackAttrs = Record<string, string | number | Array<string | number> | null | undefined>;
+
 declare class GioTracker {
     private hasInitCalled;
     private dispatcher;
@@ -822,7 +808,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;
 
 /**
  * 全局初始化方法，在项目入口调用
@@ -853,17 +844,19 @@ 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;
 }
 
+/**
+ * 检查值是否为空
+ * @param value 要检查的值
+ * @returns 是否为空
+ */
+export declare function isEmpty(value: any): boolean;
+
 /**
  * 检查 GIO 是否可用（浏览器环境且已初始化）
  *
@@ -1116,77 +1109,39 @@ export declare interface LocationUnifiedItem {
     display?: string;
     displayEn?: string;
     displayCn?: string;
-    /** * 通用代码字段 (自动取 scacCode 或 carrierCode)
-     * 适用于仅展示用途
-     */
     code?: string;
-    /** * SCAC 代码 (Standard Carrier Alpha Code) - 通常用于船司
-     */
     scacCode?: string;
-    /** * IATA 代码 - 通常用于航司
-     */
     iataCode?: string;
-    /** * 承运人通用代码
-     */
     carrierCode?: string;
-    /** * 承运人类型: 'air' | 'shipping'
-     */
     lineType?: string;
     continent?: Record<string, any>;
     country?: Record<string, any>;
     city?: Record<string, any>;
     province?: Record<string, any>;
     raw?: any;
+    [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;
     redirectPath: string;
     kick: boolean;
+    prjId?: string;
+    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;
@@ -1198,14 +1153,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;
@@ -1213,7 +1163,7 @@ declare interface LoginResponseData {
     hasLogon?: boolean;
 }
 
-declare interface LoginResult {
+export declare interface LoginResult {
     accessToken: string;
     expireIn: number;
     refreshToken: string;
@@ -1235,6 +1185,10 @@ export declare type ModalEvents = Record<ActionKeys, any> & {
 
 export declare type ModalOpenCallback = () => void;
 
+export declare const normalizeAttrs: (attrs?: GioTrackAttrs) => GioTrackAttrs;
+
+export declare const normalizeClickPageAttrs: (eventName: string, attrs?: GioTrackAttrs) => GioTrackAttrs;
+
 /**
  * 页面变更回调
  */
@@ -1245,59 +1199,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;
@@ -1307,7 +1231,7 @@ export declare interface reportNewTypeData {
 
 export declare function reportNewTypeDataApi(payload: reportNewTypeData): Promise<{}>;
 
-export declare type ReportType = "City" | "Seaport" | "Airport" | "Line";
+export declare type ReportType = "City" | "Seaport" | "Airport" | "Line" | "Carrier" | "shipping_line" | "shipping_carrier" | "air_line" | "air_carrier";
 
 declare interface RequestAdapter {
     get(url: string, config?: RequestConfig): Promise<any>;
@@ -1328,22 +1252,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>;
 
 /**
@@ -1430,11 +1342,6 @@ export declare interface SearchWithScopeParams extends SearchByNameParams {
     provinceId?: number;
 }
 
-/**
- * 发送邮箱验证码
- * @param data
- * @returns
- */
 export declare function sendEmailCodeApi(data: {
     target: string;
     countryId?: number;
@@ -1442,11 +1349,6 @@ export declare function sendEmailCodeApi(data: {
     uuid?: string;
 }): Promise<any>;
 
-/**
- * 发送手机验证码
- * @param data
- * @returns
- */
 export declare function sendMobileCodeApi(data: {
     target: string;
     countryId?: number;
@@ -1454,10 +1356,6 @@ export declare function sendMobileCodeApi(data: {
     uuid?: string;
 }): Promise<any>;
 
-/**
- * 全局设置 session
- * @param data
- */
 export declare function setAuthSessionItems(data: {
     activityCode?: string | null;
     referenceUserId?: string | null;
@@ -1470,10 +1368,6 @@ export declare function setAuthSessionItems(data: {
     compKey?: string | null;
 }): void;
 
-/**
- * 全局设置 GIO 相关 session
- * @param data
- */
 export declare function setGioSessionItems(data: {
     registerEntry?: string | null;
 }): void;
@@ -1496,6 +1390,7 @@ export declare interface SharedConfig {
     linePath: string;
     allLinePath: string;
     appId?: string;
+    commonKeys?: Partial<CommonKeysConfig>;
 }
 
 /**
@@ -1518,7 +1413,7 @@ export declare function slideGetApi(data: {
     ts: number;
 }): Promise<any>;
 
-declare interface ThirdPartyInfo {
+export declare interface ThirdPartyInfo {
     thirdPartyEmail: string;
     thirdPartyId: string;
     thirdPartyType: string;
@@ -1526,7 +1421,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 {
     /**
      * 手机邮箱匹配列表 (修正为数组)
      */
@@ -1550,7 +1452,7 @@ declare interface ThirdResponseData {
     [property: string]: any;
 }
 
-declare interface ThirdResponseMobileEmailList {
+export declare interface ThirdResponseMobileEmailList {
     account: string;
     cityId: number;
     cityNameCn: string;
@@ -1580,10 +1482,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;
 
@@ -1603,27 +1502,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;