@choiceform/os-client-core 3.4.4 → 3.4.8

package/index.d.ts

@@ -237,16 +237,14 @@ interface CFEnvUi {
   initNodeTemplate?(
     template: CFNodeTemplate,
     state: CFSurveyState,
-    loop: ICFLoop
   ): Promise<CFNodeTemplate>;
   /**
-   * 加载当前问卷所有使用到的额UI动态插件的方法
+   * 预加载当前问卷所有使用到的额UI动态插件的方法
    * 只有实现了动态模板机制的答题端需要配置这个方法
    * 如果不配置则什么都不做
-   * @param theme 主题
    * @param templates 模板列表
    */
-  loadUiTemplates?(theme: CFTheme, templates: string[]): Promise<void>;
+  loadUiEntryTemplates?(templates: string[]): Promise<void>;
 }
 
 /**
@@ -382,6 +380,13 @@ interface CFEnvNetWork {
    * 默认行为：什么也不做
    */
   closeSocket?(): void;
+  /**
+   * 推动socket消息的方法
+   * 默认行为：什么也不做
+   * @param message 消息名
+   * @param payload 附带的数据
+   */
+  pushSocket?(message:string, payload: object): void;
 }
 /**
  * 授权相关的配置，不同的运行平台有不同的账户系统，所以授权方式也不一样。
@@ -603,10 +608,6 @@ interface CFEnvOptions {
  * 服务配置信息
  */
 interface CFHostConfig {
-  /**
-   * 错误统计服务key
-   */
-  readonly sentryKey: string;
   /**
    * 操作记录接口地址
    */
@@ -739,6 +740,12 @@ interface CFSetupOptions {
    * @param message 错误内容
    */
   error(message: string): void;
+  /**
+   * 上传日志的方法，核心包运行时会生成一些有利于追踪已知错误的日志，希望能通过这个方法上传。
+   * 如果不设置则不会上传错误。而是在控制台打印出来
+   * @param message 
+   */
+  uploadLog?(message: string, level?: 'log' | 'error'):void;
   /**
    * 如果在单页模式中有很多题目，进行作答后点击下一题，其中某道题目的答案不满足要求，
    * 这时候可能这道题目不再滚动条所在的可见范围内，
@@ -799,9 +806,9 @@ interface CFSetupOptions {
    * 自定义中断回调方法
    * 当核心包中运行发生异常，或者需要去往外部程序时，会中断答题流程，同时触发调用这个方法
    * 客户端中可以配置该方法来在此时机做一些自定义的事情。
-   * 默认行为：什么也不做
+   * 默认行为：总是会在方法被调用的一秒内压制系统消息
    */
-  customAbort?(relax?: boolean): void;
+  customAbort?(): void;
   /**
    * 自定义的去往开始页面方法,只有使用web核心包是需要关注这个方法
    *
@@ -1053,19 +1060,19 @@ interface CFCore extends CFSetupOptions {
    * 多次调用,只有第一次会发送请求
    * 请求的数据会放到缓存中,后面几次获得的都是返回的缓存数据
    */
-  fetchStartState(): Promise<CFStartState>;
+  fetchStartState(): Promise<CFStartState | null>;
   /**
    * 获取答题也数据的方法
    * 多次调用,只有第一次会发送请求
    * 请求的数据会放到缓存中,后面几次获得的都是返回的缓存数据
    */
-  fetchSurveyState(): Promise<CFSurveyState>;
+  fetchSurveyState(): Promise<CFSurveyState | null>;
   /**
    * 获取奖励页面数据的方法
    * 多次调用,只有第一次会发送请求
    * 请求的数据会放到缓存中,后面几次获得的都是返回的缓存数据
    */
-  fetchRewardState(): Promise<CFRewardState>;
+  fetchRewardState(): Promise<CFRewardState | null>;
   /**
    * 获取主题
    */
@@ -3144,12 +3151,7 @@ type ShouldSetDefault<T> = Required<Pick<T, OptionalKeys<T>>>;
  * 动态UI组件类型
  */
 interface CFUiComponent {
-  /**
-   * 样式对象
-   */
-  style: {
-    toString(): string;
-  };
+
 }
 
 /**
@@ -5802,10 +5804,6 @@ interface CFQuestion extends ICFNode, ICFTypeInfo {
    * 前一道题
    */
   readonly prev: CFQuestion;
-  /**
-   * 后一道题
-   */
-  readonly next: CFQuestion;
   /**
    * 编号,该题的唯一代号
    * 如果有该属性,UI要渲染
@@ -6922,7 +6920,6 @@ interface ICFParsedSmallPayload {
   readonly varStyles: CFVarStyleGroup;
   readonly langs: ICFLang[];
   readonly language: string;
-  readonly langStore: any;
   readonly langTable: CFLangTableItem[];
   readonly langResume: boolean;
   readonly testCases: ICFTestCase[];
@@ -7680,6 +7677,10 @@ interface ICFStartMiniState extends ICFCustomLogo {
    * 挂载的自动提示数据
    */
   readonly autoCpltGroups: ICFAutoCpltGroup[];
+  /**
+   * 自带的多语言翻译包，可以不需要请求大翻译包就实现开始页面的语言切换。
+   */
+  readonly i18n?: any;
   /**
    * @ignore
    * 自定义logo的图片内容
@@ -7728,6 +7729,14 @@ interface ICFStartMiniState extends ICFCustomLogo {
  */
 interface CFStartState extends ICFTranMiniState, ICFStartMiniIntro, CFStateBase, ICFCustomLogo {
   readonly core?: CFCore;
+  /**
+   * 开始节点的类型
+   */
+  readonly type: NODE_TYPE;
+  /**
+   * 开始节点的名称
+   */
+  readonly nodeName:string;
   /**
    * 开始节点的布局设置
    */
@@ -8001,10 +8010,6 @@ interface CFSurveyState
    * @ignore
    */
   readonly refreshing: boolean;
-  /**
-   * @ignore
-   */
-  readonly needRegions: boolean;
   /**
    * @ignore
    */
@@ -9823,6 +9828,10 @@ interface ICFVarRaw {
   readonly name?: string;
   readonly uuid: string;
   readonly request?: ICFRequest;
+  /**
+   * 自带的语言包，为开始页面使用的时候可以自行翻译，而无需去加载翻译大包
+   */
+  readonly i18n?:any;
 }
 
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@choiceform/os-client-core",
-  "version": "3.4.4",
-  "description": "choice form survey client core",
+  "version": "3.4.8",
+  "description": "choiceform survey client core",
   "main": "./dist/core.js",
   "repository": "https://github.com/choice-form/os-client-core",
   "author": "fenyiwudian <laiq@cform.io>",
@@ -42,10 +42,11 @@
     "@babel/preset-env": "^7.10.4",
     "@babel/runtime": "^7.12.1",
     "@types/node-fetch": "^2.5.8",
+    "@types/phoenix": "^1.5.3",
     "@typescript-eslint/eslint-plugin": "^4.31.0",
     "@typescript-eslint/parser": "^4.31.0",
     "babel-loader": "^8.1.0",
-    "cf-auto": "^1.94.0",
+    "cf-auto": "^1.96.0",
     "chokidar": "^3.0.2",
     "clean-webpack-plugin": "^3.0.0",
     "copy-webpack-plugin": "^6.0.3",
@@ -60,7 +61,7 @@
     "messageformat": "^2.3.0",
     "node-fetch": "^2.6.1",
     "pako": "^1.0.10",
-    "phoenix": "^1.5.3",
+    "phoenix": "^1.6.2",
     "prettier": "^2.3.2",
     "typedoc": "^0.15.0",
     "ua-parser-js": "^0.7.20"