@djvlc/runtime-core 1.0.1 → 1.0.3

package/dist/index.d.cts

@@ -8,8 +8,8 @@ export { ActionExecuteRequest, ActionExecuteResponse, ActionPolicy, ActionRef, A
 interface RuntimeOptions {
     /** 容器元素或选择器 */
     container: string | HTMLElement;
-    /** 页面 UID（pageId） */
-    pageUid: string;
+    /** 页面 ID（对应 contracts 中的 pageId） */
+    pageId: string;
     /** API 基础 URL */
     apiBaseUrl: string;
     /** CDN 基础 URL */
@@ -68,17 +68,21 @@ interface RuntimeState {
 }
 /**
  * 页面解析结果（Runtime 使用）
+ *
+ * @description
+ * 这是 Runtime 内部使用的类型，从 PageResolveResponse 和 PageSnapshotJson 转换而来。
+ * 使用 pageId 符合 contracts 定义。
  */
 interface PageResolveResult {
-    /** 页面 UID */
-    pageUid: string;
+    /** 页面 ID（对应 contracts 中的 pageId） */
+    pageId: string;
     /** 页面版本 ID */
     pageVersionId: string;
     /** 页面 JSON（PageSchema） */
     pageJson: _djvlc_contracts_types.PageSchema;
     /** 组件清单 */
     manifest: _djvlc_contracts_types.PageManifest;
-    /** 运行时配置 */
+    /** 运行时配置（从 OpsConfig 转换而来） */
     runtimeConfig?: {
         /** 被阻断的组件列表 */
         blockedComponents?: Array<{
@@ -852,7 +856,7 @@ declare class ActionBridge {
  * 运行时上下文
  */
 interface RuntimeContext {
-    pageUid: string;
+    pageId: string;
     pageVersionId: string;
     runtimeVersion: string;
     userId?: string;
@@ -1130,7 +1134,7 @@ declare class RenderError extends DjvlcRuntimeError {
 
 /**
  * 页面加载器
- * 负责从 API 解析页面配置
+ * 负责从 API 解析页面配置，严格按照 @djvlc/contracts-types 定义
  */
 
 /**
@@ -1139,8 +1143,10 @@ declare class RenderError extends DjvlcRuntimeError {
 interface PageLoaderOptions {
     /** API 基础 URL */
     apiBaseUrl: string;
+    /** 环境 */
+    env?: 'preview' | 'staging' | 'prod';
     /** 渠道 */
-    channel?: 'preview' | 'prod' | 'gray';
+    channel?: string;
     /** 认证 Token */
     authToken?: string;
     /** 预览 Token */
@@ -1158,6 +1164,7 @@ interface PageLoaderOptions {
 /**
  * 页面加载器
  * 负责调用 /page/resolve 接口获取页面数据
+ * 严格按照 contracts 中的 PageResolveResponse 定义
  */
 declare class PageLoader {
     private options;
@@ -1165,13 +1172,40 @@ declare class PageLoader {
     constructor(options: PageLoaderOptions);
     /**
      * 解析页面
-     * @param pageUid 页面 UID
+     * @param pageId 页面 ID（对应 contracts 中的 pageId）
      * @param params 额外参数
      */
-    resolve(pageUid: string, params?: {
+    resolve(pageId: string, params?: {
         uid?: string;
         deviceId?: string;
     }): Promise<PageResolveResult>;
+    /**
+     * 调用 Resolve API
+     * 严格按照 contracts 中的 PageResolveRequest 和 PageResolveResponse
+     */
+    private callResolveApi;
+    /**
+     * 从 CDN 加载 snapshot 和 manifest
+     */
+    private loadFromCdn;
+    /**
+     * 转换 PageSnapshotJson 为 PageResolveResult
+     */
+    private convertSnapshotToResult;
+    /**
+     * 转换 PageSnapshotPage 为 PageSchema
+     * 严格按照 contracts 定义进行转换
+     */
+    private convertSnapshotPageToPageSchema;
+    /**
+     * 转换 PageSnapshotManifest 为 PageManifest
+     * 注意：PageSnapshotManifest 是简化版本，缺少一些字段，需要从其他地方获取或使用默认值
+     */
+    private convertSnapshotManifestToPageManifest;
+    /**
+     * 验证 PageResolveResponse（严格按照 contracts 定义）
+     */
+    private isValidPageResolveResponse;
     /**
      * 预连接 API 服务器
      */
@@ -1179,12 +1213,10 @@ declare class PageLoader {
     /**
      * 清除缓存
      */
-    clearCache(pageUid?: string): void;
-    private buildResolveUrl;
+    clearCache(pageId?: string): void;
     private buildHeaders;
     private getCacheKey;
     private isCacheValid;
-    private isValidPageResolveResult;
     private log;
 }
 

package/dist/index.d.ts

@@ -8,8 +8,8 @@ export { ActionExecuteRequest, ActionExecuteResponse, ActionPolicy, ActionRef, A
 interface RuntimeOptions {
     /** 容器元素或选择器 */
     container: string | HTMLElement;
-    /** 页面 UID（pageId） */
-    pageUid: string;
+    /** 页面 ID（对应 contracts 中的 pageId） */
+    pageId: string;
     /** API 基础 URL */
     apiBaseUrl: string;
     /** CDN 基础 URL */
@@ -68,17 +68,21 @@ interface RuntimeState {
 }
 /**
  * 页面解析结果（Runtime 使用）
+ *
+ * @description
+ * 这是 Runtime 内部使用的类型，从 PageResolveResponse 和 PageSnapshotJson 转换而来。
+ * 使用 pageId 符合 contracts 定义。
  */
 interface PageResolveResult {
-    /** 页面 UID */
-    pageUid: string;
+    /** 页面 ID（对应 contracts 中的 pageId） */
+    pageId: string;
     /** 页面版本 ID */
     pageVersionId: string;
     /** 页面 JSON（PageSchema） */
     pageJson: _djvlc_contracts_types.PageSchema;
     /** 组件清单 */
     manifest: _djvlc_contracts_types.PageManifest;
-    /** 运行时配置 */
+    /** 运行时配置（从 OpsConfig 转换而来） */
     runtimeConfig?: {
         /** 被阻断的组件列表 */
         blockedComponents?: Array<{
@@ -852,7 +856,7 @@ declare class ActionBridge {
  * 运行时上下文
  */
 interface RuntimeContext {
-    pageUid: string;
+    pageId: string;
     pageVersionId: string;
     runtimeVersion: string;
     userId?: string;
@@ -1130,7 +1134,7 @@ declare class RenderError extends DjvlcRuntimeError {
 
 /**
  * 页面加载器
- * 负责从 API 解析页面配置
+ * 负责从 API 解析页面配置，严格按照 @djvlc/contracts-types 定义
  */
 
 /**
@@ -1139,8 +1143,10 @@ declare class RenderError extends DjvlcRuntimeError {
 interface PageLoaderOptions {
     /** API 基础 URL */
     apiBaseUrl: string;
+    /** 环境 */
+    env?: 'preview' | 'staging' | 'prod';
     /** 渠道 */
-    channel?: 'preview' | 'prod' | 'gray';
+    channel?: string;
     /** 认证 Token */
     authToken?: string;
     /** 预览 Token */
@@ -1158,6 +1164,7 @@ interface PageLoaderOptions {
 /**
  * 页面加载器
  * 负责调用 /page/resolve 接口获取页面数据
+ * 严格按照 contracts 中的 PageResolveResponse 定义
  */
 declare class PageLoader {
     private options;
@@ -1165,13 +1172,40 @@ declare class PageLoader {
     constructor(options: PageLoaderOptions);
     /**
      * 解析页面
-     * @param pageUid 页面 UID
+     * @param pageId 页面 ID（对应 contracts 中的 pageId）
      * @param params 额外参数
      */
-    resolve(pageUid: string, params?: {
+    resolve(pageId: string, params?: {
         uid?: string;
         deviceId?: string;
     }): Promise<PageResolveResult>;
+    /**
+     * 调用 Resolve API
+     * 严格按照 contracts 中的 PageResolveRequest 和 PageResolveResponse
+     */
+    private callResolveApi;
+    /**
+     * 从 CDN 加载 snapshot 和 manifest
+     */
+    private loadFromCdn;
+    /**
+     * 转换 PageSnapshotJson 为 PageResolveResult
+     */
+    private convertSnapshotToResult;
+    /**
+     * 转换 PageSnapshotPage 为 PageSchema
+     * 严格按照 contracts 定义进行转换
+     */
+    private convertSnapshotPageToPageSchema;
+    /**
+     * 转换 PageSnapshotManifest 为 PageManifest
+     * 注意：PageSnapshotManifest 是简化版本，缺少一些字段，需要从其他地方获取或使用默认值
+     */
+    private convertSnapshotManifestToPageManifest;
+    /**
+     * 验证 PageResolveResponse（严格按照 contracts 定义）
+     */
+    private isValidPageResolveResponse;
     /**
      * 预连接 API 服务器
      */
@@ -1179,12 +1213,10 @@ declare class PageLoader {
     /**
      * 清除缓存
      */
-    clearCache(pageUid?: string): void;
-    private buildResolveUrl;
+    clearCache(pageId?: string): void;
     private buildHeaders;
     private getCacheKey;
     private isCacheValid;
-    private isValidPageResolveResult;
     private log;
 }