@tivio/sdk-react 4.4.0 → 4.4.1

package/README.md

@@ -6,6 +6,9 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.4.1
+  * patch: added waitForTags param in useSearch hook for videos
+
 * v4.4.0
   * minor: PrimaryButton component props type set to any for now
   * patch: isPurchasableAsVoucher added to PurchasableMonetization

package/README.md.bak

@@ -6,6 +6,9 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* v4.4.1
+  * patch: added waitForTags param in useSearch hook for videos
+
 * v4.4.0
   * minor: PrimaryButton component props type set to any for now
   * patch: isPurchasableAsVoucher added to PurchasableMonetization

package/dist/index.d.ts

@@ -2633,6 +2633,10 @@ export declare type User = {
      * Returns "active" (non-expired) subscription purchases
      */
     purchasedSubscriptions: Purchase[];
+    /**
+     * Returns last expired subscription which user can renew or undefined
+     */
+    extendableSubscription?: Purchase;
     isPurchasesInitialized: boolean;
     isSignedIn: boolean;
     email?: string;
@@ -2668,7 +2672,7 @@ export declare enum UserType {
 /**
  * @public
  */
-export declare type UseSearch = <T extends ALGOLIA_INDEX_NAME>(indexName: T, options?: UseSearchOptions) => {
+export declare type UseSearch = <T extends ALGOLIA_INDEX_NAME>(indexName: T, options?: UseSearchOptions<T>) => {
     search: (query: string) => void;
     pagination: Omit<PaginationInterface<UseSearchResult<T>>, 'loading'> | null;
     error: Error | null;
@@ -2687,15 +2691,26 @@ export declare const useSearch: UseSearch;
 /**
  * @public
  */
-export declare type UseSearchOptions = PaginationOptions & Partial<{
-    minQueryLength: number;
-}>;
+export declare type UseSearchOptions<T extends ALGOLIA_INDEX_NAME = any> = PaginationOptions & {
+    minQueryLength?: number;
+} & (T extends ALGOLIA_INDEX_NAME.VIDEOS ? UseSearchVideoOptions : {});
 
 /**
  * @public
  */
 export declare type UseSearchResult<T extends ALGOLIA_INDEX_NAME> = T extends ALGOLIA_INDEX_NAME.VIDEOS ? Video : T extends ALGOLIA_INDEX_NAME.TAGS ? Tag : T extends ALGOLIA_INDEX_NAME.TV_CHANNELS ? TvChannel : unknown;
 
+/**
+ * @public
+ */
+export declare type UseSearchVideoOptions = {
+    /**
+     * If true video tags are awaited before loading is over.
+     * Otherwise, only videos are awaited.
+     */
+    waitForTags?: boolean;
+};
+
 /**
  * @public
  */