@100mslive/react-native-hms 2.0.0-alpha.0 → 2.0.0-alpha.1

package/src/classes/polls/HMSPollQuestionResponse.ts

@@ -0,0 +1,72 @@
+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;
+}
+
+// Web Interface -
+// export interface HMSPollQuestionResponse {
+//   id?: string;
+//   questionIndex: number;
+//   peer?: HMSPollResponsePeerInfo;
+//   type?: HMSPollQuestionType;
+//   skipped?: boolean;
+//   option?: number;
+//   options?: number[];
+//   text?: string;
+//   update?: boolean; // SDK Needs to track whether we previously answered and set accordingly
+//   duration?: number; // Time it took to answer the question for leaderboard
+//   responseFinal?: boolean; // Indicates whether this is last update when fetching responses
+// }

package/src/classes/polls/HMSPollQuestionResponseCreateParams.ts

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

package/src/classes/polls/HMSPollQuestionResponseResult.ts

@@ -0,0 +1,19 @@
+/**
+ * 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/src/classes/polls/HMSPollQuestionResult.ts

@@ -0,0 +1,41 @@
+/**
+ 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;
+}
+
+// Web Interface -
+// export interface HMSPollQuestionResult {
+//   correctResponses?: number;
+//   skippedCount?: number;
+//   totalResponses?: number;
+// }

package/src/classes/polls/HMSPollQuestionType.ts

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

package/src/classes/polls/HMSPollResponsePeerInfo.ts

@@ -0,0 +1,24 @@
+/**
+ 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/src/classes/polls/HMSPollResult.ts

@@ -0,0 +1,26 @@
+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; // totalResponses?: number; (on web)
+
+  /**
+   The number of unique users who responded to the poll.
+   */
+  userCount: number; // totalUsers?: number; (on web)
+
+  /**
+   The maximum number of users in the room during the poll.
+   */
+  maxUserCount: number; // maxUsers?: number; (on web)
+
+  /**
+   The list of question results for the poll.
+   */
+  questions: HMSPollQuestionResult[];
+}

package/src/classes/polls/HMSPollState.ts

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

package/src/classes/polls/HMSPollType.ts

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

package/src/classes/polls/HMSPollUpdateType.ts

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

package/src/classes/polls/HMSPollUserTrackingMode.ts

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

package/src/classes/polls/PollLeaderboardResponse.ts

@@ -0,0 +1,8 @@
+import type { HMSPollLeaderboardEntry } from './HMSPollLeaderboardEntry';
+import type { HMSPollLeaderboardSummary } from './HMSPollLeaderboardSummary';
+
+export interface PollLeaderboardResponse {
+  entries?: HMSPollLeaderboardEntry[];
+  hasNext?: boolean;
+  summary?: HMSPollLeaderboardSummary;
+}

package/src/classes/transcriptions/HMSTranscript.ts

@@ -0,0 +1,13 @@
+import type { HMSPeer } from '../HMSPeer';
+
+export interface HMSTranscript {
+  transcript: string;
+
+  peer: HMSPeer;
+
+  end: number;
+
+  start: number;
+
+  isFinal: boolean;
+}

package/src/classes/transcriptions/OnTranscriptionError.ts

@@ -0,0 +1,5 @@
+export interface OnTranscriptionError {
+  code?: number;
+
+  message?: string;
+}

package/src/classes/transcriptions/TranscriptionState.ts

@@ -0,0 +1,6 @@
+export enum TranscriptionState {
+  FAILED = 'FAILED',
+  INITIALIZED = 'INITIALIZED',
+  STARTED = 'STARTED',
+  STOPPED = 'STOPPED',
+}

package/src/classes/transcriptions/Transcriptions.ts

@@ -0,0 +1,19 @@
+import type { OnTranscriptionError } from './OnTranscriptionError';
+import type { TranscriptionState } from './TranscriptionState';
+import type { TranscriptionsMode } from './TranscriptionsMode';
+
+export interface Transcriptions {
+  error?: OnTranscriptionError;
+
+  mode?: TranscriptionsMode;
+
+  state?: TranscriptionState;
+
+  initialisedAt?: Date;
+
+  startedAt?: Date;
+
+  stoppedAt?: Date;
+
+  updatedAt?: Date;
+}

package/src/classes/transcriptions/TranscriptionsMode.ts

@@ -0,0 +1,4 @@
+export enum TranscriptionsMode {
+  CAPTION = 'CAPTION',
+  LIVE = 'LIVE',
+}

package/src/classes/transcriptions/index.ts

@@ -0,0 +1,5 @@
+export * from './OnTranscriptionError';
+export * from './TranscriptionState';
+export * from './TranscriptionsMode';
+export * from './Transcriptions';
+export * from './HMSTranscript';

package/src/classes/whiteboard/HMSWhiteboard.tsx

@@ -0,0 +1,16 @@
+import type { HMSPeer } from '../HMSPeer';
+import type { HMSWhiteboardState } from './HMSWhiteboardState';
+
+export interface HMSWhiteboard {
+  id: string;
+
+  title?: string;
+
+  state: HMSWhiteboardState;
+
+  isOwner: boolean;
+
+  owner?: HMSPeer;
+
+  url?: string;
+}

package/src/classes/whiteboard/HMSWhiteboardListenerActions.ts

@@ -0,0 +1,3 @@
+export enum HMSWhiteboardListenerActions {
+  ON_WHITEBOARD_UPDATE = 'ON_WHITEBOARD_UPDATE',
+}

package/src/classes/whiteboard/HMSWhiteboardState.tsx

@@ -0,0 +1,4 @@
+export enum HMSWhiteboardState {
+  STARTED = 'STARTED',
+  STOPPED = 'STOPPED',
+}

package/src/classes/whiteboard/HMSWhiteboardUpdateType.tsx

@@ -0,0 +1,4 @@
+export enum HMSWhiteboardUpdateType {
+  STARTED = 'STARTED',
+  STOPPED = 'STOPPED',
+}

package/src/classes/whiteboard/index.ts

@@ -0,0 +1,3 @@
+export * from './HMSWhiteboard';
+export * from './HMSWhiteboardUpdateType';
+export * from './HMSWhiteboardListenerActions';

package/src/classes/whiteboard/registerCallbacks.ts

@@ -0,0 +1,34 @@
+import { HMSConstants } from '../HMSConstants';
+import type { HMSEventSubscription } from '../HMSNativeEventEmitter';
+import HMSNativeEventListener from '../HMSNativeEventListener';
+import type { HMSWhiteboard } from './HMSWhiteboard';
+import { HMSWhiteboardListenerActions } from './HMSWhiteboardListenerActions';
+import type { HMSWhiteboardUpdateType } from './HMSWhiteboardUpdateType';
+
+export type WhiteboardUpdateListener = (data: {
+  hmsWhiteboard: HMSWhiteboard;
+  updateType: HMSWhiteboardUpdateType;
+}) => void;
+
+let whiteboardUpdateSubscription: null | HMSEventSubscription = null;
+
+export function registerWhiteboardUpdateListener(
+  listener: WhiteboardUpdateListener
+) {
+  if (whiteboardUpdateSubscription !== null) {
+    return;
+  }
+  whiteboardUpdateSubscription = HMSNativeEventListener.addListener(
+    HMSConstants.DEFAULT_SDK_ID,
+    HMSWhiteboardListenerActions.ON_WHITEBOARD_UPDATE,
+    listener
+  );
+}
+
+export function unregisterWhiteboardUpdateListener() {
+  if (whiteboardUpdateSubscription === null) {
+    return;
+  }
+  whiteboardUpdateSubscription.remove();
+  whiteboardUpdateSubscription = null;
+}