@tivio/sdk-react 10.2.0 → 10.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -564,7 +564,7 @@ useVoucher: (voucherId: string) => {
564
564
  isInitialized: boolean
565
565
  /** Public, server-safe metadata about the activated voucher. */
566
566
  voucherInfo: VoucherInfoPublic | null
567
- /** Set for transaction (PPV) vouchers the unlocked video. */
567
+ /** Video the voucher relates to, when its document references one (`voucherInfo.videoId`). */
568
568
  videoId?: string
569
569
  /** Monetizations to offer when the voucher does not fully cover the content. */
570
570
  subscriptionsToShow: PurchasableMonetization[]
@@ -585,6 +585,8 @@ interface VoucherInfoBasePublic {
585
585
  status: 'NEW' | 'USED' | 'FULFILLED'
586
586
  /** True when the voucher fully covers the content (no further payment needed). */
587
587
  fullDiscount?: boolean
588
+ /** Video the voucher relates to, when its document references one. Present for both types. */
589
+ videoId?: string
588
590
  }
589
591
 
590
592
  interface VoucherInfoSubscriptionPublic extends VoucherInfoBasePublic {
package/README.md.bak CHANGED
@@ -564,7 +564,7 @@ useVoucher: (voucherId: string) => {
564
564
  isInitialized: boolean
565
565
  /** Public, server-safe metadata about the activated voucher. */
566
566
  voucherInfo: VoucherInfoPublic | null
567
- /** Set for transaction (PPV) vouchers the unlocked video. */
567
+ /** Video the voucher relates to, when its document references one (`voucherInfo.videoId`). */
568
568
  videoId?: string
569
569
  /** Monetizations to offer when the voucher does not fully cover the content. */
570
570
  subscriptionsToShow: PurchasableMonetization[]
@@ -585,6 +585,8 @@ interface VoucherInfoBasePublic {
585
585
  status: 'NEW' | 'USED' | 'FULFILLED'
586
586
  /** True when the voucher fully covers the content (no further payment needed). */
587
587
  fullDiscount?: boolean
588
+ /** Video the voucher relates to, when its document references one. Present for both types. */
589
+ videoId?: string
588
590
  }
589
591
 
590
592
  interface VoucherInfoSubscriptionPublic extends VoucherInfoBasePublic {
package/dist/index.d.ts CHANGED
@@ -694,6 +694,17 @@ export declare interface BaseInteractiveWidget<TAnswer extends BaseQuestionAnswe
694
694
  * disruption to existing consumers.
695
695
  */
696
696
  readonly isWaitingForStart: boolean;
697
+ /**
698
+ * Delay (in seconds) applied to the audience-facing
699
+ * state relative to the live state, so end users see widget transitions in sync
700
+ * with their delayed video stream.
701
+ */
702
+ readonly audienceDelayInSeconds: number;
703
+ /**
704
+ * Number of users currently active on the video this widget belongs to.
705
+ * Sourced live from the video document (`activeUsers.value`).
706
+ */
707
+ readonly activeUsers?: number;
697
708
  answerQuestion(answerId: string): void;
698
709
  submitAnswer(request: Pick<SubmitAnswerRequest, 'answerOptionId' | 'answerText'>): Promise<void>;
699
710
  verifyJoinCode(joinCode: string, shouldJoinPlayer?: boolean): Promise<boolean>;
@@ -1472,7 +1483,9 @@ export declare enum CustomerId {
1472
1483
  JANA_HANZ = "JANA_HANZ",
1473
1484
  MYSTICO = "MYSTICO",
1474
1485
  MORAVEC = "MORAVEC",
1475
- JAN_TUNA = "JAN_TUNA"
1486
+ JAN_TUNA = "JAN_TUNA",
1487
+ PODNIKATELSKY_MINDSET = "PODNIKATELSKY_MINDSET",
1488
+ PETR_HOFMAN = "PETR_HOFMAN"
1476
1489
  }
1477
1490
 
1478
1491
  export declare interface CustomScript {
@@ -4474,7 +4487,7 @@ export declare interface PollWidget<TScene extends InteractiveWidgetScene = Inte
4474
4487
  readonly type: InteractiveWidgetType.POLL;
4475
4488
  }
4476
4489
 
4477
- export declare type PollWidgetState = InteractiveWidgetState.IDLE | InteractiveWidgetState.CURRENT_QUESTION | InteractiveWidgetState.LEADERBOARD | InteractiveWidgetState.RESET_GAME | InteractiveWidgetState.NEXT_STATE;
4490
+ export declare type PollWidgetState = InteractiveWidgetState.IDLE | InteractiveWidgetState.CURRENT_QUESTION | InteractiveWidgetState.RESOLVED_QUESTION | InteractiveWidgetState.RESET_GAME | InteractiveWidgetState.NEXT_STATE;
4478
4491
 
4479
4492
  /**
4480
4493
  * @public
@@ -5164,7 +5177,9 @@ export declare interface QuestionRepository {
5164
5177
  readonly selectedAnswerId: string | undefined;
5165
5178
  isSubmitted: boolean;
5166
5179
  isSubmitting: boolean;
5167
- setCurrentQuestion: (question: CurrentQuestion | null, role: InteractiveWidgetRole, secondsToAnswer: number, shouldEnterAtTimestampMs?: number, shouldAdjustEndTimestampMs?: boolean) => void;
5180
+ setCurrentQuestion: (question: CurrentQuestion | null, role: InteractiveWidgetRole,
5181
+ /** Time limit for the question. Omit/undefined means no timer (e.g. polls). */
5182
+ secondsToAnswer: number | undefined, shouldEnterAtTimestampMs?: number, shouldAdjustEndTimestampMs?: boolean) => void;
5168
5183
  selectAnswer: (answerId: string | undefined) => void;
5169
5184
  setShowCountdown: (showCountdown: boolean) => void;
5170
5185
  reset: () => void;
@@ -8996,6 +9011,11 @@ export declare interface VoucherInfoBasePublic {
8996
9011
  isExpired: boolean;
8997
9012
  status: VoucherInfoPublicStatus;
8998
9013
  fullDiscount?: boolean;
9014
+ /**
9015
+ * Video the voucher relates to, when the voucher document references one
9016
+ * (`videoRef`). Present for both subscription and transaction vouchers.
9017
+ */
9018
+ videoId?: string;
8999
9019
  }
9000
9020
 
9001
9021
  export declare type VoucherInfoPublic = VoucherInfoSubscriptionPublic | VoucherInfoTransactionPublic;