@tivio/sdk-react 9.2.0-alpha.3 → 9.2.0-alpha.4

package/README.md

@@ -5,9 +5,14 @@ above Tivio Studio. You can comfortably manage all you videos, settings such as
 settings in the administration of Tivio Studio while having the freedom to build your own application.
 
 ## Changelog
+* 9.2.0-alpha.4
+  * patch: expose getUser, resetPassword and signOut methods in RemoteBundleState type
+  * patch: more precise types for user profile fields and methods
+  * patch: add missing jsdocs for some User type fields
+
 * 9.2.0-alpha.0
   * minor: add renderWebPlayer method for rendering outside of React
-  * minor: "expose createTivio" 
+  * minor: "expose createTivio"
 
 * 9.1.7
   * patch: update remote controller component API

package/README.md.bak

@@ -5,9 +5,14 @@ above Tivio Studio. You can comfortably manage all you videos, settings such as
 settings in the administration of Tivio Studio while having the freedom to build your own application.
 
 ## Changelog
+* 9.2.0-alpha.4
+  * patch: expose getUser, resetPassword and signOut methods in RemoteBundleState type
+  * patch: more precise types for user profile fields and methods
+  * patch: add missing jsdocs for some User type fields
+
 * 9.2.0-alpha.0
   * minor: add renderWebPlayer method for rendering outside of React
-  * minor: "expose createTivio" 
+  * minor: "expose createTivio"
 
 * 9.1.7
   * patch: update remote controller component API

package/dist/index.d.ts

@@ -1052,10 +1052,12 @@ export declare interface CreateUserPayload {
     isAnonymous?: boolean;
 }
 
+export declare type CreateUserProfileRequest = Omit<UserProfile, 'id'>;
+
 /**
  * @public
  */
-export declare type CreateUserWithEmailAndPassword = (email: string, password: string, username?: string, phoneNumber?: string, referralToken?: string) => Promise<string | null>;
+export declare type CreateUserWithEmailAndPassword = (email: string, password: string, username: string, phoneNumber?: string, referralToken?: string) => Promise<string | null>;
 
 export declare interface CreatorsWithVoucherSubscriptions {
     id: string;
@@ -1672,6 +1674,10 @@ export declare interface GetSourceUrlRequest {
      * Start time in ms, for live streams. Will return manifest with desired start.
      */
     startTimeMs?: number;
+    /**
+     * Parameters related to ads.
+     */
+    adParams?: Record<string, string | number | undefined>;
 }
 
 export declare interface GetSourceUrlResponse {
@@ -5469,20 +5475,27 @@ export declare type TivioAnalytics = {
  */
 export declare interface TivioAuth {
     /**
+     * Create and sign up new user with given email and password.
      * @param email
      * @param password
+     * @returns {string} - uid of newly created and signed-up user
      */
     createUserWithEmailAndPassword: CreateUserWithEmailAndPassword;
     /**
-     * Sign in the user and starts listening on his purchases
+     * Sign in the user with given email and password and start listening on their purchases.
      * @param email
      * @param password
+     * @returns {string} - uid of signed-in user.
      */
     signInWithEmailAndPassword: (email: string, password: string) => Promise<string | null>;
     signInWithCustomToken: (token: string) => Promise<string | null>;
+    /**
+     * Signs out currently signed-in user.
+     */
     signOut: () => Promise<void>;
     /**
-     * Used for reset forgotten password by user
+     * Resets password for given user email.
+     * @param email
      */
     resetPassword: (email: string) => Promise<void>;
 }
@@ -5625,13 +5638,13 @@ export declare type TivioGetters = {
     /**
      * Get video by its id.
      * @param videoId - video id
-     * @returns {Promise<Video | null>} video or null if video does not exists
+     * @returns {Promise<Video | null>} video or null if video does not exist
      */
     getVideoById: (videoId: string) => Promise<Video | null>;
     /**
      * Get screen by its id.
      * @param screenId - screen id
-     * @returns {Promise<Screen | null>} screen or null if screen does not exists
+     * @returns {Promise<Screen | null>} screen or null if screen does not exist
      */
     getScreenById: (screenId: string, cb?: (error: Error | null, data: Screen_2 | null, disposer?: Disposer_2) => void) => Promise<Screen_2 | null>;
     /**
@@ -5639,6 +5652,11 @@ export declare type TivioGetters = {
      * @returns PlayerCapability[]
      */
     getPlayerCapabilities: () => PlayerCapability[];
+    /**
+     * Get currently logged-in user. If no user is logged in, returns `null`.
+     * @returns User
+     */
+    getUser: () => User | null;
 };
 
 /**
@@ -5834,7 +5852,7 @@ export declare type TivioJsBundleExposedApi = {
     getTagById: (tagId: string) => Promise<Tag | null>;
     createPlayerWrapper: (playerImplementation: PlayerInterfaceForPlayerWrapper) => TivioPlayerWrapper;
     destroy: () => Promise<void>;
-} & Pick<TivioGetters, 'getVideoById' | 'getScreenById' | 'organization'> & Pick<TivioSubscriptions, 'subscribeToVideo' | 'subscribeToItemsInRow' | 'subscribeToRowsInScreen'> & Pick<TivioAuth, 'createUserWithEmailAndPassword' | 'signInWithEmailAndPassword'> & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
+} & Pick<TivioGetters, 'getVideoById' | 'getScreenById' | 'organization' | 'getUser'> & Pick<TivioSubscriptions, 'subscribeToVideo' | 'subscribeToItemsInRow' | 'subscribeToRowsInScreen'> & Pick<TivioAuth, 'createUserWithEmailAndPassword' | 'signInWithEmailAndPassword' | 'resetPassword' | 'signOut'> & Pick<TivioSetters, 'setBundleVersion' | 'setUser' | 'setLanguage' | 'setStorageManager'>;
 
 /**
  * @public
@@ -6476,18 +6494,45 @@ export declare type User = {
     isPurchasesInitialized: boolean;
     isSignedIn: boolean;
     isReady: boolean;
+    /**
+     * Email of this user.
+     */
     email?: string;
     type?: UserType;
     photoURL: string | null;
+    /**
+     * Name of this user - typically first and last name combined, or any other nickname chosen by user.
+     */
     name?: string;
     /**
      * Authentication id differs from {@link id}.
      */
     authUserId?: string;
+    /**
+     * List of content (e.g. videos / series) that user marked as their favorite.
+     * Changes based on currently {@link activeUserProfileId}
+     */
     favorites: any[];
+    /**
+     * List of content (e.g. videos / series) that user watched recently with precise time position where they last left watching.
+     * Number of entries in the list is limited by constant number (i.e. older entries are deleted when limit is reached).
+     * In some cases entries are actively removed even if they are new, for example when user watched video to the end.
+     * Changes based on currently {@link activeUserProfileId}.
+     */
     watchedPositions: any[];
+    /**
+     * Similar to {@link watchedPositions}, but has higher limit for number of entries,
+     * and they never actively deleted (e.g. when user watched video to the end)
+     * Changes based on currently {@link activeUserProfileId}.
+     */
     watchHistory: any[];
-    profiles: any[];
+    /**
+     * List of profiles for this user.
+     */
+    profiles: UserProfile[];
+    /**
+     * Currently active user profile id.
+     */
     activeUserProfileId: string | null;
     patreon?: PatreonUserAuth;
     subscriptionIdsToShow: string[] | null;
@@ -6495,9 +6540,22 @@ export declare type User = {
     isAnonymous: boolean;
     isDiscordConnected: boolean;
     disconnectDiscord: () => Promise<void>;
-    createUserProfile: (request: any) => Promise<void>;
+    /**
+     * Create new profile for this user.
+     * @param request
+     */
+    createUserProfile: (request: CreateUserProfileRequest) => Promise<void>;
+    /**
+     * Delete given profile from this user.
+     * @param profileId
+     */
     deleteUserProfile: (profileId: string) => Promise<void>;
-    setActiveUserProfileId: (id: string) => void;
+    /**
+     * Activate given profile for this user.
+     * After activation {@link favorites}, {@link watchedPositions} and {@link watchHistory} of given profile will be used.
+     * @param profileId
+     */
+    setActiveUserProfileId: (profileId: string) => void;
     getFollowedOrganizations: () => Promise<Array<FollowedOrganizationData | undefined>>;
     sendFinalizeRegistrationEmail: (email: string) => Promise<void>;
     isUserAlreadyRegisteredByTenant: (email: string) => Promise<boolean>;