@antglobal/voyager-campaign-sdk 0.0.0 → 0.0.1788950302-dev.0

package/dist/adapter/agreementSign.d.ts

@@ -0,0 +1,16 @@
+/**
+ * CN 协议中心签约公共流程（mp 与 mp_web 共用，基于 @alipay/agreement-utils）；
+ * 环境判断与工具库加载由各平台注入。
+ */
+import type { AgreementUtilsPort } from './types';
+import type { SignResult } from '../types';
+export interface AgreementSignFlowOptions {
+    /** prod/pre 用正式签约产品，其余环境用联调签约产品 */
+    isProdOrPreEnv: () => boolean;
+    loadAgreementUtils: () => AgreementUtilsPort;
+}
+export interface AgreementSignFlow {
+    querySignStatus(): Promise<SignResult>;
+    sign(): Promise<SignResult>;
+}
+export declare function createAgreementSignFlow(options: AgreementSignFlowOptions): AgreementSignFlow;

package/dist/adapter/mp.d.ts

@@ -0,0 +1,2 @@
+import type { PlatformAdapter } from './types';
+export declare function createMpAdapter(): PlatformAdapter;

package/dist/adapter/mpWeb.d.ts

@@ -0,0 +1,2 @@
+import type { PlatformAdapter } from './types';
+export declare function createMpWebAdapter(): PlatformAdapter;

package/dist/adapter/mpWebDevEnv.d.ts

@@ -0,0 +1,29 @@
+/**
+ * mp_web DEV 联调：URL 参数 `_voyager_dev_env`（格式 `sofa*pspId*userId*AppId`）
+ * 注入联调信息，缓存到 localStorage 持续生效，传空字符串清空。
+ */
+export interface DevEnvInfo {
+    sofa?: string;
+    pspId?: string;
+    userId?: string;
+    AppId?: string;
+}
+/** 环境判断：injectInfo 优先，域名兜底，缺省 PROD */
+export declare function getEnv(): string;
+export declare function getDevEnvInfo(): DevEnvInfo | undefined;
+/**
+ * 非 PROD 环境注入联调信息：sofa -> sofa-group-name 头，pspId -> 请求参数，
+ * userId -> mockAuth + userId 头，AppId -> AppId 头，并移除 _voyager_dev_env 参数
+ */
+export declare function applyDevEnvInfo(headers: Record<string, string>, params: Record<string, unknown>): void;
+/** headers 同步写入 requestData[0].extHeaders：兼容容器不支持自定义请求头 */
+export declare function addExtHeaders(requestData: Array<Record<string, unknown>>, headers: Record<string, string>): void;
+/** 按环境与钱包选联调网关；PRE 额外携带 workspaceId=pre */
+export declare function getDevGatewayConfig(clientName: string): {
+    gateway?: string;
+    workspaceId?: string;
+};
+/** 联调环境判定：DEV/TEST 走无鉴权 HTTP 直连，PRE/PROD 走带鉴权容器通道 */
+export declare function isDevLikeEnv(): boolean;
+/** 测试用：重置模块级解析缓存 */
+export declare function resetDevEnvCache(): void;

package/dist/adapter/types.d.ts

@@ -0,0 +1,63 @@
+import type { SignResult, SystemInfo, VoyagerPlatform } from '../types';
+export type { VoyagerPlatform };
+export interface RpcPayload {
+    operationType: string;
+    requestData: Array<{
+        serviceCode: string;
+        params: Array<Record<string, unknown>>;
+    }>;
+    /** DEV/TEST/PRE 联调注入的请求头（_voyager_dev_env） */
+    headers?: Record<string, string>;
+    /** DEV/TEST/PRE 联调切换的网关地址 */
+    gateway?: string;
+    /** PRE 联调环境标识 */
+    workspaceId?: string;
+}
+export interface RequestInput<TParams extends Record<string, unknown> = Record<string, unknown>> {
+    serviceCode: string;
+    params: TParams;
+}
+export interface StoragePort {
+    read(key: string): Promise<unknown>;
+    write(key: string, data: unknown): Promise<void>;
+    remove(key: string): Promise<void>;
+}
+/**
+ * 平台适配器：mp 与 mp_web 各自实现，共享核心不直接触碰端能力
+ */
+export interface PlatformAdapter {
+    platform: VoyagerPlatform;
+    rpc<TResponse>(payload: RpcPayload): Promise<TResponse>;
+    /** 发送前对 payload 做平台级加工（如 mp_web 联调环境的网关切换与请求头注入） */
+    decoratePayload?(payload: RpcPayload): Promise<RpcPayload> | RpcPayload;
+    getSystemInfo(): Promise<SystemInfo>;
+    /** 钱包标识（对齐 biz-base 取 hylid client）：mp_web 用 client，mp 固定 alipay */
+    getClientName(): string;
+    /** 当前语言原始值：mp_web 用 hylid getCurrentLanguage，mp 用 systemInfo 语言字段 */
+    getLocale(systemInfo: SystemInfo): string;
+    /** 可选：获取风控 tokenId（envInfo.tokenId），未提供时不注入 */
+    getAppToken?(): Promise<string | undefined>;
+    storage: StoragePort;
+    fetchWhitelistConfig(): Promise<unknown>;
+    querySignStatus(): Promise<SignResult>;
+    sign(): Promise<SignResult>;
+}
+export interface AgreementUtilsPort {
+    querySignRecord(productCd: string): Promise<{
+        success?: boolean;
+        data?: {
+            userId?: string;
+            signRecordVOS?: Array<{
+                agreementId?: string;
+                status?: string;
+            }>;
+        };
+    }>;
+    signAgreement(options: {
+        productCd: string;
+        agreementIds: string[];
+    }): Promise<{
+        success?: boolean;
+        userId?: string;
+    }>;
+}

package/dist/core/cache.d.ts

@@ -0,0 +1,6 @@
+export declare const VOYAGER_USER_INFO = "VOYAGER_USER_INFO";
+export declare const VOYAGER_API_WHITELIST_CONFIG = "VOYAGER_API_WHITELIST_CONFIG";
+import type { StoragePort } from '../adapter/types';
+export declare function readCache<T>(storage: StoragePort, key: string): Promise<T | null>;
+export declare function writeCache<T>(storage: StoragePort, key: string, value: T): Promise<void>;
+export declare function removeCache(storage: StoragePort, key: string): Promise<void>;

package/dist/core/envInfo.d.ts

@@ -0,0 +1,17 @@
+import type { PlatformAdapter } from '../adapter/types';
+import type { SystemInfo, VoyagerEnvInfo } from '../types';
+export interface EnvInfoContext {
+    /** 钱包标识（hylid client），不再取 systemInfo.clientName/app */
+    clientName: string;
+    /** 当前语言原始值（hylid getCurrentLanguage），由 normalizeLocale 归一化 */
+    locale: string;
+    tokenId?: string;
+}
+/**
+ * 语言归一化，对齐 aplus-biz-base i18n/language.ts：
+ * 连字符转下划线、印尼语 id 转 in、region 大写，缺省 en_US
+ */
+export declare function normalizeLocale(lang: string): string;
+/** 字段取值对齐 aplus-biz-base getEnvInfo（不含 addRiskTokenId/getLocationFn 相关逻辑） */
+export declare function createEnvInfo(info: SystemInfo, context: EnvInfoContext): VoyagerEnvInfo;
+export declare function createEnvInfoLoader(adapter: PlatformAdapter): () => Promise<VoyagerEnvInfo>;

package/dist/core/rawRequest.d.ts

@@ -0,0 +1,6 @@
+import type { PlatformAdapter } from '../adapter/types';
+import type { VoyagerEnvInfo } from '../types';
+import { createEnvInfoLoader } from './envInfo';
+export type RawRequestFn = <TResponse>(serviceCode: string, params: Record<string, unknown>) => Promise<TResponse>;
+export declare function createRawRequest(adapter: PlatformAdapter, getEnvInfo: () => Promise<VoyagerEnvInfo>): RawRequestFn;
+export { createEnvInfoLoader };

package/dist/core/request.d.ts

@@ -0,0 +1,5 @@
+import type { PlatformAdapter, RequestInput } from '../adapter/types';
+export interface VoyagerRequestFn {
+    <TResponse = unknown, TParams extends Record<string, unknown> = Record<string, unknown>>(options: RequestInput<TParams>): Promise<TResponse>;
+}
+export declare function createRequest(adapter: PlatformAdapter): VoyagerRequestFn;

package/dist/core/runtime.d.ts

@@ -0,0 +1,17 @@
+import type { SignResult, SignStatus } from '../types';
+export interface WhitelistCacheValue {
+    serviceCodes: string[];
+    expiresAt: number;
+}
+export interface WhitelistSnapshot extends WhitelistCacheValue {
+    lookup: {
+        [key: string]: true;
+    };
+}
+export interface VoyagerRuntimeState {
+    signStatus: SignStatus | null;
+    signStatusTask: Promise<SignResult> | null;
+    whitelist: WhitelistSnapshot | null;
+    whitelistTask: Promise<WhitelistSnapshot> | null;
+}
+export declare function getRuntimeState(): VoyagerRuntimeState;

package/dist/core/sign.d.ts

@@ -0,0 +1,9 @@
+import type { PlatformAdapter } from '../adapter/types';
+import type { SignResult, SignStatus } from '../types';
+export interface SignCacheValue {
+    status: SignStatus;
+    userId?: string;
+    updatedAt: number;
+}
+export declare function getSignStatus(adapter: PlatformAdapter): Promise<SignResult>;
+export declare function sign(adapter: PlatformAdapter): Promise<SignResult>;

package/dist/core/whitelist.d.ts

@@ -0,0 +1,4 @@
+import type { PlatformAdapter, StoragePort } from '../adapter/types';
+import { WhitelistSnapshot } from './runtime';
+export declare function loadWhitelist(adapter: PlatformAdapter, storage: StoragePort): Promise<WhitelistSnapshot>;
+export declare function checkWhitelist(serviceCode: string): boolean;

package/dist/monitor/index.d.ts

@@ -0,0 +1,12 @@
+import type { VoyagerPlatform } from '../types';
+import type { MonitoredRequest, MonitorChannel, MonitorFields } from './types';
+export { MonitorCode, MonitorMsg } from './utils/codes';
+export declare function resolveChannelFromClientName(clientName: string): MonitorChannel;
+export declare function configureMonitor(resolver: () => Promise<MonitorChannel>): void;
+export declare function log(fields: MonitorFields): void;
+export declare function startMonitor(): void;
+export declare function reportRequestSuccess(request: MonitoredRequest, result: unknown, startedAt: number): void;
+export declare function reportRequestFailure(request: MonitoredRequest, result: unknown, startedAt: number): void;
+export declare function reportWhitelistHit(request: MonitoredRequest, hit: boolean): void;
+export declare function reportWhitelistConfig(platform: VoyagerPlatform, success: boolean, error?: unknown): void;
+export declare function reportSignStatus(request: MonitoredRequest, signed: boolean): void;

package/dist/monitor/types.d.ts

@@ -0,0 +1,21 @@
+import type { VoyagerPlatform } from '../types';
+export type MonitorChannel = 'APLUS' | 'CN' | 'UNKNOWN';
+export interface MonitoredRequest {
+    platform: VoyagerPlatform;
+    serviceCode: string;
+}
+export interface MonitorFields {
+    code: string;
+    msg: string;
+    m1?: number;
+    c1?: string;
+    d1?: string;
+    d2?: string;
+    d3?: string;
+    d4?: string;
+    d5?: string;
+}
+export interface MonitorProvider {
+    report(fields: MonitorFields): void;
+    start(): void;
+}

package/dist/monitor/utils/codes.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 监控 code 与营销三方白牌 SDK 监控平台一一对应，共四个：
+ * - 1033 接口请求：业务 API 请求结果（成功/失败合并到同一 code，用 msg 区分）
+ * - 1034 白名单是否命中：serviceCode 是否通过白名单校验
+ * - 1035 白名单配置请求：远程白名单配置拉取结果
+ * - 1036 是否签约：调用前用户签约状态校验结果
+ */
+export declare enum MonitorCode {
+    REQUEST = "1033",
+    WHITELIST_HIT = "1034",
+    WHITELIST_CONFIG = "1035",
+    SIGN_STATUS = "1036"
+}
+/** 统一结果标识：所有 code 的 msg 只用 SUCCESS | FAILED 表示成功/失败 */
+export declare enum MonitorMsg {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED"
+}

package/dist/monitor/utils/marmot.d.ts

@@ -0,0 +1,3 @@
+import type { MonitorFields } from '../types';
+export declare function start(): void;
+export declare function report(fields: MonitorFields): void;

package/dist/monitor/utils/yuyan.d.ts

@@ -0,0 +1,3 @@
+import type { MonitorFields } from '../types';
+export declare function start(): void;
+export declare function report(fields: MonitorFields): void;

package/dist/mp/index.d.ts

@@ -0,0 +1,2 @@
+import type { VoyagerRequestOptions } from '../types';
+export declare function request<TResponse = unknown, TParams extends Record<string, unknown> = Record<string, unknown>>(options: VoyagerRequestOptions<TParams>): Promise<TResponse>;