sanity-plugin-mux-input 2.14.0 → 2.16.0

package/src/util/textTracks.ts

@@ -2,7 +2,7 @@ import type {SanityClient} from '@sanity/client'
 
 import {getAsset} from '../actions/assets'
 import {generateJwt} from './generateJwt'
-import {getPlaybackId} from './getPlaybackId'
+import {getPlaybackId} from './getPlaybackPolicy'
 import {getPlaybackPolicy} from './getPlaybackPolicy'
 import type {MuxTextTrack, VideoAssetDocument} from './types'
 
@@ -169,6 +169,9 @@ export async function pollTrackStatus(
   }
 }
 
+/**
+ * May throw a Promise. Call this with {@link tryWithSuspend} or rethrow the Promise
+ */
 export async function downloadVttFile(
   client: SanityClient,
   asset: VideoAssetDocument,
@@ -191,11 +194,11 @@ export async function downloadVttFile(
     throw new Error('Playback ID is required')
   }
 
-  const playbackPolicy = getPlaybackPolicy(asset)
+  const playbackPolicy = getPlaybackPolicy(asset)?.policy
 
   let downloadUrl = `https://stream.mux.com/${playbackId}/text/${track.id}.vtt`
 
-  if (playbackPolicy === 'signed') {
+  if (playbackPolicy === 'signed' || playbackPolicy === 'drm') {
     const token = generateJwt(client, playbackId, 'v')
     downloadUrl += `?token=${token}`
   }

package/src/util/tryWithSuspend.ts

@@ -0,0 +1,22 @@
+/**
+ * When running `suspend()` from react-suspend a function may throw a Promise
+ * causing unexpected behavior when catching.
+ * @param block Your block of code that uses suspend
+ * @param onError (optional) How to handle a regular Error
+ * @returns Whatever is returned by the block if it succeeds, otherwise whatever is resolved by onError if defined
+ * @throws rethrows the caught Promise to comply with Suspense logic
+ */
+export function tryWithSuspend<T, E>(
+  block: () => T,
+  onError?: (error: Error) => E
+): T | E | undefined {
+  try {
+    return block()
+  } catch (errorOrPromise) {
+    if (errorOrPromise instanceof Promise) {
+      // react-suspend will throw a Promise
+      throw errorOrPromise
+    }
+    return onError ? onError(errorOrPromise as Error) : undefined
+  }
+}

package/src/util/types.ts

@@ -89,6 +89,13 @@ export interface MuxInputConfig {
    */
   defaultPublic?: boolean
 
+  /**
+   * Enables DRM Protection by default, if you configured your DRM Configuration Id.
+   * @see {@link https://www.mux.com/docs/guides/protect-videos-with-drm}
+   * @defaultValue true
+   */
+  defaultDrm?: boolean
+
   /**
    * Auto-generate captions for these languages by default.
    * Requires `"video_quality": "plus"`
@@ -124,6 +131,13 @@ export interface MuxInputConfig {
    */
   disableTextTrackConfig?: boolean
 
+  /**
+   * Whether or not to show the playback warning when trying to watch DRM content for the first time.
+   *
+   * @defaultValue false
+   */
+  disableDrmPlaybackWarning?: boolean
+
   /**
    * The mime types that are accepted by the input.
    *
@@ -266,6 +280,7 @@ export interface UploadConfig
   text_tracks: UploadTextTrack[]
   signed_policy: boolean
   public_policy: boolean
+  drm_policy: boolean
 }
 
 /**
@@ -308,18 +323,28 @@ export interface MuxNewAssetSettings
   }[]
 
   /** An array of playback policy names that you want applied to this asset and available through playback_ids. */
-  playback_policy: ('public' | 'signed' | 'drm')[]
+  playback_policy?: PlaybackPolicy[]
+
+  /** An array of playback policy objects that you want applied to this asset and available through playback_ids. advanced_playback_policies must be used instead of playback_policies when creating a DRM playback ID. */
+  advanced_playback_policies: AdvancedPlaybackPolicy[]
 
   /** Arbitrary user-supplied metadata that will be included in the asset details and related webhooks.  */
   passthrough?: string
 }
 
+/** Used by advanced_playback_policies, allows to define DRM config. */
+export type AdvancedPlaybackPolicy = {
+  policy: PlaybackPolicy
+  drm_configuration_id?: string
+}
+
 export interface Secrets {
   token: string | null
   secretKey: string | null
   enableSignedUrls: boolean
   signingKeyId: string | null
   signingKeyPrivate: string | null
+  drmConfigId: string | null
 }
 
 // This narrowed type indicates that there may be assets that are signed, and we have the secrets to access them
@@ -366,7 +391,7 @@ export interface AssetThumbnailOptions {
   asset: Pick<VideoAssetDocument, 'playbackId' | 'data' | 'thumbTime' | 'filename' | 'assetId'>
 }
 
-export type PlaybackPolicy = 'signed' | 'public'
+export type PlaybackPolicy = 'signed' | 'public' | 'drm'
 
 export interface MuxErrors {
   type: string

package/src/util/getPlaybackId.ts

@@ -1,9 +0,0 @@
-import type {VideoAssetDocument} from './types'
-
-export function getPlaybackId(asset: Pick<VideoAssetDocument, 'playbackId'>): string {
-  if (!asset?.playbackId) {
-    console.error('Asset is missing a playbackId', {asset})
-    throw new TypeError(`Missing playbackId`)
-  }
-  return asset.playbackId
-}