@djvlc/runtime-client-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,539 @@
+import { RuntimePorts, UserApiAdapter, PageRuntimePort, ResolvePageInput, ResolvePageResult as ResolvePageResult$1, ActionPort, ActionExecuteInput, ActionExecuteResult, DataPort, DataQueryInput, DataQueryResult, TrackPort, TrackInput, TenantPort, ResolveTenantInput, ResolveTenantResult, DjvlcRuntime } from '@djvlc/runtime-core';
+export { ActionExecuteInput, ActionExecuteResult, ActionPort, AuthInfo, CacheStatus, ClientInfo, DataPort, DataQueryInput, DataQueryResult, ExecuteActionParams, ExecuteQueryParams, ExecuteQueryResult, PagePort, PageRuntimePort, ResolvePageInput, ResolvePageMeta, ResolvePageParams, ResolveTenantInput, ResolveTenantResult, RuntimePorts, TenantPort, TraceInfo, TrackInput, TrackPayload, TrackPort, UserApiAdapter } from '@djvlc/runtime-core';
+import { UserClient } from '@djvlc/openapi-user-client';
+
+/**
+ * Trace ID 管理
+ *
+ * resolve/query/action/track 默认使用同一个 traceId（除非调用方显式覆盖）
+ */
+/**
+ * 生成 Trace ID（32 位 hex）
+ */
+declare function createTraceId(): string;
+/**
+ * 生成 Span ID（16 位 hex）
+ */
+declare function createSpanId(): string;
+/**
+ * 生成 traceparent 头（W3C Trace Context）
+ */
+declare function createTraceparent(traceId?: string, spanId?: string): string;
+/**
+ * Trace 上下文管理器
+ */
+declare class TraceContext {
+    private defaultTraceId;
+    constructor(initialTraceId?: string);
+    /**
+     * 获取当前 Trace ID
+     */
+    getTraceId(): string;
+    /**
+     * 设置新的 Trace ID
+     */
+    setTraceId(traceId: string): void;
+    /**
+     * 重置 Trace ID（生成新的）
+     */
+    resetTraceId(): string;
+    /**
+     * 使用指定 Trace ID 执行函数
+     */
+    withTrace<T>(traceId: string, fn: () => T): T;
+    /**
+     * 使用指定 Trace ID 执行异步函数
+     */
+    withTraceAsync<T>(traceId: string, fn: () => Promise<T>): Promise<T>;
+}
+
+/**
+ * Runtime Client SDK 创建入口
+ *
+ * 数据面 API 唯一入口：封装 openapi-user-client，实现 Ports，
+ * 提供 header/trace/错误归一/幂等/重试/prefetch
+ */
+
+/**
+ * SDK 配置选项
+ */
+interface RuntimeClientSdkOptions {
+    /** API 基础 URL */
+    baseUrl: string;
+    /** App ID */
+    appId: string;
+    /** Runtime 版本 */
+    runtimeVersion: string;
+    /** Client 版本 */
+    clientVersion: string;
+    /** 获取 Token 的函数（lazy getter） */
+    getToken?: () => string | undefined;
+    /** 获取 API Key 的函数（lazy getter） */
+    getApiKey?: () => string | undefined;
+    /** 额外请求头扩展 */
+    extraHeaders?: () => Record<string, string>;
+    /** 超时时间（毫秒） */
+    timeoutMs?: number;
+    /** 是否启用重试 */
+    retry?: boolean;
+    /** 最大重试次数 */
+    maxRetries?: number;
+    /** 重试延迟（毫秒） */
+    retryDelayMs?: number;
+    /** 是否启用调试 */
+    debug?: boolean;
+    /** 默认租户 ID */
+    defaultTenantId?: string;
+}
+/**
+ * Runtime Client SDK
+ */
+interface RuntimeClientSdk {
+    /** 获取 Runtime Ports */
+    getPorts(): RuntimePorts;
+    /** 获取 UserApiAdapter（向后兼容） */
+    getUserApiAdapter(): UserApiAdapter;
+    /** 获取 Trace Context */
+    getTraceContext(): TraceContext;
+    /** 创建新的 Trace ID */
+    createTraceId(): string;
+    /** 刷新埋点缓冲区 */
+    flushTrack(): Promise<void>;
+    /** 销毁 SDK */
+    destroy(): Promise<void>;
+}
+/**
+ * 创建 Runtime Client SDK
+ */
+declare function createRuntimeClientSdk(options: RuntimeClientSdkOptions): RuntimeClientSdk;
+
+/**
+ * Header 注入工具
+ *
+ * 每个请求都带以下 header：
+ * - X-App-Id
+ * - X-Trace-Id
+ * - Authorization: Bearer <token>（可选）
+ * - X-API-Key（可选）
+ * - X-Runtime-Version
+ * - X-Client-Version
+ */
+interface HeadersConfig {
+    /** App ID */
+    appId: string;
+    /** Runtime 版本 */
+    runtimeVersion: string;
+    /** Client 版本 */
+    clientVersion: string;
+    /** 获取 Token 的函数（lazy getter） */
+    getToken?: () => string | undefined;
+    /** 获取 API Key 的函数（lazy getter） */
+    getApiKey?: () => string | undefined;
+    /** 额外请求头扩展 */
+    extraHeaders?: () => Record<string, string>;
+}
+/**
+ * 创建请求头生成器
+ */
+declare function createHeadersBuilder(config: HeadersConfig): (traceId?: string) => Record<string, string>;
+type HeadersBuilder = ReturnType<typeof createHeadersBuilder>;
+
+/**
+ * 重试策略
+ *
+ * - 自动重试仅限幂等读请求（resolve/query），action 默认不重试
+ * - 重试 2 次以内，带 backoff（例如 200ms/400ms）
+ * - 支持配置：timeoutMs、retry、retryDelay
+ */
+interface RetryConfig {
+    /** 是否启用重试 */
+    enabled: boolean;
+    /** 最大重试次数 */
+    maxRetries: number;
+    /** 初始重试延迟（毫秒） */
+    initialDelayMs: number;
+    /** 延迟倍数（指数退避） */
+    backoffMultiplier: number;
+    /** 最大延迟（毫秒） */
+    maxDelayMs: number;
+    /** 可重试的 HTTP 状态码 */
+    retryableStatusCodes: number[];
+}
+declare const DEFAULT_RETRY_CONFIG: RetryConfig;
+/**
+ * 计算重试延迟
+ */
+declare function calculateRetryDelay(attempt: number, config: RetryConfig): number;
+/**
+ * 判断是否应该重试
+ */
+declare function shouldRetry(error: unknown, attempt: number, config: RetryConfig): boolean;
+/**
+ * 延迟函数
+ */
+declare function delay(ms: number): Promise<void>;
+/**
+ * 带重试的执行器
+ */
+declare function withRetry<T>(fn: () => Promise<T>, config?: Partial<RetryConfig>): Promise<T>;
+
+/**
+ * PageRuntimePort 适配器
+ *
+ * 实现 @djvlc/runtime-core 的 PageRuntimePort 接口
+ * 封装 @djvlc/openapi-user-client 的 pages API
+ */
+
+interface PageRuntimeAdapterOptions {
+    /** User Client */
+    client: UserClient;
+    /** Headers Builder */
+    headersBuilder: HeadersBuilder;
+    /** Trace Context */
+    traceContext: TraceContext;
+    /** 重试配置 */
+    retryConfig?: Partial<RetryConfig>;
+    /** 默认超时（毫秒） */
+    defaultTimeoutMs?: number;
+}
+type ResolvePageResult = ResolvePageResult$1;
+/**
+ * PageRuntimePort 适配器实现
+ */
+declare class PageRuntimeAdapter implements PageRuntimePort {
+    private client;
+    private headersBuilder;
+    private traceContext;
+    private retryConfig;
+    private defaultTimeoutMs;
+    constructor(options: PageRuntimeAdapterOptions);
+    resolvePage(input: ResolvePageInput): Promise<ResolvePageResult$1>;
+    /**
+     * 转换 snapshot 到 PageSchema
+     */
+    private convertSnapshotToPageSchema;
+}
+/**
+ * 创建 PageRuntimePort 适配器
+ */
+declare function createPageRuntimeAdapter(options: PageRuntimeAdapterOptions): PageRuntimePort;
+
+/**
+ * ActionPort 适配器
+ *
+ * 实现 @djvlc/runtime-core 的 ActionPort 接口
+ * 封装 @djvlc/openapi-user-client 的 actions API
+ */
+
+interface ActionAdapterOptions {
+    /** User Client */
+    client: UserClient;
+    /** Headers Builder */
+    headersBuilder: HeadersBuilder;
+    /** Trace Context */
+    traceContext: TraceContext;
+    /** 默认超时（毫秒） */
+    defaultTimeoutMs?: number;
+}
+/**
+ * ActionPort 适配器实现
+ *
+ * 注意：Action 默认不重试（非幂等操作）
+ */
+declare class ActionAdapter implements ActionPort {
+    private client;
+    private traceContext;
+    private defaultTimeoutMs;
+    constructor(options: ActionAdapterOptions);
+    executeAction<T = unknown>(input: ActionExecuteInput): Promise<ActionExecuteResult<T>>;
+}
+/**
+ * 创建 ActionPort 适配器
+ */
+declare function createActionAdapter(options: ActionAdapterOptions): ActionPort;
+
+/**
+ * DataPort 适配器
+ *
+ * 实现 @djvlc/runtime-core 的 DataPort 接口
+ * 封装 @djvlc/openapi-user-client 的 queries API
+ */
+
+interface DataAdapterOptions {
+    /** User Client */
+    client: UserClient;
+    /** Headers Builder */
+    headersBuilder: HeadersBuilder;
+    /** Trace Context */
+    traceContext: TraceContext;
+    /** 重试配置 */
+    retryConfig?: Partial<RetryConfig>;
+    /** 默认超时（毫秒） */
+    defaultTimeoutMs?: number;
+}
+/**
+ * DataPort 适配器实现
+ */
+declare class DataAdapter implements DataPort {
+    private client;
+    private traceContext;
+    private retryConfig;
+    private defaultTimeoutMs;
+    constructor(options: DataAdapterOptions);
+    query<T = unknown>(input: DataQueryInput): Promise<DataQueryResult<T>>;
+}
+/**
+ * 创建 DataPort 适配器
+ */
+declare function createDataAdapter(options: DataAdapterOptions): DataPort;
+
+/**
+ * TrackPort 适配器
+ *
+ * 实现 @djvlc/runtime-core 的 TrackPort 接口
+ * 封装 @djvlc/openapi-user-client 的 track API
+ */
+
+interface TrackAdapterOptions {
+    /** User Client */
+    client: UserClient;
+    /** Headers Builder */
+    headersBuilder: HeadersBuilder;
+    /** Trace Context */
+    traceContext: TraceContext;
+    /** 批量上报阈值 */
+    batchSize?: number;
+    /** 批量上报间隔（毫秒） */
+    flushInterval?: number;
+}
+/**
+ * TrackPort 适配器实现
+ */
+declare class TrackAdapter implements TrackPort {
+    private client;
+    private batchSize;
+    private flushInterval;
+    private eventBuffer;
+    private flushTimer;
+    constructor(options: TrackAdapterOptions);
+    track(input: TrackInput): Promise<void>;
+    /**
+     * 立即刷新缓冲区
+     */
+    flush(_traceId?: string): Promise<void>;
+    /**
+     * 调度刷新
+     */
+    private scheduleFlush;
+    /**
+     * 销毁（刷新剩余事件）
+     */
+    destroy(): Promise<void>;
+}
+/**
+ * 创建 TrackPort 适配器
+ */
+declare function createTrackAdapter(options: TrackAdapterOptions): TrackPort & {
+    flush: () => Promise<void>;
+    destroy: () => Promise<void>;
+};
+
+/**
+ * TenantPort 适配器
+ *
+ * 实现 @djvlc/runtime-core 的 TenantPort 接口
+ * 目前为简单实现，实际可根据需要扩展
+ */
+
+interface TenantAdapterOptions {
+    /** 默认租户 ID */
+    defaultTenantId?: string;
+    /** Headers Builder */
+    headersBuilder: HeadersBuilder;
+    /** Trace Context */
+    traceContext: TraceContext;
+    /** 租户配置映射 */
+    tenantConfigs?: Map<string, unknown>;
+}
+/**
+ * TenantPort 适配器实现
+ *
+ * 简单实现：根据 host 或 path 解析租户
+ */
+declare class TenantAdapter implements TenantPort {
+    private defaultTenantId;
+    private tenantConfigs;
+    constructor(options: TenantAdapterOptions);
+    resolveTenant(input: ResolveTenantInput): Promise<ResolveTenantResult>;
+}
+/**
+ * 创建 TenantPort 适配器
+ */
+declare function createTenantAdapter(options: TenantAdapterOptions): TenantPort;
+
+/**
+ * 幂等键策略
+ *
+ * 对 claim/signin/form_submit 等高频重复点击动作：
+ * - 如果调用方没传 idempotencyKey，SDK 自动生成
+ * - 必须"稳定"：同一用户/页面版本/组件/动作 + 同 payload → 生成同 key
+ * - key 不要太长：sha256 后截断 32~48 chars
+ */
+/**
+ * 检查是否需要自动生成幂等键
+ */
+declare function needsIdempotencyKey(actionType: string): boolean;
+interface IdempotencyKeyInput {
+    /** 动作类型 */
+    actionType: string;
+    /** 动作参数 */
+    payload: unknown;
+    /** 上下文 */
+    context: {
+        pageId: string;
+        pageVersionId: string;
+        componentId?: string;
+        uid?: string;
+    };
+}
+/**
+ * 生成稳定的幂等键
+ *
+ * 同一用户/页面版本/组件/动作 + 同 payload → 生成同 key
+ */
+declare function generateIdempotencyKey(input: IdempotencyKeyInput): Promise<string>;
+/**
+ * 同步版本（使用简单哈希，用于不支持 async 的场景）
+ */
+declare function generateIdempotencyKeySync(input: IdempotencyKeyInput): string;
+
+/**
+ * 超时和取消处理
+ *
+ * resolve/query 支持 timeoutMs + AbortSignal
+ */
+/**
+ * 创建超时 AbortController
+ */
+declare function createTimeoutController(timeoutMs?: number, signal?: AbortSignal): {
+    controller: AbortController;
+    cleanup: () => void;
+};
+/**
+ * 带超时的 Promise 包装
+ */
+declare function withTimeout<T>(promise: Promise<T>, timeoutMs: number, signal?: AbortSignal): Promise<T>;
+/**
+ * 检查是否是超时错误
+ */
+declare function isTimeoutError(error: unknown): boolean;
+/**
+ * 检查是否是取消错误
+ */
+declare function isAbortError(error: unknown): boolean;
+
+/**
+ * 错误归一
+ *
+ * 无论网络/超时/abort/http/业务错误，统一成 RuntimeClientError
+ */
+/**
+ * 错误类型
+ */
+type RuntimeClientErrorKind = 'Network' | 'Timeout' | 'Abort' | 'Http' | 'Biz' | 'Validation' | 'Unknown';
+/**
+ * 统一错误类型
+ */
+interface RuntimeClientError {
+    name: 'RuntimeClientError';
+    kind: RuntimeClientErrorKind;
+    message: string;
+    code?: string;
+    httpStatus?: number;
+    traceId?: string;
+    details?: unknown;
+    cause?: unknown;
+}
+/**
+ * 创建 RuntimeClientError
+ */
+declare function createRuntimeClientError(kind: RuntimeClientErrorKind, message: string, options?: {
+    code?: string;
+    httpStatus?: number;
+    traceId?: string;
+    details?: unknown;
+    cause?: unknown;
+}): RuntimeClientError;
+/**
+ * 判断是否为 RuntimeClientError
+ */
+declare function isRuntimeClientError(error: unknown): error is RuntimeClientError;
+/**
+ * 将任意错误转换为 RuntimeClientError
+ */
+declare function normalizeError(error: unknown, traceId?: string): RuntimeClientError;
+/**
+ * 创建 HTTP 错误
+ */
+declare function createHttpError(status: number, message: string, traceId?: string, details?: unknown): RuntimeClientError;
+/**
+ * 创建业务错误
+ */
+declare function createBizError(code: string, message: string, traceId?: string, details?: unknown): RuntimeClientError;
+/**
+ * 创建校验错误
+ */
+declare function createValidationError(message: string, traceId?: string, details?: unknown): RuntimeClientError;
+
+/**
+ * prefetchData 注入 helper
+ *
+ * 如果 resolvePage 返回 prefetchedData，提供 helper 注入到 runtime
+ */
+
+/**
+ * 将预取数据注入到 runtime 的 dataStore（query 缓存）
+ */
+declare function applyPrefetch(runtime: DjvlcRuntime, resolved: ResolvePageResult): void;
+/**
+ * 创建初始 runtime 状态（包含预取数据）
+ *
+ * 用于 SSR 或 hydration 场景
+ */
+declare function createInitialRuntimeState(resolved: ResolvePageResult): {
+    pageVersionId: string;
+    prefetchedData: Record<string, unknown>;
+};
+/**
+ * 从预取数据中获取特定查询的缓存
+ */
+declare function getPrefetchedQueryData<T = unknown>(resolved: ResolvePageResult, queryId: string): T | undefined;
+/**
+ * 检查是否有预取数据
+ */
+declare function hasPrefetchedData(resolved: ResolvePageResult): boolean;
+
+/**
+ * User Client 封装
+ *
+ * 封装 @djvlc/openapi-user-client 创建 + 默认中间件
+ */
+
+interface CreateWrappedClientOptions {
+    /** API 基础 URL */
+    baseUrl: string;
+    /** 超时时间（毫秒） */
+    timeoutMs?: number;
+    /** 请求头构建器 */
+    headersBuilder: HeadersBuilder;
+    /** 是否启用调试 */
+    debug?: boolean;
+}
+/**
+ * 创建封装的 User Client
+ *
+ * 自动注入请求头、错误处理等中间件
+ */
+declare function createWrappedUserClient(options: CreateWrappedClientOptions): UserClient;
+
+export { ActionAdapter, type ActionAdapterOptions, type CreateWrappedClientOptions, DEFAULT_RETRY_CONFIG, DataAdapter, type DataAdapterOptions, type HeadersBuilder, type HeadersConfig, type IdempotencyKeyInput, PageRuntimeAdapter, type PageRuntimeAdapterOptions, type ResolvePageResult, type RetryConfig, type RuntimeClientError, type RuntimeClientErrorKind, type RuntimeClientSdk, type RuntimeClientSdkOptions, TenantAdapter, type TenantAdapterOptions, TraceContext, TrackAdapter, type TrackAdapterOptions, applyPrefetch, calculateRetryDelay, createActionAdapter, createBizError, createDataAdapter, createHeadersBuilder, createHttpError, createInitialRuntimeState, createPageRuntimeAdapter, createRuntimeClientError, createRuntimeClientSdk, createSpanId, createTenantAdapter, createTimeoutController, createTraceId, createTraceparent, createTrackAdapter, createValidationError, createWrappedUserClient, delay, generateIdempotencyKey, generateIdempotencyKeySync, getPrefetchedQueryData, hasPrefetchedData, isAbortError, isRuntimeClientError, isTimeoutError, needsIdempotencyKey, normalizeError, shouldRetry, withRetry, withTimeout };

package/dist/index.js

@@ -0,0 +1 @@
+import{createUserClient as e}from"@djvlc/openapi-user-client";function t(e){return function(t){const r={"Content-Type":"application/json","X-App-Id":e.appId,"X-Runtime-Version":e.runtimeVersion,"X-Client-Version":e.clientVersion};if(t&&(r["X-Trace-Id"]=t),e.getToken){const t=e.getToken();t&&(r.Authorization=`Bearer ${t}`)}if(e.getApiKey){const t=e.getApiKey();t&&(r["X-API-Key"]=t)}if(e.extraHeaders){const t=e.extraHeaders();Object.assign(r,t)}return r}}function r(){return e=32,Array.from({length:e},()=>Math.floor(16*Math.random()).toString(16)).join("");var e}function n(){return e=16,Array.from({length:e},()=>Math.floor(16*Math.random()).toString(16)).join("");var e}function a(e,t){return`00-${e||r()}-${t||n()}-01`}var s=class{constructor(e){this.defaultTraceId=e||r()}getTraceId(){return this.defaultTraceId}setTraceId(e){this.defaultTraceId=e}resetTraceId(){return this.defaultTraceId=r(),this.defaultTraceId}withTrace(e,t){const r=this.defaultTraceId;this.defaultTraceId=e;try{return t()}finally{this.defaultTraceId=r}}async withTraceAsync(e,t){const r=this.defaultTraceId;this.defaultTraceId=e;try{return await t()}finally{this.defaultTraceId=r}}},o={enabled:!0,maxRetries:2,initialDelayMs:200,backoffMultiplier:2,maxDelayMs:2e3,retryableStatusCodes:[408,429,500,502,503,504]};function i(e,t){const r=t.initialDelayMs*Math.pow(t.backoffMultiplier,e),n=.1*r*(2*Math.random()-1);return Math.min(r+n,t.maxDelayMs)}function c(e,t,r){if(!r.enabled||t>=r.maxRetries)return!1;if(e instanceof TypeError)return!0;if(e instanceof Error&&"status"in e){const t=e.status;return r.retryableStatusCodes.includes(t)}return!(!e||"object"!=typeof e||!("httpStatus"in e)||"number"!=typeof e.httpStatus)&&r.retryableStatusCodes.includes(e.httpStatus)}function u(e){return new Promise(t=>setTimeout(t,e))}async function d(e,t={}){const r={...o,...t};let n;for(let t=0;t<=r.maxRetries;t++)try{return await e()}catch(e){if(n=e,!c(e,t,r))throw e;if(t<r.maxRetries){const e=i(t,r);await u(e)}}throw n}function l(e,t){const r=new AbortController;let n;return e&&e>0&&(n=setTimeout(()=>{r.abort(new Error(`Request timeout after ${e}ms`))},e)),t&&(t.aborted?r.abort(t.reason):t.addEventListener("abort",()=>{r.abort(t.reason)})),{controller:r,cleanup:()=>{n&&clearTimeout(n)}}}async function f(e,t,r){const{controller:n,cleanup:a}=l(t,r);try{return await Promise.race([e,new Promise((e,t)=>{n.signal.addEventListener("abort",()=>{t(n.signal.reason||new Error("Request aborted"))})})])}finally{a()}}function h(e){return e instanceof Error&&(e.message.includes("timeout")||e.message.includes("Timeout")||"TimeoutError"===e.name||"AbortError"===e.name)}function p(e){return e instanceof Error?"AbortError"===e.name||e.message.includes("aborted"):e instanceof DOMException&&"AbortError"===e.name}function m(e,t,r){return{name:"RuntimeClientError",kind:e,message:t,code:r?.code,httpStatus:r?.httpStatus,traceId:r?.traceId,details:r?.details,cause:r?.cause}}function g(e){return null!==e&&"object"==typeof e&&"name"in e&&"RuntimeClientError"===e.name}function y(e,t){if(g(e))return{...e,traceId:e.traceId||t};if(e instanceof TypeError&&e.message.includes("fetch"))return m("Network","Network request failed",{traceId:t,cause:e});if(e instanceof DOMException&&"AbortError"===e.name)return m("Abort","Request aborted",{traceId:t,cause:e});if(e instanceof Error){if(e.message.includes("timeout")||e.message.includes("Timeout"))return m("Timeout",e.message,{traceId:t,cause:e});if(e.message.includes("abort")||"AbortError"===e.name)return m("Abort",e.message,{traceId:t,cause:e})}if(e&&"object"==typeof e&&"status"in e&&"number"==typeof e.status){const r=e.status;return m("Http",e instanceof Error?e.message:`HTTP error ${r}`,{httpStatus:r,traceId:t,cause:e})}return e instanceof Error?m("Unknown",e.message,{traceId:t,cause:e}):m("Unknown",String(e),{traceId:t,cause:e})}function I(e,t,r,n){return m("Http",t,{httpStatus:e,traceId:r,details:n})}function T(e,t,r,n){return m("Biz",t,{code:e,traceId:r,details:n})}function x(e,t,r){return m("Validation",e,{code:"VALIDATION_ERROR",traceId:t,details:r})}var v=class{constructor(e){this.client=e.client,this.headersBuilder=e.headersBuilder,this.traceContext=e.traceContext,this.retryConfig=e.retryConfig||{},this.defaultTimeoutMs=e.defaultTimeoutMs||3e4}async resolvePage(e){const t=e.trace?.traceId||this.traceContext.getTraceId(),r=e.timeoutMs||this.defaultTimeoutMs,{controller:n,cleanup:a}=l(r,e.signal);try{const r=await d(async()=>await this.client.pages.resolvePage({pageId:e.pageId,env:"prod",uid:e.uid,deviceId:e.client?.deviceId,channel:void 0},{signal:n.signal}),this.retryConfig);if(!r.data||"object"!=typeof r.data)throw x("Invalid page resolve response",t,{response:r});const a=r.data,s=await fetch(a.snapshotUrl,{signal:n.signal,headers:this.headersBuilder(t)});if(!s.ok)throw y({status:s.status},t);const o=await s.json(),i=this.convertSnapshotToPageSchema(o.page);return{pageVersionId:a.resolvedVersionId,page:i,prefetchedData:o.prefetchedData,meta:{cache:"MISS",resolvedAt:Date.now(),etag:a.etag,cacheTtlSeconds:a.cacheTtlSeconds}}}catch(e){throw y(e,t)}finally{a()}}convertSnapshotToPageSchema(e){return e}};function w(e){return new v(e)}var b=new Set(["claim","signin","form_submit","lottery","checkin","reserve","subscribe"]);function M(e){return b.has(e)}function C(e){let t=2166136261;for(let r=0;r<e.length;r++)t^=e.charCodeAt(r),t=Math.imul(t,16777619);return(t>>>0).toString(16).padStart(8,"0")}async function k(e){const t=[e.actionType,e.context.pageId,e.context.pageVersionId,e.context.componentId||"",e.context.uid||"",JSON.stringify(e.payload,Object.keys(e.payload||{}).sort())].join("|");return(await async function(e){if("undefined"!=typeof crypto&&crypto.subtle){const t=(new TextEncoder).encode(e),r=await crypto.subtle.digest("SHA-256",t);return Array.from(new Uint8Array(r)).map(e=>e.toString(16).padStart(2,"0")).join("")}return C(e)+C(e.split("").reverse().join(""))}(t)).substring(0,32)}function A(e){const t=[e.actionType,e.context.pageId,e.context.pageVersionId,e.context.componentId||"",e.context.uid||"",JSON.stringify(e.payload,Object.keys(e.payload||{}).sort())].join("|"),r=C(t),n=C(t.split("").reverse().join(""));return r+n+C(t+r)+C(n+t)}var V=class{constructor(e){this.client=e.client,this.traceContext=e.traceContext,this.defaultTimeoutMs=e.defaultTimeoutMs||3e4}async executeAction(e){const t=e.trace?.traceId||this.traceContext.getTraceId(),r=e.timeoutMs||this.defaultTimeoutMs;let n=e.idempotencyKey;!n&&M(e.actionType)&&(n=A({actionType:e.actionType,payload:e.payload,context:{pageId:e.context.pageId,pageVersionId:e.context.pageVersionId,componentId:e.context.componentId,uid:e.context.uid}}));const{controller:a,cleanup:s}=l(r,e.signal);try{const t=await this.client.actions.executeAction({executeActionRequest:{actionType:e.actionType,params:e.payload,context:{pageVersionId:e.context.pageVersionId,deviceId:e.context.deviceId,channel:void 0,extra:{uid:e.context.uid,componentId:e.context.componentId}},idempotencyKey:n}},{signal:a.signal});return t.success?{ok:!0,data:t.data?.result}:{ok:!1,error:{code:t.data?.errorCode||"BIZ_ERROR",message:t.data?.errorMessage||"Action failed",details:t.data}}}catch(e){const r=y(e,t);return{ok:!1,error:{code:r.code||r.kind,message:r.message,details:r.details}}}finally{s()}}};function S(e){return new V(e)}var R=class{constructor(e){this.client=e.client,this.traceContext=e.traceContext,this.retryConfig=e.retryConfig||{},this.defaultTimeoutMs=e.defaultTimeoutMs||3e4}async query(e){const t=e.trace?.traceId||this.traceContext.getTraceId(),r=e.timeoutMs||this.defaultTimeoutMs,{controller:n,cleanup:a}=l(r,e.signal);try{const t=await d(async()=>await this.client.queries.queryData({queryDataRequest:{queryVersionId:e.queryVersionId,params:e.params||{},context:{pageVersionId:e.context.pageVersionId}}},{signal:n.signal}),this.retryConfig);return t.success?{ok:!0,data:t.data}:{ok:!1,error:{code:"QUERY_ERROR",message:t.errorMessage||t.message||"Query failed",details:t.data}}}catch(e){const r=y(e,t);return{ok:!1,error:{code:r.code||r.kind,message:r.message,details:r.details}}}finally{a()}}};function E(e){return new R(e)}var D=class{constructor(e){this.eventBuffer=[],this.flushTimer=null,this.client=e.client,this.batchSize=e.batchSize||10,this.flushInterval=e.flushInterval||5e3}async track(e){for(const t of e.events)this.eventBuffer.push({event:t,context:e.context});this.eventBuffer.length>=this.batchSize?await this.flush():this.scheduleFlush()}async flush(e){if(0===this.eventBuffer.length)return;const t=[...this.eventBuffer];this.eventBuffer=[],this.flushTimer&&(clearTimeout(this.flushTimer),this.flushTimer=null);for(const{event:e,context:r}of t)try{await this.client.track.track({trackRequest:{eventName:e.eventName,eventType:e.eventType,properties:e.properties,timestamp:e.timestamp?new Date(e.timestamp):void 0,context:{pageVersionId:r.pageVersionId,sessionId:r.sessionId}}})}catch(e){}}scheduleFlush(){this.flushTimer||(this.flushTimer=setTimeout(()=>{this.flushTimer=null,this.flush().catch(()=>{})},this.flushInterval))}async destroy(){await this.flush()}};function q(e){return new D(e)}var j=class{constructor(e){this.defaultTenantId=e.defaultTenantId||"default",this.tenantConfigs=e.tenantConfigs||new Map}async resolveTenant(e){let t=this.defaultTenantId;if(e.path){const r=e.path.match(/^\/t\/([^/]+)/);r&&(t=r[1])}if(e.host){const r=e.host.match(/^([^.]+)\./);r&&"www"!==r[1]&&(t=r[1])}return{tenantId:t,config:this.tenantConfigs.get(t)||{}}}};function B(e){return new j(e)}function P(n){const a=t({appId:n.appId,runtimeVersion:n.runtimeVersion,clientVersion:n.clientVersion,getToken:n.getToken,getApiKey:n.getApiKey,extraHeaders:n.extraHeaders}),o=new s,i=e({baseUrl:n.baseUrl,timeout:n.timeoutMs||3e4,debug:n.debug,headers:a(o.getTraceId()),enableRetry:!1}),c=n.retry?{enabled:!0,maxRetries:n.maxRetries??2,initialDelayMs:n.retryDelayMs??200}:{enabled:!1},u=new v({client:i,headersBuilder:a,traceContext:o,retryConfig:c,defaultTimeoutMs:n.timeoutMs}),d=new V({client:i,headersBuilder:a,traceContext:o,defaultTimeoutMs:n.timeoutMs}),l=new R({client:i,headersBuilder:a,traceContext:o,retryConfig:c,defaultTimeoutMs:n.timeoutMs}),f=new D({client:i,headersBuilder:a,traceContext:o}),h={tenant:new j({headersBuilder:a,traceContext:o,defaultTenantId:n.defaultTenantId}),page:u,data:l,action:d,track:f},p=function(e){return{resolvePage:async t=>(await e.pages.resolvePage({pageId:t.pageId,env:t.env,uid:t.uid,deviceId:t.deviceId,channel:t.channel})).data,async executeAction(t){const r=await e.actions.executeAction({executeActionRequest:{actionType:t.actionType,params:t.params,context:{pageVersionId:t.context.pageVersionId,deviceId:t.context.deviceId,channel:t.context.channel,extra:{uid:t.context.uid,appId:t.context.appId}},idempotencyKey:t.idempotencyKey}}),n=r.data;return{success:r.success,data:n?.result,errorCode:n?.errorCode,errorMessage:n?.errorMessage}},async executeQuery(t){const r=await e.queries.queryData({queryDataRequest:{queryVersionId:t.queryVersionId,params:t.params??{},context:{pageVersionId:t.context.pageVersionId}}});return{success:r.success,data:r.data??void 0,message:r.message,errorMessage:r.errorMessage}},track(t){e.track.track({trackRequest:{eventName:t.eventName,eventType:t.type??"custom",properties:t.params,timestamp:null!=t.timestamp?new Date(t.timestamp):void 0,context:{pageVersionId:t.context.pageVersionId,sessionId:t.context.userId}}}).catch(()=>{})}}}(i);return{getPorts:()=>h,getUserApiAdapter:()=>p,getTraceContext:()=>o,createTraceId:()=>r(),flushTrack:()=>f.flush(),destroy:async()=>{await f.destroy()}}}function O(e,t){t.prefetchedData&&e.setPrefetchedData(t.prefetchedData)}function U(e){return{pageVersionId:e.pageVersionId,prefetchedData:e.prefetchedData||{}}}function K(e,t){return e.prefetchedData?.[t]}function N(e){return void 0!==e.prefetchedData&&Object.keys(e.prefetchedData).length>0}function H(t){const r={baseUrl:t.baseUrl,timeout:t.timeoutMs||3e4,debug:t.debug,headers:t.headersBuilder(),enableRetry:!1};return e(r)}export{V as ActionAdapter,o as DEFAULT_RETRY_CONFIG,R as DataAdapter,v as PageRuntimeAdapter,j as TenantAdapter,s as TraceContext,D as TrackAdapter,O as applyPrefetch,i as calculateRetryDelay,S as createActionAdapter,T as createBizError,E as createDataAdapter,t as createHeadersBuilder,I as createHttpError,U as createInitialRuntimeState,w as createPageRuntimeAdapter,m as createRuntimeClientError,P as createRuntimeClientSdk,n as createSpanId,B as createTenantAdapter,l as createTimeoutController,r as createTraceId,a as createTraceparent,q as createTrackAdapter,x as createValidationError,H as createWrappedUserClient,u as delay,k as generateIdempotencyKey,A as generateIdempotencyKeySync,K as getPrefetchedQueryData,N as hasPrefetchedData,p as isAbortError,g as isRuntimeClientError,h as isTimeoutError,M as needsIdempotencyKey,y as normalizeError,c as shouldRetry,d as withRetry,f as withTimeout};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@djvlc/runtime-client-sdk",
+  "version": "1.0.0",
+  "description": "DJV 低代码平台运行时 Client SDK - 数据面 API 唯一入口",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist"
+  },
+  "dependencies": {
+    "@djvlc/runtime-core": "1.1.2"
+  },
+  "peerDependenciesMeta": {
+    "@djvlc/contracts-validators": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "eslint": "^8.55.0",
+    "rimraf": "^5.0.5",
+    "terser": "^5.44.1",
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
+  },
+  "keywords": [
+    "lowcode",
+    "runtime",
+    "sdk",
+    "client",
+    "djv"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT"
+}