@choiceform/os-client-core 3.6.13 → 3.6.16

package/index.d.ts

@@ -204,14 +204,14 @@ interface CCEnvUi {
    * 如果不配置则什么都不做
    * @param template 原始模板信息
    */
-  loadNodeComponent?(template: CFPDNodeTemplate): Promise<CCComponent>;
+  loadNodeComponent?(template: CFPDNodeTemplate, retry: boolean): Promise<CCComponent>;
   /**
    * 预加载当前问卷所有使用到的额UI动态插件的方法
    * 只有实现了动态模板机制的答题端需要配置这个方法
    * 如果不配置则什么都不做
    * @param templates 模板列表
    */
-  loadUiEntryTemplates?(templates: string[]): Promise<void>;
+  loadUiEntryTemplates?(templates: string[], retry: boolean): Promise<void>;
   /**
    * 插入预设富文本样式表
    * @param style 样式：css字符形式
@@ -312,8 +312,9 @@ interface CCEnvNetWork {
    * 该方法必须实现，不实现则无法运行伪造接口
    * @param url 文件地址
    * @param options 附加参数
+   * @param retry 加载失败后是否重试
    */
-  loadFakeFile(url: string, options: SignStrStr): Promise<void>;
+  loadFakeFile(url: string, options: SignStrStr, retry: boolean): Promise<void>;
   /**
    * 获取伪造接口应该依附的对象
    * [[CFEnvNetWork.loadFakeFile]]成功将伪造接口加载成功后会粘附到一个对象上。
@@ -332,8 +333,9 @@ interface CCEnvNetWork {
    * 发起网络请求的方法，不同的平台请求网络资源的方式不同，需要通过该方法配置。
    * @param url 地址
    * @param options 请求参数
+   * @param retry 请求失败后是否重试
    */
-  request(url: string, options: CCApiReqConfig): Promise<CCApiReqResult>;
+  request(url: string, options: CCApiReqConfig, retry: boolean): Promise<CCApiReqResult>;
   /**
    * 通服务器建立socket连接的的方法，连通后使得客户端可以即时通信接受服务器的一些推送消息：如配额满
    * 各个运行平台socket连接方式不同，配置到这个方法中。
@@ -623,6 +625,11 @@ interface CCHostConfig {
   qStaticHost?: string;
 }
 
+interface CCLoadRetry {
+  status: 'wait-retry' | 'retrying' | '';
+  onRetry?: Function;
+}
+
 /**
  * 客户端初始化配置信息
  */
@@ -707,6 +714,11 @@ interface CCSetupOptions {
    * @param message 错误内容
    */
   error(message: string): void;
+  /**
+   * 加载因失败次数挂起的提示
+   * @param data 消息,如果有内容说明加载失败，等待用户手动重试，如果没有内容，则说明重试后加载成功
+   */
+  markLoadRetry(data: CCLoadRetry): void;
   /**
    * 上传日志的方法，核心包运行时会生成一些有利于追踪已知错误的日志，希望能通过这个方法上传。
    * 如果不设置则不会上传错误。而是在控制台打印出来
@@ -1679,6 +1691,268 @@ declare const enum MAX_DIFF_VALUE {
 }
 
 
+// -------------- types/outer/flow/answer.d.ts ---------------
+
+/**
+ * 选项显示结果
+ * @ignore
+ */
+interface CCIOptDisplayInfo {
+  /**
+   * 关联的节点id
+   */
+  node_id: string;
+  /**
+   * 关联的循环上下文
+   */
+  loop_idxs: number[];
+  /**
+   * 显示的选项id列表
+   */
+  option_ids: string[];
+}
+
+type CCIOptionAnswerValue = number | string | CCICoords | CCMaxDiffRecord[];
+
+/**
+ * 一般与选项一一对应答案项数据结构
+ * @ignore
+ */
+interface CCIAnswerItem {
+  /**
+   * 输入值
+   */
+  value: CCIOptionAnswerValue;
+  /**
+   * 是否为其他选项
+   */
+  other: boolean;
+  /**
+   * 答案类型（各种题目的不同选项，答案类型是不一样的）
+   */
+  type: OPT_ANSWER_TYPE;
+  /**
+   * 关联的行选项id（仅矩阵题）
+   */
+  row_option_id?: string;
+  /**
+   * 关联的列选项id（仅矩阵题）
+   */
+  col_option_id?: string;
+  /**
+   * 行内容（仅矩阵题）
+   */
+  row_content?: string;
+  /**
+   * 列内容（仅矩阵题）
+   */
+  col_content?: string;
+  /**
+   * 选项id
+   */
+  option_id?: string;
+  /**
+   * 选项文字内容（变量解析后）
+   */
+  content?: string;
+  /**
+   * 选项是否被隐藏了（被隐藏的选项仍然可能被自动选中或自动填充内容，这些答案也会被收集）
+   */
+  hidden?: boolean;
+}
+
+/**
+ * 与题目一一对应的节点答案项结构
+ * @ignore
+ */
+interface CCIAnswer {
+  /**
+   * 答案类型，不同类型的题目不同
+   */
+  type: NODE_ANSWER_TYPE;
+  /**
+   * 节点id
+   */
+  node_id: string;
+  /**
+   * 本题消耗时间，用毫秒为单位
+   */
+  cost_time: number;
+  /**
+   * 本题开始时间
+   */
+  start_time: string;
+  /**
+   * 循环上下文信息
+   */
+  loop_ctxs?: CCILoopContext[];
+  /**
+   * 选项中的答案列表
+   */
+  items?: CCIAnswerItem[];
+  /**
+   * 定位信息（仅定位相关题目携带）
+   */
+  location?: CCMapLocation;
+  /**
+   * 地域信息（仅地域题）
+   */
+  region?: string;
+  /**
+   * 手机号码（仅验证题）
+   */
+  phone_num?: string;
+  /**
+   * 验证码（仅验证题）
+   */
+  code?: string;
+  /**
+   * 逻辑计算结果（仅逻辑题）
+   */
+  logic_result?: boolean;
+}
+
+/**
+ * 循环上下文信息
+ * @ignore
+ */
+interface CCILoopContext {
+  /**
+   * 关联的循环节点id
+   */
+  node_id: string;
+  /**
+   * 当前循环索引（第几次循环）
+   */
+  index: number;
+  /**
+   * 当前循环所使用的循环选项id
+   */
+  option_id: string;
+}
+
+/**
+ * 问卷收集的结果总结构
+ * @ignore
+ */
+interface CCIResult {
+  /**
+   * 问卷id
+   */
+  survey_id?: string;
+  /**
+   * 答案列表
+   */
+  answers: CCIAnswer[];
+  /**
+   * 问卷运行过程中的变量解析结果映射表记录
+   * 仅限课时内容中的变量解析
+   */
+  var_map_info: CCINodeVarMap[];
+  /**
+   * 问卷运行过程中的选项显示控制的运行结果记录
+   */
+  options_display_info: CCIOptDisplayInfo[];
+  /**
+   * URL查询参数
+   */
+  query_params: CCQueryParams;
+  /**
+   * 调用webhooks的参数解析记录
+   */
+  webhook_params: SignStrStr;
+  /**
+   * 整份问卷的消耗总时间,用秒为单位
+   */
+  time_consuming: number;
+  /**
+   * 测试和离线专用:
+   * 回复创建时间
+   */
+  created_at?: string;
+  /**
+   * 测试和离线专用:
+   * 提交时间
+   */
+  committed_at?: string;
+  /**
+   * 测试和离线专用:
+   * 离线终端ip地址
+   */
+  ip_address?: string;
+  /**
+   * 测试和离线专用:
+   * 回复状态
+   */
+  status: RESPONSE_STATUS;
+  /**
+   * 测试和离线专用:
+   * 收集器id
+   */
+  collector_id?: number;
+}
+
+
+// -------------- types/outer/flow/branch.d.ts ---------------
+
+/**
+ * 寻找下一题的规则
+ * @ignore
+ */
+interface CCINextRule {
+  /**
+   * 搜索规则方法
+   * @param list 节点列表
+   * @param node 当前题目
+   * @param state 总状态
+   * @returns 下一个节点的信息
+   */
+  findNext(list: CFPDBNode[], node: CCMNodeBase, state: CCSurveyState): Promise<CCINextNodeStatus>;
+}
+
+/**
+ * 搜索到的下一个节点的信息
+ * @ignore
+ */
+interface CCINextNodeStatus {
+  /**
+   * 目标节点
+   */
+  target: CFPDBNode;
+  /**
+   * 所处的循环状态
+   */
+  loop?: CCILoop;
+  /**
+   * 所处的循环状态栈
+   */
+  loopStack?: CCILoop[];
+  /**
+   * 所处的随机状态
+   */
+  random?: CCIRandom;
+}
+
+/**
+ * 节点列表伸展配置
+ * @ignore
+ */
+interface CCIStretchConfig {
+  /**
+   * 伸展类型
+   */
+  type: STRETCH_TYPE;
+  /**
+   * 延时伸展的时间
+   */
+  delay?: number;
+  /**
+   * 是否为初始化期间
+   */
+  initial?: boolean;
+}
+
+
 // -------------- types/outer/flow/group-table.d.ts ---------------
 
 /**
@@ -1751,6 +2025,112 @@ interface CCSinglePageGroupTableRowCell {
 }
 
 
+// -------------- types/outer/flow/loop.d.ts ---------------
+
+interface CCILoop {
+  replacements: CCILoopRep[];
+  node: CFPDLoopNode;
+  destInputId: string;
+  varList: CCLoopVar[];
+  currentIndex: number;
+}
+
+
+// -------------- types/outer/flow/payload.d.ts ---------------
+
+interface CCIStartMeta {
+  /**
+   * 问卷概要原始数据
+   */
+  surveyMeta: CCISurveyMeta;
+  /**
+   * 问卷设计原始数据
+   */
+  cfpd: CCISurveyPayload;
+}
+
+/**
+ * 下载问卷概要数据
+ * @ignore
+ */
+interface CCISurveyPayload {
+  version: number;
+  /**
+   * 媒体库内容
+   */
+  mediaLibrary: {
+    /**
+     * 图片列表
+     */
+    imageList: CFPDImage[];
+    /**
+     * 视频列表
+     */
+    videoList: CFPDVideo[];
+  };
+  /**
+   * 节点数据
+   */
+  nodes: CFPDBNode[];
+  /**
+   * 问卷id
+   */
+  surveyId: string;
+  /**
+   * 主题信息
+   */
+  theme: CFPDTheme;
+  /**
+   * 变量列表
+   */
+  variables: CFPDVar[];
+  /**
+   * 节点组信息
+   */
+  nodeGroups: CFPDNodeGroup[];
+  /**
+   * 内置接口数据
+   */
+  embedApis: CCIEmbedApi[];
+  /**
+   * 变量样式
+   */
+  varStyles: CFPDVarStyleGroup;
+  /**
+   * 内置语言
+   */
+  langPack?: CFPDLangPackItem[];
+  /**
+   * 已禁用的语言
+   */
+  disabledLangs?: string[];
+  /**
+   * 测试用例数据
+   */
+  testCases: CCITestCase[];
+  /**
+   * 预设样式
+   */
+  presetRichStyles?: CFPDPresetRichStyle[];
+}
+
+
+// -------------- types/outer/flow/random.d.ts ---------------
+
+interface CCIRandom {
+  node: CFPDRandomNode;
+  currentIndex: number;
+  /**
+   * 所有随机组头的入口id列表
+   */
+  destPortIds: string[];
+  /**
+   * 嵌套随机时的随机栈
+   */
+  stack: CCIRandom[];
+}
+
+
 // -------------- types/outer/flow/validate.d.ts ---------------
 
 /**
@@ -2038,6 +2418,70 @@ interface CCILoopRep {
 }
 
 
+// -------------- types/outer/node/action.d.ts ---------------
+
+/**
+ * 发起动作时传递的参数基础
+ * @ignore
+ */
+interface CCIActionPostParamBase {
+  /**
+   * 当前回复id
+   */
+  response_id: string;
+  /**
+   * 题目id
+   */
+  question_id: string;
+  /**
+   * 语言
+   */
+  locale: string;
+  /**
+   * 触发时机
+   */
+  event: ACTION_EVENT;
+  /**
+   * 触发的行为
+   */
+  type: ACTION_TYPE;
+}
+
+/**
+ * 发起邮件动作时传递的参数基础
+ * @ignore
+ */
+interface CCIActionPostEmailParam extends CCIActionPostParamBase {
+  /**
+   * 邮件标题
+   */
+  title: string;
+  /**
+   * 邮箱地址
+   */
+  email: string;
+  /**
+   * 邮件内容
+   */
+  content: string;
+}
+
+/**
+ * 发起短信时传递的参数基础
+ * @ignore
+ */
+interface CCIActionPostSmsParam extends CCIActionPostParamBase {
+  /**
+   * 短信配置内容
+   */
+  content: SignStrStr;
+  /**
+   * 短信服务商api地址
+   */
+  url: string;
+}
+
+
 // -------------- types/outer/node/area.d.ts ---------------
 
 interface CCAreaNode extends CCBQuestionNode, CCMValueNode, CCMRegionNode, CCMOtherOptionNode {
@@ -5120,6 +5564,51 @@ interface CCSurveyState extends CCCTranMiniState, CCIStartMiniState, CCMiniState
 }
 
 
+// -------------- types/outer/support.d.ts ---------------
+
+/**
+ * 最大最小值配置
+ */
+interface CCIMinMax {
+  /**
+   * 最大值
+   */
+  min: number;
+  /**
+   * 最小值
+   */
+  max: number;
+}
+
+/**
+ * 开始结束值设置
+ */
+interface CCIStartEnd {
+  /**
+   * 开始值
+   */
+  start: number | string;
+  /**
+   * 结束值
+   */
+  end: number | string;
+}
+
+/**
+ * 开始结束数值设置
+ */
+interface CCINumStartEnd {
+  /**
+   * 开始数值
+   */
+  start: number;
+  /**
+   * 结束数值
+   */
+  end: number;
+}
+
+
 // -------------- types/outer/tool/event-hub.d.ts ---------------
 
 //#region 自定义事件相关说明

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@choiceform/os-client-core",
-  "version": "3.6.13",
+  "version": "3.6.16",
   "description": "choiceform survey client core",
   "main": "./dist/core.js",
   "repository": "https://github.com/choice-form/os-client-core",