@tivio/sdk-react 8.0.0 → 9.0.0

package/README.md

@@ -6,6 +6,14 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 9.0.0
+    * patch: remove i18next and react-i18next from externals and dependencies
+    * patch: do not send react-spring to core-react-dom bundle, remove react-spring from dependencies
+    * patch: clean-up externals in webpack config
+    * patch: send only required dependencies to the bundle
+    * major: change purchase statuses lifecycle
+    * minor: add originalPurchaseId to PurchaseEndpointPayload
+
 * 8.0.0
     * major: deprecated usePurchasesWithVideos hook removed
     * patch: add id to user type

package/README.md.bak

@@ -6,6 +6,14 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 9.0.0
+    * patch: remove i18next and react-i18next from externals and dependencies
+    * patch: do not send react-spring to core-react-dom bundle, remove react-spring from dependencies
+    * patch: clean-up externals in webpack config
+    * patch: send only required dependencies to the bundle
+    * major: change purchase statuses lifecycle
+    * minor: add originalPurchaseId to PurchaseEndpointPayload
+
 * 8.0.0
     * major: deprecated usePurchasesWithVideos hook removed
     * patch: add id to user type

package/dist/index.d.ts

@@ -336,6 +336,11 @@ export declare type Assets = {
     [assetName: string]: ScalableAsset;
 };
 
+/**
+ * @public
+ */
+export declare type AssetType = 'circled' | 'landscape' | 'portrait';
+
 declare type Attributes = {
     created: string;
     email: string;
@@ -712,6 +717,16 @@ export declare const createRemotePackageLoader: () => (secret: string, conf: Int
  */
 export declare const createUseRemoteBundle: () => (conf: InternalConfig) => RemoteBundleState;
 
+export declare interface CreateUserPayload {
+    displayName?: string;
+    email?: string;
+    emailVerified?: boolean;
+    password?: string;
+    referralToken?: string;
+    username?: string;
+    phoneNumber?: string;
+}
+
 /**
  * @public
  */
@@ -750,7 +765,8 @@ export declare enum CustomerId {
     STARMAX = "STARMAX",
     STORYBOOK = "STORYBOOK",
     TIVIO = "TIVIO",
-    U_KULATEHO_STOLU = "U_KULATEHO_STOLU"
+    U_KULATEHO_STOLU = "U_KULATEHO_STOLU",
+    STARME = "STARME"
 }
 
 /**
@@ -1141,6 +1157,10 @@ export declare interface GetSourceUrlRequest {
      * See {@link SourcePlayMode} type. If not given, getSourceUrl will pick default based on requested document.
      */
     sourcePlayMode?: SourcePlayMode;
+    /**
+     * Returns url to manifest with audio only chunks.
+     */
+    audioOnly?: boolean;
 }
 
 export declare interface GetSourceUrlResponse {
@@ -1160,6 +1180,10 @@ export declare interface GetSourceUrlResponse {
      * See {@link SourcePlayMode} type.
      */
     sourcePlayMode: SourcePlayMode;
+    /**
+     * Returns url to manifest with audio only chunks.
+     */
+    audioOnly?: boolean;
 }
 
 export declare interface GetVideoAnalyticsErrorItem {
@@ -1266,6 +1290,10 @@ export declare interface IndexedTag extends IndexedObject {
     created: Date;
     name: Translation;
     description?: string;
+    /**
+     * True if the tag is available in Tivio Pro (StarMe)
+     */
+    isTivioPro: boolean;
 }
 
 /**
@@ -1307,6 +1335,14 @@ export declare interface IndexedVideo extends IndexedObject {
     hide: boolean;
     isDuplicate: boolean;
     externals?: VideoExternals;
+    /**
+     * Duration of the video in ms
+     */
+    duration?: number;
+    /**
+     * True if the video is available in Tivio Pro (StarMe)
+     */
+    isTivioPro: boolean;
 }
 
 /**
@@ -2350,6 +2386,11 @@ export declare interface Promotion {
     price?: number;
 }
 
+/**
+ * @public
+ */
+export declare type PromotionType = 'CLASSIC' | 'PATREON';
+
 /**
  * @public
  */
@@ -2485,6 +2526,10 @@ export declare type PurchaseEndpointPayload = {
          * Purchase status after change.
          */
         newStatus: PurchaseStatus;
+        /**
+         * Id of the original (first) purchase of reoccurring payments.
+         */
+        originalPurchaseId?: string;
         /**
          * Purchase status before change.
          */
@@ -2608,7 +2653,23 @@ export declare enum PurchaseStatus {
     /**
      * Used when purchase is terminated due to terms and conditions violation (e.g. restreaming).
      */
-    BLOCKED = "BLOCKED"
+    BLOCKED = "BLOCKED",
+    /**
+     * Used in subscription purchases when subscription is renewed.
+     */
+    RENEWED = "RENEWED",
+    /**
+     * From NEW to ABORTED when user cancels purchase before payment or when payment fails.
+     */
+    ABORTED = "ABORTED",
+    /**
+     * When user manually cancels purchase but still has access to content until expiration date.
+     */
+    CANCELLING = "CANCELLING",
+    /**
+     * From PAID to EXPIRED when payment fails to renew subscription.
+     */
+    EXPIRED = "EXPIRED"
 }
 
 /**
@@ -2637,7 +2698,7 @@ export declare interface QerkoData {
      * Otherwise, user is making a purchase for himself.
      */
     voucherPurchase?: boolean;
-    onPurchase?: () => void;
+    onPurchase?: (paymentInfo: QerkoPaymentInfo | null) => void;
     onClose?: () => void;
 }
 
@@ -2717,6 +2778,9 @@ declare type Relationship = {
     memberships: {
         data: Membership[];
     };
+    currently_entitled_tiers: {
+        data?: Membership[];
+    };
 };
 
 /**
@@ -3223,6 +3287,8 @@ export declare interface SuccessConfirmationOverlayPayload extends ConfirmationO
     confirmButtonText?: string;
 }
 
+export declare type SynchronizeUserTypeFunction = (payload: CreateUserPayload, tenantId: string, tenantUserId: string) => Promise<string>;
+
 /**
  * @public
  */
@@ -3259,6 +3325,16 @@ export declare type Tier = {
     type: 'tier';
 };
 
+export declare interface TileApplicationData {
+    id: string;
+    name: Translation;
+    description?: string;
+    logo: string;
+    urlHandle: string;
+    organizationId: string;
+    type: ApplicationType;
+}
+
 /**
  * @public
  */
@@ -4425,6 +4501,12 @@ declare type VastProvidersItem = {
     development?: boolean;
 };
 
+export declare interface verifyCustomTokenProps {
+    token: string;
+    uid: string;
+    organizationPath: string;
+}
+
 /**
  * @public
  */
@@ -4520,7 +4602,9 @@ export declare enum VideoContentType {
 /**
  * @public
  */
-export declare type VideoExternals = JojExternals | MallTvExternals | OktagonExternals | MigratedVideoExternals;
+export declare type VideoExternals = (JojExternals | MallTvExternals | OktagonExternals | MigratedVideoExternals) & {
+    channelKey?: string;
+};
 
 declare type VideoPath = string;