@choiceform/os-client-core 3.4.7 → 3.4.12

package/index.d.ts

@@ -740,6 +740,12 @@ interface CFSetupOptions {
    * @param message 错误内容
    */
   error(message: string): void;
+  /**
+   * 上传日志的方法，核心包运行时会生成一些有利于追踪已知错误的日志，希望能通过这个方法上传。
+   * 如果不设置则不会上传错误。而是在控制台打印出来
+   * @param message 
+   */
+  uploadLog?(message: string, level?: 'log' | 'error'):void;
   /**
    * 如果在单页模式中有很多题目，进行作答后点击下一题，其中某道题目的答案不满足要求，
    * 这时候可能这道题目不再滚动条所在的可见范围内，
@@ -800,9 +806,9 @@ interface CFSetupOptions {
    * 自定义中断回调方法
    * 当核心包中运行发生异常，或者需要去往外部程序时，会中断答题流程，同时触发调用这个方法
    * 客户端中可以配置该方法来在此时机做一些自定义的事情。
-   * 默认行为：什么也不做
+   * 默认行为：总是会在方法被调用的一秒内压制系统消息
    */
-  customAbort?(relax?: boolean): void;
+  customAbort?(): void;
   /**
    * 自定义的去往开始页面方法,只有使用web核心包是需要关注这个方法
    *
@@ -1054,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>;
   /**
    * 获取主题
    */
@@ -2850,6 +2856,10 @@ interface ICFSmallPayload {
    * 测试用例数据
    */
   readonly testCases: ICFTestCase[];
+  /**
+   * 最后发布时间
+   */
+  readonly publishedAt: string;
 }
 
 
@@ -4244,7 +4254,11 @@ interface ICFSlideRateNode extends ICFSubjectNode, ICFFillNodeMixin {
  * 奖励节点
  * @ignore
  */
-interface ICFGiftNode extends ICFInputNodeMixin {
+interface ICFGiftNode extends ICFInputNodeMixin, IOriginCustomLogo {
+  /**
+   * 自带的多语言翻译包，可以不需要请求大翻译包就实现开始页面的语言切换。
+   */
+  readonly i18n?: any;
   /**
    * 结束按钮文字
    * @ignore
@@ -4272,7 +4286,7 @@ interface ICFGiftNode extends ICFInputNodeMixin {
    * 中奖id
    * @ignore
    */
-  readonly goalId: string;
+  readonly rewardId: string;
   /**
    * 手机号码
    */
@@ -4297,6 +4311,7 @@ interface ICFGiftNode extends ICFInputNodeMixin {
    * @ignore
    */
   readonly needVerification: boolean;
+
 }
 
 /**
@@ -4499,6 +4514,11 @@ interface ICFStartNode extends ICFNode, ICFStartMiniState, ICFOutputNodeMixin, C
    * @ignore
    */
   readonly logoText: string;
+  /**
+   * @ignore
+   * 自定义logo的图片内容
+   */
+  readonly logoImage?: CFImageInNode;
   /**
    * @ignore
    */
@@ -4538,7 +4558,7 @@ interface ICFStartNode extends ICFNode, ICFStartMiniState, ICFOutputNodeMixin, C
  * 循环节点
  * @ignore
  */
-interface ICFLoopNode extends ICFInOutNodeMixin , ICFOptNodeMixin {
+interface ICFLoopNode extends ICFInOutNodeMixin, ICFOptNodeMixin {
   readonly loopEnd: ICFPort;
   readonly loopStart: ICFPort;
 }
@@ -5711,7 +5731,6 @@ interface IQuestionCustomData {}
  * 题目基础类型
  */
 interface CFQuestion extends ICFNode, ICFTypeInfo {
-  readonly __ques__: true;
   /**
    * 预留，其实很多题目并不需要该属性
    */
@@ -5740,7 +5759,7 @@ interface CFQuestion extends ICFNode, ICFTypeInfo {
    * 原始节点
    * @ignore
    */
-  readonly origin: ICFNode;
+  readonly origin: any;
   /**
    * 选择类型
    * 对于选择类型的题目有效,用于确定这是单选模式和多选模式
@@ -6508,20 +6527,16 @@ interface CFEndPage extends ICFEndNode, CFQuestion, CFMediaNodeMixin {
  * 如果有[[CFLotteryPage.qrCode]]属性,则需要将他渲染成二维码,并提示用户微信扫描二维码可以领奖
  */
 interface CFLotteryPage extends ICFLotteryNode, CFQuestion {
-  /**
-   * 中奖节点id
-   * @ignore
-   */
-  readonly rewardNodeId: string;
+  readonly rewardRaw?: ICFRewardRaw;
   /**
    * 二维码信息,如有值,则需要渲染成二维码,并提示微信扫码可领取奖励.
    */
-  readonly qrCode: string;
+  readonly qrCode?: string;
   /**
    * 跳转链接
    * @ignore
    */
-  readonly linkUrl: string;
+  readonly linkUrl?: string;
   /**
    * 结束按钮文字
    * @ignore
@@ -6531,11 +6546,7 @@ interface CFLotteryPage extends ICFLotteryNode, CFQuestion {
    * 是否已中奖
    * @ignore
    */
-  readonly goal: boolean;
-  /**
-   * 活动名称
-   */
-  readonly activityName: string;
+  readonly goal?: boolean;
   /**
    * 奖励名称
    */
@@ -6831,7 +6842,7 @@ interface ICFDataHub extends ICFSubjectNode, CFSubjectQuestion {
  * 虚拟循环题
  * @ignore
  */
-interface ICFLoopHub extends ICFLoopNode, CFQuestion , ICFOptNodeMixin{
+interface ICFLoopHub extends ICFLoopNode, CFQuestion, ICFOptNodeMixin {
   /**
    * 包含的循环仰视变量列表
    */
@@ -6893,6 +6904,7 @@ interface ICFIntroMeta {
   readonly payload_digest: string;
   readonly diagram_url: string;
   readonly langs: ICFRemoteLang[];
+  readonly published_at:string;
 }
 
 /**
@@ -6918,6 +6930,7 @@ interface ICFParsedSmallPayload {
   readonly langResume: boolean;
   readonly testCases: ICFTestCase[];
   readonly disabledLangs: string[];
+  readonly publishedAt: string;
 }
 
 /**
@@ -7232,6 +7245,10 @@ interface ICFEmbedApi {
  * @ignore
  */
 interface CFStateBase {
+  /**
+   * 核心
+   */
+  readonly core?: CFCore;
   /**
    * UI交互回调函数
    */
@@ -7389,15 +7406,23 @@ interface CFRealtimeState extends CFSurveyState, CFStartState {
  * 自定义logo
  * @ignore
  */
-interface ICFCustomLogo {
+interface ICFCustomLogoBase {
   /**
    * 是否使用自定义logo
    * @ignore
    */
   readonly useCustomLogo: boolean;
+}
+
+interface IOriginCustomLogo extends ICFCustomLogoBase {
+  readonly logoText?: string;
+  readonly logoImage?: CFImageInNode;
+}
+
+interface ICFCustomLogo extends ICFCustomLogoBase{
   /**
-   * 自定logo文字
-   */
+ * 自定logo文字
+ */
   readonly customText: string;
   /**
    * 自定logo图片地址
@@ -7411,10 +7436,10 @@ interface ICFCustomLogo {
 interface ICFRewardRaw {
   readonly id?: number;
   readonly gift_id?: string;
-  readonly code: string;
-  readonly type: GIFT_TYPE;
-  readonly lottery_id: string;
-  readonly lottery_option_id: string;
+  readonly code?: string;
+  readonly type?: GIFT_TYPE;
+  readonly lottery_id?: string;
+  readonly lottery_option_id?: string;
 }
 
 /**
@@ -7426,123 +7451,43 @@ interface ICFLotteryResult {
   readonly rewardImage?: CFImageInNode;
 }
 
+
 /**
  * @ignore
  */
-interface ICFRewardResult {
+interface ICFRedEnvelopeReward {
   readonly recipient?: CFUserInfo;
+  readonly theme: CFTheme;
   gift?: {
-    readonly locale: string;
-    readonly id: string;
+    readonly id: number;
     readonly title: string;
     readonly description: string;
     config: {
       readonly gift_name: string;
     };
+    origin: ICFGiftNode
   };
   readonly amount?: number;
   readonly type?: GIFT_TYPE;
 }
 
 /**
- * 奖励信息
- * @ignore
+ * 缓存的奖励信息，由于奖励页面会重开页面，内存会丢失，预览模式下和自定义奖励模式下后台是不给后续接口的，
+ * 需要自己缓存关键信息用于展示奖励页面，正好这两种模式下都不会切换设备，所以用缓存也可以。
+ * 
+ * 正式答题的红包奖励会使用后台后续接口给的信息，不会使用这些缓存信息。
  */
-interface ICFRewardInfo extends ICFGiftNode, ICFLotteryResult, ICFCustomLogo {
-  readonly core?: CFCore;
-  /**
-   * @ignore
-   */
-  readonly goal: boolean;
-  /**
-   * @ignore
-   */
-  readonly goalId: string;
-  /**
-   * @ignore
-   */
-  readonly origin: ICFGiftNode;
-  /**
-   * 奖励标题
-   */
-  readonly rewardTitle: string;
-  /**
-   * 奖励描述
-   */
-  readonly rewardDescribe: string;
-  /**
-   * @ignore
-   */
-  readonly noWxShare: boolean;
-  /**
-   * @ignore
-   */
-  readonly wxShareInfo: ICFWxShareInfo;
-  /**
-   * @ignore
-   */
-  readonly quesTitle: string;
-  /**
-   * 图片列表
-   */
-  readonly images: CFImageInNode[];
-  /**
-   * 奖励名称
-   */
-  readonly rewardName: string;
-  /**
-   * 奖励数量
-   */
-  readonly rewardCount: number;
-  /**
-   * @ignore
-   */
-  readonly lotteryCount: number;
-  /**
-   * @ignore
-   */
-  readonly sendTime: string;
-  /**
-   * 奖励类型,UI根据此决定渲染方式
-   */
-  readonly rewardType: GIFT_TYPE;
-  /**
-   * @ignore
-   */
-  readonly verifyCode: string;
-  /**
-   * @ignore
-   */
-  readonly rewardNodeId: string;
-  /**
-   * @ignore
-   */
-  readonly logoUrl: string;
-  /**
-   * @ignore
-   */
-  readonly transactionID: string;
-  /**
-   * @ignore
-   * 问卷原始id
-   */
-  readonly surveyId: string;
-  /**
-   * 标题
-   */
-  readonly title: string;
-  /**
-   * @ignore
-   */
-  readonly companyID: string;
-  /**
-   * 活动名称
-   */
-  readonly activityName: string;
+interface ICFCachedReward {
+  readonly custom?: ICFCustomReward;
+  readonly redEnvelope?: ICFRedEnvelopeReward;
+}
 
-  readonly summary: string;
 
-  readonly language: string;
+interface ICFCustomReward {
+  readonly qrCode: string;
+  readonly theme: CFTheme;
+  readonly giftNode: ICFGiftNode;
+  readonly rewardId: number;
 }
 
 /**
@@ -7550,8 +7495,18 @@ interface ICFRewardInfo extends ICFGiftNode, ICFLotteryResult, ICFCustomLogo {
  *
  * 渲染奖励信息
  */
-interface CFRewardState extends ICFRewardInfo, CFStateBase {
+interface CFRewardState extends CFStateBase, ICFCustomLogo {
+  readonly quesTitle: string;
+  readonly nodeName: string;
+  readonly type: NODE_TYPE;
+  readonly layout: CFNodeLayout;
+  readonly template?: CFNodeTemplate;
   readonly renderId: string;
+  readonly rewardName: string;
+  readonly title: string;
+  readonly phoneNumber: string;
+  readonly rewardId: string;
+  images: CFImageInNode[]
   /**
    * 奖励类型,包含以下两种类型
    * 需要根据该类型渲染不同的内容.
@@ -7675,11 +7630,6 @@ interface ICFStartMiniState extends ICFCustomLogo {
    * 自带的多语言翻译包，可以不需要请求大翻译包就实现开始页面的语言切换。
    */
   readonly i18n?: any;
-  /**
-   * @ignore
-   * 自定义logo的图片内容
-   */
-  readonly logoImage?: CFImageInNode;
   /**
    * 是否显示题目编号
    */
@@ -7821,6 +7771,10 @@ interface CFStartState extends ICFTranMiniState, ICFStartMiniIntro, CFStateBase,
    * 是否正在加载,当该属性为true时,UI需要选人加载中的状态
    */
   readonly nextLoading: boolean;
+  /**
+   * 最后发布地址
+   */
+  readonly publishedAt: string;
 }
 
 
@@ -7872,10 +7826,6 @@ interface CFSurveyState
    * 进入答题页面后答案是否发生了变化
    */
   readonly answerChangedSinceStart: boolean;
-  /**
-   * 对于核心的引用
-   */
-  readonly core?: CFCore;
   /**
    * @ignore
    */
@@ -8080,10 +8030,6 @@ interface CFSurveyState
    * @ignore
    */
   readonly point?: CFMapPoint;
-  /**
-   * @ignore
-   */
-  readonly rewardInfo?: ICFRewardInfo;
   /**
    * 预览工具信息
    */
@@ -8266,6 +8212,7 @@ interface ICFLangEndNodeStore extends ICFLangNodeStore {
 interface ICFLangGiftNodeStore extends ICFLangNodeStore {
   readonly endBtnText: string;
   readonly activityName: string;
+  readonly logoText: string;
 }
 
 /**
@@ -8969,9 +8916,13 @@ interface CFQueryParams {
    */
   readonly tid?: string;
   /**
-   * 奖励页面模板，只有动态组件下的奖励路由会使用到
+   * 问卷使用的语言，奖励授权跳转的时候要用到
+   */
+  readonly locale?: string;
+  /**
+   * 奖励类型，跳转到奖励页面的时候会用到
    */
-  readonly rtpl?: string;
+  readonly rt?: string;
   /**
    * 自动运行地址
    * @ignore

package/package.json

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