@100mslive/react-native-hms 1.9.8 → 1.9.10

package/lib/typescript/classes/polls/HMSPoll.d.ts

@@ -0,0 +1,81 @@
+import type { HMSPollState } from './HMSPollState';
+import type { HMSPollQuestion } from './HMSPollQuestion';
+import type { HMSPollResult } from './HMSPollResult';
+import type { HMSRole } from '../HMSRole';
+import type { HMSPollUserTrackingMode } from './HMSPollUserTrackingMode';
+import type { HMSPollType } from './HMSPollType';
+import type { HMSPeer } from '../HMSPeer';
+type HMSPeerSubset = {
+    peerID: HMSPeer['peerID'];
+    name: HMSPeer['name'];
+};
+type HMSRoleSubset = {
+    name: HMSRole['name'];
+};
+export interface HMSPoll {
+    /**
+     The unique identifier of the poll.
+     */
+    pollId: string;
+    /**
+     The title of the poll.
+     */
+    title: string;
+    /**
+     The duration of the poll in seconds.
+     */
+    duration?: number;
+    /**
+     A flag indicating whether the poll is anonymous or not.
+     */
+    anonymous?: boolean;
+    /**
+     The tracking mode for user participation in the poll.
+     */
+    mode?: HMSPollUserTrackingMode;
+    /**
+     The roles that can vote in the poll.
+     */
+    rolesThatCanVote?: HMSRoleSubset[];
+    /**
+     The roles that can view the poll responses.
+     */
+    rolesThatCanViewResponses?: HMSRoleSubset[];
+    /**
+     The peer who started the poll.
+     */
+    startedBy?: HMSPeerSubset;
+    /**
+     The peer who stopped the poll.
+     */
+    stoppedBy?: HMSPeerSubset;
+    /**
+     The peer who created the poll.
+     */
+    createdBy?: HMSPeerSubset;
+    /**
+     The date and time when the poll was started.
+     */
+    startedAt?: Date;
+    /**
+     The date and time when the poll was stopped.
+     */
+    stoppedAt?: Date;
+    /**
+     The type of the poll.
+     */
+    type: HMSPollType;
+    /**
+     The current state of the poll.
+     */
+    state?: HMSPollState;
+    /**
+     The list of questions in the poll.
+     */
+    questions?: HMSPollQuestion[];
+    /**
+     The result of the poll.
+     */
+    result?: HMSPollResult;
+}
+export {};

package/lib/typescript/classes/polls/HMSPollCategory.d.ts

@@ -0,0 +1,10 @@
+export declare enum HMSPollCategory {
+    /**
+     The poll is a standard poll.
+     */
+    poll = 0,
+    /**
+     The poll is a quiz.
+     */
+    quiz = 1
+}

package/lib/typescript/classes/polls/HMSPollCreateParams.d.ts

@@ -0,0 +1,6 @@
+import type { HMSPoll } from './HMSPoll';
+import type { HMSPollQuestionCreateParams } from './HMSPollQuestionCreateParams';
+export interface HMSPollCreateParams extends Pick<HMSPoll, 'title' | 'type' | 'duration' | 'anonymous' | 'mode' | 'rolesThatCanVote' | 'rolesThatCanViewResponses'> {
+    pollId?: HMSPoll['pollId'];
+    questions?: HMSPollQuestionCreateParams[];
+}

package/lib/typescript/classes/polls/HMSPollQuestion.d.ts

@@ -0,0 +1,61 @@
+import type { HMSPollQuestionAnswer } from './HMSPollQuestionAnswer';
+import type { HMSPollQuestionOption } from './HMSPollQuestionOption';
+import type { HMSPollQuestionResponse } from './HMSPollQuestionResponse';
+import type { HMSPollQuestionType } from './HMSPollQuestionType';
+/**
+ Represents a question in a poll.
+ */
+export interface HMSPollQuestion {
+    /**
+     The index of the question within the poll.
+     */
+    index: number;
+    /**
+     The text of the question.
+     */
+    text: string;
+    /**
+     A flag indicating whether the question is skippable or not.
+     */
+    skippable: boolean;
+    /**
+     The duration hint of the question in seconds. Can be used for setting a timeframe withing which a question can be responded to. Not enforced by the server.
+     */
+    duration: number;
+    /**
+     A flag indicating whether the question can be answered only once.
+     */
+    once: boolean;
+    /**
+     The weight of the question in scoring.
+     */
+    weight: number;
+    /**
+     The minimum length of the answer (if applicable).
+     */
+    answerMinLen?: number;
+    /**
+     The maximum length of the answer (if applicable).
+     */
+    answerMaxLen?: number;
+    /**
+     The type of the question.
+     */
+    type: HMSPollQuestionType;
+    /**
+     The list of options for the question (if applicable).
+     */
+    options?: HMSPollQuestionOption[];
+    /**
+     The answer for the question (if it is a quiz).
+     */
+    answer?: HMSPollQuestionAnswer;
+    /**
+     The list of responses for the question.
+     */
+    responses?: HMSPollQuestionResponse[];
+    /**
+     The responses provided by the current user for the question.
+     */
+    myResponses: HMSPollQuestionResponse[];
+}

package/lib/typescript/classes/polls/HMSPollQuestionAnswer.d.ts

@@ -0,0 +1,17 @@
+/**
+ Provides the correct answer for a quiz question to check users' responses against.
+ */
+export interface HMSPollQuestionAnswer {
+    /**
+     A flag indicating whether the answer should be hidden or not.
+     */
+    hidden: boolean;
+    /**
+     The index of the selected option (in case of single choice question).
+     */
+    option?: number;
+    /**
+     The list of indexes of selected options (in case of multiple choice question).
+     */
+    options?: number[];
+}

package/lib/typescript/classes/polls/HMSPollQuestionCreateParams.d.ts

@@ -0,0 +1,25 @@
+import type { HMSPollQuestion } from './HMSPollQuestion';
+import type { HMSPollQuestionOptionCreateParams } from './HMSPollQuestionOptionCreateParams';
+import type { HMSPollQuestionQuizOptionCreateParams } from './HMSPollQuestionQuizOptionCreateParams';
+export interface HMSPollQuestionCreateParams extends Pick<HMSPollQuestion, 'text' | 'skippable' | 'type' | 'answerMinLen' | 'answerMaxLen'> {
+    /**
+     * A flag indicating whether the question can be answered only once.
+     */
+    once?: HMSPollQuestion['once'];
+    /**
+     * The duration hint of the question in seconds. Can be used for setting a timeframe withing which a question can be responded to. Not enforced by the server.
+     */
+    duration?: HMSPollQuestion['duration'];
+    /**
+     * The index of the question within the poll.
+     */
+    index?: HMSPollQuestion['index'];
+    /**
+     * The options of the question.
+     */
+    options?: HMSPollQuestionOptionCreateParams[] | HMSPollQuestionQuizOptionCreateParams[];
+    /**
+     * The weight of the question in scoring.
+     */
+    weight?: number;
+}

package/lib/typescript/classes/polls/HMSPollQuestionOption.d.ts

@@ -0,0 +1,21 @@
+/**
+ Represents an option for a poll question.
+ */
+export interface HMSPollQuestionOption {
+    /**
+     The index of the option within the question.
+     */
+    index: number;
+    /**
+     The text of the option.
+     */
+    text: string;
+    /**
+     The weight of the option in scoring.
+     */
+    weight: number;
+    /**
+     The count of votes received for the option. `0` is the default value.
+     */
+    voteCount: number;
+}

package/lib/typescript/classes/polls/HMSPollQuestionOptionCreateParams.d.ts

@@ -0,0 +1,3 @@
+import type { HMSPollQuestionOption } from './HMSPollQuestionOption';
+export interface HMSPollQuestionOptionCreateParams extends Pick<HMSPollQuestionOption, 'text'> {
+}

package/lib/typescript/classes/polls/HMSPollQuestionQuizOptionCreateParams.d.ts

@@ -0,0 +1,4 @@
+import type { HMSPollQuestionOptionCreateParams } from './HMSPollQuestionOptionCreateParams';
+export interface HMSPollQuestionQuizOptionCreateParams extends HMSPollQuestionOptionCreateParams {
+    isCorrectAnswer: boolean;
+}

package/lib/typescript/classes/polls/HMSPollQuestionResponse.d.ts

@@ -0,0 +1,47 @@
+import type { HMSPollQuestionType } from './HMSPollQuestionType';
+import type { HMSPollResponsePeerInfo } from './HMSPollResponsePeerInfo';
+/**
+ Represents a response for a poll question.
+ */
+export interface HMSPollQuestionResponse {
+    /**
+     The ID of the question associated with the response.
+     */
+    questionID: number;
+    /**
+     The type of the question associated with the response.
+     */
+    type: HMSPollQuestionType;
+    /**
+     A flag indicating whether the question was skipped or not.
+     */
+    skipped: boolean;
+    /**
+     The index of the selected option (in case of single choice question).
+     */
+    option: number;
+    /**
+     The list of indexes of selected options (in case of multiple choice question).
+     */
+    options?: number[];
+    /**
+     The text answer provided (in case of short/long answer question).
+     */
+    text: string;
+    /**
+     A flag indicating whether the response was updated from previous response.
+     */
+    update: boolean;
+    /**
+     Time taken to respond.
+     */
+    duration: number;
+    /**
+     The peer information associated with the response. Depends on the tracking type selected for poll.
+     */
+    peer?: HMSPollResponsePeerInfo;
+    /**
+     A flag indicating whether the response is final in case multiple responses were sent for this question.
+     */
+    responseFinal?: boolean;
+}

package/lib/typescript/classes/polls/HMSPollQuestionResponseCreateParams.d.ts

@@ -0,0 +1,2 @@
+import type { HMSPollQuestionResponse } from './HMSPollQuestionResponse';
+export type HMSPollQuestionResponseCreateParams = Omit<HMSPollQuestionResponse, 'type' | 'peer' | 'update' | 'responseFinal'>;

package/lib/typescript/classes/polls/HMSPollQuestionResponseResult.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Represents the result of a poll question response.
+ */
+export interface HMSPollQuestionResponse {
+    /**
+     * The ID of the question associated with the response result.
+     */
+    question: number;
+    /**
+     * A flag indicating whether the response was correct or not in case of quiz.
+     */
+    correct?: boolean;
+    /**
+     * An error associated with the response result (if any).
+     */
+    error?: string;
+}

package/lib/typescript/classes/polls/HMSPollQuestionResult.d.ts

@@ -0,0 +1,29 @@
+/**
+ Represents the result of a poll question within a poll result.
+ */
+export interface HMSPollQuestionResult {
+    /**
+     The ID of the question associated with the result.
+     */
+    question: number;
+    /**
+     The type of the question associated with the result.
+     */
+    type: string;
+    /**
+     The vote counts for each option of the question.
+     */
+    optionVoteCounts: number[];
+    /**
+     The number of correct votes for the question.
+     */
+    correctVotes: number;
+    /**
+     The number of skipped votes for the question.
+     */
+    skippedVotes: number;
+    /**
+     The total number of votes received for the question.
+     */
+    totalVotes: number;
+}

package/lib/typescript/classes/polls/HMSPollQuestionType.d.ts

@@ -0,0 +1,18 @@
+export declare enum HMSPollQuestionType {
+    /**
+     The question allows for a single choice answer.
+     */
+    singleChoice = 0,
+    /**
+     The question allows for multiple choice answers.
+     */
+    multipleChoice = 1,
+    /**
+     The question expects a short text answer.
+     */
+    shortAnswer = 2,
+    /**
+     The question expects a long text answer.
+     */
+    longAnswer = 3
+}

package/lib/typescript/classes/polls/HMSPollResponsePeerInfo.d.ts

@@ -0,0 +1,21 @@
+/**
+ Represents the peer information associated with a poll response. The properties are filled according to HMSPollUserTrackingMode selected for the poll.
+ */
+export interface HMSPollResponsePeerInfo {
+    /**
+     The user hash associated with the peer.
+     */
+    userHash?: string;
+    /**
+     The peer ID associated with the response.
+     */
+    peerId?: string;
+    /**
+     The user ID associated with the peer.
+     */
+    customerUserId?: string;
+    /**
+     The username associated with the peer.
+     */
+    userName?: string;
+}

package/lib/typescript/classes/polls/HMSPollResult.d.ts

@@ -0,0 +1,22 @@
+import type { HMSPollQuestionResult } from './HMSPollQuestionResult';
+/**
+ Represents the result of a poll.
+ */
+export interface HMSPollResult {
+    /**
+     The total number of responses received for the poll.
+     */
+    totalResponse: number;
+    /**
+     The number of unique users who responded to the poll.
+     */
+    userCount: number;
+    /**
+     The maximum number of users in the room during the poll.
+     */
+    maxUserCount: number;
+    /**
+     The list of question results for the poll.
+     */
+    questions: HMSPollQuestionResult[];
+}

package/lib/typescript/classes/polls/HMSPollState.d.ts

@@ -0,0 +1,14 @@
+export declare enum HMSPollState {
+    /**
+     The poll is created but not started yet.
+     */
+    created = 0,
+    /**
+     The poll has started and is currently active.
+     */
+    started = 1,
+    /**
+     The poll has been stopped and is no longer active.
+     */
+    stopped = 2
+}

package/lib/typescript/classes/polls/HMSPollType.d.ts

@@ -0,0 +1,4 @@
+export declare enum HMSPollType {
+    poll = 0,
+    quiz = 1
+}

package/lib/typescript/classes/polls/HMSPollUpdateType.d.ts

@@ -0,0 +1,5 @@
+export declare enum HMSPollUpdateType {
+    started = 0,
+    resultsUpdated = 1,
+    stopped = 2
+}

package/lib/typescript/classes/polls/HMSPollUserTrackingMode.d.ts

@@ -0,0 +1,14 @@
+export declare enum HMSPollUserTrackingMode {
+    /**
+     User tracking is based on the peer ID.
+     */
+    peerID = 0,
+    /**
+     User tracking is based on the customer ID.
+     */
+    customerUserID = 1,
+    /**
+     User tracking is based on the username.
+     */
+    userName = 2
+}

package/lib/typescript/hooks/polls.d.ts

@@ -0,0 +1,3 @@
+import type { HMSPoll } from '../classes/polls/HMSPoll';
+export declare const usePollsState: (pollId?: HMSPoll['pollId']) => HMSPoll | Record<string, HMSPoll>;
+export declare const setPollsState: (poll: HMSPoll) => void;

package/lib/typescript/index.d.ts

@@ -86,6 +86,14 @@ export type { HMSSessionStore, JsonArray, JsonMap, JsonPrimitive, JsonValue, } f
 export type { HmsViewComponent as HMSView, HmsComponentProps as HMSViewProps, } from './classes/HmsView';
 export type { HMSPIPConfig } from './classes/HMSPIPConfig';
 export { HMSRecordingState } from './classes/HMSRecordingState';
+export type { HMSPoll } from './classes/polls/HMSPoll';
+export { HMSPollQuestionType } from './classes/polls/HMSPollQuestionType';
+export { HMSPollType } from './classes/polls/HMSPollType';
+export { HMSPollUserTrackingMode } from './classes/polls/HMSPollUserTrackingMode';
+export { HMSPollUpdateType } from './classes/polls/HMSPollUpdateType';
+export { HMSPollState } from './classes/polls/HMSPollState';
+export { HMSPollQuestion } from './classes/polls/HMSPollQuestion';
+export { HMSPollQuestionOption } from './classes/polls/HMSPollQuestionOption';
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export { default as HMSManagerModule } from './modules/HMSManagerModule';
 export * from './components/HMSHLSPlayer';
@@ -93,6 +101,7 @@ export * from './hooks/useHMSPeerUpdates';
 export { useHmsViewsResolutionsState } from './hooks/hmsviews';
 export type { NotificationResult } from './utils/notification';
 export { checkNotifications } from './utils/notification';
+export * from './utils/windowController';
 export * from './utils/keyboard';
 export * from './types';
 export * from './stores/types';

package/lib/typescript/stores/hms-interactivity-store.d.ts

@@ -0,0 +1,9 @@
+export declare const useHMSInteractivityStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<import("./types").HMSPollsSlice>, "subscribe"> & {
+    subscribe: {
+        (listener: (selectedState: import("./types").HMSPollsSlice, previousSelectedState: import("./types").HMSPollsSlice) => void): () => void;
+        <U>(selector: (state: import("./types").HMSPollsSlice) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
+            equalityFn?: ((a: U, b: U) => boolean) | undefined;
+            fireImmediately?: boolean | undefined;
+        } | undefined): () => void;
+    };
+}>;

package/lib/typescript/stores/hms-polls-slice.d.ts

@@ -0,0 +1,5 @@
+import type { StateCreator } from 'zustand';
+import type { HMSInteractivityStore, HMSPollsSlice } from './types';
+export declare const createHMSPollsSlice: StateCreator<HMSInteractivityStore, [
+], [
+], HMSPollsSlice>;

package/lib/typescript/stores/types.d.ts

@@ -1,6 +1,8 @@
+import type { HMSPoll } from '../classes/polls/HMSPoll';
 import type { HMSHLSPlayerPlaybackState, HMSHLSPlayerPlaybackCueEventData, HMSHLSPlayerPlaybackFailureEventData, HMSHLSPlayerPlaybackResolutionChangeEventData, HMSHLSPlayerStatsErrorEventData, HMSHLSPlayerStatsUpdateEventData } from '../types';
 export type HMSStore = HMSHLSPlayerPlaybackSlice & HMSViewsSlice;
 export type HMSHLSPlayerStatsStore = HMSHLSPlayerStatsSlice;
+export type HMSInteractivityStore = HMSPollsSlice;
 export type TrackId = string;
 export type Resolution = {
     width: number;
@@ -35,3 +37,7 @@ export interface HMSHLSPlayerStatsSlice {
     changeStats(stats: HMSHLSPlayerStats): void;
     setError(error: HMSHLSPlayerStatsError): void;
 }
+export type HMSPollsSlice = {
+    polls: Record<string, HMSPoll>;
+    setPolls(poll: HMSPoll): void;
+};

package/lib/typescript/utils/emitter/EventEmitter.d.ts

@@ -16,6 +16,7 @@ export { EmitterSubscription } from './_EmitterSubscription';
  */
 export declare class EventEmitter {
     _subscriber: EventSubscriptionVendor;
+    _onAllListenersRemoved: ((eventType: string | 'all') => void) | null | undefined;
     /**
      * @constructor
      *
@@ -23,6 +24,12 @@ export declare class EventEmitter {
      *   to use. If omitted, a new subscriber will be created for the emitter.
      */
     constructor(subscriber?: EventSubscriptionVendor | null);
+    /**
+     * Registers a listener to be invoked when all event listeners have been removed
+     * Given listener is invoked with event type or `all` when all listeners are removed
+     * @param onAllListenersRemoved
+     */
+    registerOnAllListenersRemoved(onAllListenersRemoved: (eventType: string | 'all') => void): void;
     /**
      * Adds a listener to be invoked when events of the specified type are
      * emitted. An optional calling context may be provided. The data arguments

package/lib/typescript/utils/windowController.d.ts

@@ -0,0 +1,10 @@
+export declare class WindowController {
+    /**
+     * [Android Only] Hides the navigation bar.
+     */
+    static hideSystemBars(): any;
+    /**
+     * [Android Only] Shows the navigation bar.
+     */
+    static showSystemBars(): any;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "1.9.8",
+  "version": "1.9.10",
   "description": "Integrate Real Time Audio and Video conferencing, Interactive Live Streaming, and Chat in your apps with 100ms React Native SDK. With support for HLS and RTMP Live Streaming and Recording, Picture-in-Picture (PiP), one-to-one Video Call Modes, Audio Rooms, Video Player and much more, add immersive real-time communications to your apps.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/sdk-versions.json

@@ -1,6 +1,6 @@
 {
-  "ios": "1.4.2",
+  "ios": "1.5.1",
   "iOSBroadcastExtension": "0.0.9",
   "iOSHMSHLSPlayer": "0.0.2",
-  "android": "2.8.7"
+  "android": "2.9.2"
 }