sanity-plugin-mux-input 3.0.4 → 4.0.0

package/dist/index.d.cts

@@ -1,347 +0,0 @@
-import type MuxPlayerElement from "@mux/mux-player";
-import type { PartialDeep } from "type-fest";
-import { Plugin as Plugin_2 } from "sanity";
-
-export declare const defaultConfig: PluginConfig;
-
-declare interface MuxAsset {
-  id: string;
-  /** In seconds (instead of JS's default milliseconds) */
-  created_at: string;
-  status: "preparing" | "ready" | "errored";
-  duration: number;
-  max_stored_resolution: "Audio only" | "SD" | "HD" | "FHD" | "UHD";
-  max_stored_frame_rate: -1 | number;
-  aspect_ratio: `${number}:${number}`;
-  playback_ids: MuxPlaybackId[];
-  tracks: MuxTrack[];
-  errors?: MuxErrors;
-  upload_id: string;
-  is_live?: boolean;
-  passthrough: string;
-  live_stream_id?: string;
-  master?: {
-    status: "ready" | "preparing" | "errored";
-    url: string;
-  };
-  master_access: "temporary" | "none";
-  mp4_support: "standard" | "none";
-  source_asset_id?: string;
-  normalize_audio?: boolean;
-  static_renditions?: {
-    status: "ready" | "preparing" | "disabled" | "errored";
-    files: {
-      name: string;
-      ext: "mp4" | "m4a";
-      height: number;
-      width: number;
-      bitrate: number;
-      filesize: string;
-      type: "standard" | "advanced";
-      status: "ready" | "preparing" | "skipped" | "errored";
-      resolution_tier?: string;
-      resolution?: string;
-      id: string;
-      passthrough?: string;
-    }[];
-  };
-  recording_times?: {
-    started_at: string;
-    duration: number;
-    type: "content" | "slate";
-  }[];
-  non_standard_input_reasons?: {
-    video_codec?: string;
-    audio_codec?: string;
-    video_gop_size?: "high";
-    video_frame_rate?: string;
-    video_resolution?: string;
-    video_bitrate?: "high";
-    pixel_aspect_ratio?: string;
-    video_edit_list?: "non-standard";
-    audio_edit_list?: "non-standard";
-    unexpected_media_file_parameters?: "non-standard";
-    test?: boolean;
-  };
-  meta?: {
-    title?: string;
-  };
-}
-
-declare interface MuxAudioTrack {
-  type: "audio";
-  id: string;
-  duration?: number;
-  max_channels: number;
-  max_channel_layout: "stereo" | string;
-}
-
-declare interface MuxErrors {
-  type: string;
-  messages: string[];
-}
-
-export declare const muxInput: Plugin_2<void | Partial<PluginConfig>>;
-
-declare interface MuxInputConfig {
-  /**
-   * Enable static renditions by default. Can be overwritten on a per-asset basis.
-   * Supports:
-   * - Standard mode: 'highest' (up to 4K MP4) and/or 'audio-only' (M4A)
-   * - Advanced mode: Specific resolutions ('270p', '360p', '480p', '540p', '720p', '1080p', '1440p', '2160p') and/or 'audio-only'
-   *
-   * **Important**: 'highest' cannot be mixed with specific resolutions. If both are provided, only 'highest' will be used.
-   *
-   * @see {@link https://docs.mux.com/guides/video/enable-static-mp4-renditions}
-   * @defaultValue []
-   */
-  static_renditions: StaticRenditionResolution[];
-  /**
-   * @deprecated Use `static_renditions` instead. This field is kept for backward compatibility.
-   * Enable static renditions by setting this to 'standard'. Can be overwritten on a per-asset basis.
-   * Requires `"video_quality": "plus"`
-   * @see {@link https://docs.mux.com/guides/video/enable-static-mp4-renditions#why-enable-mp4-support}
-   * @defaultValue 'none'
-   */
-  mp4_support: "none" | "standard";
-  /**
-   * Max resolution tier can be used to control the maximum resolution_tier your asset is encoded, stored, and streamed at.
-   * Requires `"video_quality": "plus"`
-   * @see {@link https://docs.mux.com/guides/stream-videos-in-4k}
-   * @defaultValue '1080p'
-   */
-  max_resolution_tier: "2160p" | "1440p" | "1080p";
-  /**
-   * @deprecated Use {@link video_quality}
-   * <br>
-   * The encoding tier informs the cost, quality, and available platform features for the asset.
-   * @see {@link https://docs.mux.com/guides/use-encoding-tiers}
-   * @defaultValue 'smart'
-   */
-  encoding_tier?: "baseline" | "smart";
-  /**
-   * The video quality level informs the cost, quality, and available platform features for the asset.
-   * @see {@link https://www.mux.com/docs/guides/use-video-quality-levels}
-   * @defaultValue 'plus'
-   */
-  video_quality: "basic" | "plus" | "premium";
-  /**
-   * Normalize the audio track loudness level.
-   * @see {@link https://docs.mux.com/guides/adjust-audio-levels#how-to-turn-on-audio-normalization}
-   * @defaultValue false
-   */
-  normalize_audio: boolean;
-  /**
-   * Enables signed URLs by default, if you configured them with your API token.
-   * @see {@link https://docs.mux.com/guides/secure-video-playback}
-   * @defaultValue false
-   */
-  defaultSigned?: boolean;
-  /**
-   * Enables public URLs by default.
-   * @defaultValue true
-   */
-  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"`
-   *
-   * @see {@link https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts}
-   * @deprecated use `defaultAutogeneratedSubtitleLang` instead. Only a single autogenerated
-   */
-  defaultAutogeneratedSubtitleLangs?: SupportedMuxLanguage[];
-  /**
-   * Auto-generate captions for this language by default. Users can still
-   * Requires `"video_quality": "plus"`
-   *
-   * @see {@link https://docs.mux.com/guides/add-autogenerated-captions-and-use-transcripts}
-   */
-  defaultAutogeneratedSubtitleLang?: SupportedMuxLanguage;
-  /**
-   * Whether or not to allow content editors to override asset upload
-   * configuration settings when uploading a video to Mux.
-   *
-   * @see {@link https://docs.mux.com/guides/secure-video-playback}
-   * @defaultValue false
-   */
-  disableUploadConfig?: boolean;
-  /**
-   * Whether or not to allow content editors to add text tracks alongside their
-   * asset when uploading a video to Mux.
-   *
-   * @see {@link https://docs.mux.com/guides/secure-video-playback}
-   * @defaultValue false
-   */
-  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.
-     *
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept}
-     * @defaultValue ['video/*','audio/*']
-
-     */
-  acceptedMimeTypes?: ("audio/*" | "video/*")[];
-  /**
-   * Maximum file size allowed for video uploads in bytes.
-   * If not specified, no file size validation will be performed.
-   *
-   * @example 1024 * 1024 * 1024 // 1 GB
-   * @defaultValue undefined
-   */
-  maxAssetFileSize?: number;
-  /**
-   * Maximum video duration allowed in seconds.
-   * If not specified, no duration validation will be performed.
-   *
-   * @example 2 * 60 * 60 // 2 hours
-   * @defaultValue undefined
-   */
-  maxAssetDuration?: number;
-  /**
-   * HLS.js configuration options to be passed to the Mux Player.
-   * These options allow you to customize the underlying HLS.js playback engine behavior.
-   *
-   * @see {@link https://github.com/video-dev/hls.js/blob/master/docs/API.md#fine-tuning}
-   * @defaultValue undefined
-   * @example
-   * ```ts
-   * {
-   *   maxBufferLength: 30,
-   *   lowLatencyMode: true,
-   *   capLevelToPlayerSize: true
-   * }
-   * ```
-   */
-  hlsConfig?: MuxPlayerElement["_hlsConfig"];
-}
-
-declare interface MuxPlaybackId {
-  id: string;
-  policy: PlaybackPolicy;
-}
-
-declare interface MuxTextTrack {
-  type: "text";
-  id: string;
-  text_type?: "subtitles";
-  text_source?:
-    | "uploaded"
-    | "embedded"
-    | "generated_live"
-    | "generated_live_final"
-    | "generated_vod";
-  language_code?: "en" | "en-US" | string;
-  name?: "English" | string;
-  closed_captions?: boolean;
-  passthrough?: string;
-  status: "preparing" | "ready" | "errored";
-  error?: {
-    type: string;
-    messages?: string[];
-  };
-}
-
-declare type MuxTrack = MuxVideoTrack | MuxAudioTrack | MuxTextTrack;
-
-declare interface MuxVideoTrack {
-  type: "video";
-  id: string;
-  max_width: number;
-  max_height: number;
-  max_frame_rate: -1 | number;
-  duration?: number;
-}
-
-declare type PlaybackPolicy = "signed" | "public" | "drm";
-
-declare interface PluginConfig extends MuxInputConfig {
-  /**
-   * How the videos browser should appear as a studio tool in Sanity's top navigation
-   *
-   * Pass `false` if you want to disable it.
-   * @defaultValue {title: 'Videos', icon: VideoIcon}
-   **/
-  tool:
-    | false
-    | {
-        title?: string;
-        icon?: React.ComponentType;
-      };
-  /**
-   * The roles that are allowed to configure the plugin.
-   *
-   * If not set, all roles will be allowed to configure the plugin.
-   * @defaultValue []
-   */
-  allowedRolesForConfiguration: string[];
-}
-
-/**
- * All static rendition resolution options supported by Mux
- */
-declare type StaticRenditionResolution =
-  | "highest"
-  | "audio-only"
-  | "270p"
-  | "360p"
-  | "480p"
-  | "540p"
-  | "720p"
-  | "1080p"
-  | "1440p"
-  | "2160p";
-
-declare const SUPPORTED_MUX_LANGUAGES_VALUES: (
-  | "en"
-  | "es"
-  | "it"
-  | "pt"
-  | "de"
-  | "fr"
-  | "pl"
-  | "ru"
-  | "nl"
-  | "ca"
-  | "tr"
-  | "sv"
-  | "uk"
-  | "no"
-  | "fi"
-  | "sk"
-  | "el"
-  | "cs"
-  | "hr"
-  | "da"
-  | "ro"
-  | "bg"
-)[];
-
-declare type SupportedMuxLanguage =
-  (typeof SUPPORTED_MUX_LANGUAGES_VALUES)[number];
-
-export declare interface VideoAssetDocument {
-  _id: string;
-  _type: "mux.videoAsset";
-  _createdAt: string;
-  _updatedAt?: string;
-  status?: string;
-  assetId?: string;
-  playbackId?: string;
-  filename?: string;
-  thumbTime?: number;
-  data?: PartialDeep<MuxAsset>;
-}
-
-export {};

package/sanity.json

@@ -1,8 +0,0 @@
-{
-  "parts": [
-    {
-      "implements": "part:@sanity/base/sanity-root",
-      "path": "./v2-incompatible.js"
-    }
-  ]
-}

package/src/_exports/index.ts

@@ -1,73 +0,0 @@
-import {definePlugin} from 'sanity'
-
-import createStudioTool, {DEFAULT_TOOL_CONFIG} from '../components/StudioTool'
-import {muxVideoCustomRendering} from '../plugin'
-import {muxVideoSchema, schemaTypes} from '../schema'
-import type {PluginConfig, StaticRenditionResolution} from '../util/types'
-export type {VideoAssetDocument} from '../util/types'
-
-export const defaultConfig: PluginConfig = {
-  static_renditions: [],
-  mp4_support: 'none',
-  video_quality: 'plus',
-  max_resolution_tier: '1080p',
-  normalize_audio: false,
-  defaultPublic: true,
-  defaultSigned: false,
-  defaultDrm: false,
-  tool: DEFAULT_TOOL_CONFIG,
-  allowedRolesForConfiguration: [],
-  acceptedMimeTypes: ['video/*', 'audio/*'],
-}
-
-/**
- * Converts legacy mp4_support configuration to static_renditions format
- */
-function convertLegacyConfig(config: Partial<PluginConfig>): {
-  static_renditions: StaticRenditionResolution[]
-} {
-  // If static_renditions is already provided, use it
-  if (config.static_renditions && config.static_renditions.length > 0) {
-    return {static_renditions: config.static_renditions}
-  }
-
-  // Convert legacy mp4_support to static_renditions
-  if (config.mp4_support === 'standard') {
-    return {static_renditions: ['highest']}
-  }
-
-  return {static_renditions: []}
-}
-
-export const muxInput = definePlugin<Partial<PluginConfig> | void>((userConfig) => {
-  // TODO: Remove this on next major version when we end support for encoding_tier
-  if (typeof userConfig === 'object' && 'encoding_tier' in userConfig) {
-    const deprecated_encoding_tier = userConfig.encoding_tier
-    if (!userConfig.video_quality) {
-      if (deprecated_encoding_tier === 'baseline') {
-        userConfig.video_quality = 'basic'
-      }
-      if (deprecated_encoding_tier === 'smart') {
-        userConfig.video_quality = 'plus'
-      }
-    }
-  }
-  const config: PluginConfig = {
-    ...defaultConfig,
-    ...(userConfig || {}),
-    ...convertLegacyConfig(userConfig || {}),
-  }
-  return {
-    name: 'mux-input',
-    schema: {
-      types: [
-        ...schemaTypes,
-        {
-          ...muxVideoSchema,
-          ...muxVideoCustomRendering(config),
-        },
-      ],
-    },
-    tools: config.tool === false ? undefined : [createStudioTool(config)],
-  }
-})

package/src/actions/assets.ts

@@ -1,152 +0,0 @@
-import type {SanityClient} from 'sanity'
-
-import {PLUGIN_VERSION_QUERY} from '../util/pluginVersion'
-import type {MuxAsset, VideoAssetDocument} from '../util/types'
-
-export function deleteAssetOnMux(client: SanityClient, assetId: string) {
-  const {dataset} = client.config()
-  return client.request<void>({
-    url: `/addons/mux/assets/${dataset}/${assetId}`,
-    withCredentials: true,
-    method: 'DELETE',
-    query: PLUGIN_VERSION_QUERY,
-  })
-}
-
-export async function deleteAsset({
-  client,
-  asset,
-  deleteOnMux,
-}: {
-  client: SanityClient
-  asset: VideoAssetDocument
-  deleteOnMux: boolean
-}) {
-  if (!asset?._id) return true
-
-  try {
-    await client.delete(asset._id)
-  } catch (error) {
-    return 'failed-sanity'
-  }
-
-  if (deleteOnMux && asset?.assetId) {
-    try {
-      await deleteAssetOnMux(client, asset.assetId)
-    } catch (error) {
-      return 'failed-mux'
-    }
-  }
-
-  return true
-}
-
-export function getAsset(client: SanityClient, assetId: string) {
-  const {dataset} = client.config()
-  return client.request<{data: MuxAsset}>({
-    url: `/addons/mux/assets/${dataset}/data/${assetId}`,
-    withCredentials: true,
-    method: 'GET',
-    query: PLUGIN_VERSION_QUERY,
-  })
-}
-
-export function listAssets(
-  client: SanityClient,
-  options: {limit?: number; cursor?: string | null}
-) {
-  const {dataset} = client.config()
-  const query: {limit?: string; cursor?: string} = {}
-
-  if (options.limit) {
-    query.limit = options.limit.toString()
-  }
-  if (options.cursor) {
-    query.cursor = options.cursor
-  }
-
-  return client.request<{data: MuxAsset[]; next_cursor?: string | null}>({
-    url: `/addons/mux/assets/${dataset}/data/list`,
-    withCredentials: true,
-    method: 'GET',
-    query: {...query, ...PLUGIN_VERSION_QUERY},
-  })
-}
-
-/**
- * Adds a new text track to an existing asset using a VTT file URL
- */
-export function addTextTrackFromUrl(
-  client: SanityClient,
-  assetId: string,
-  vttUrl: string,
-  options: {
-    language_code: string
-    name: string
-    text_type?: 'subtitles'
-  }
-) {
-  const {dataset} = client.config()
-
-  return client.request<{data: MuxAsset}>({
-    url: `/addons/mux/assets/${dataset}/${assetId}/tracks`,
-    withCredentials: true,
-    method: 'POST',
-    body: {
-      url: vttUrl,
-      type: 'text',
-      language_code: options.language_code,
-      name: options.name,
-      text_type: options.text_type || 'subtitles',
-    },
-    headers: {
-      'Content-Type': 'application/json',
-    },
-    query: PLUGIN_VERSION_QUERY,
-  })
-}
-
-/**
- * Generates subtitles automatically for an audio track
- */
-export function generateSubtitles(
-  client: SanityClient,
-  assetId: string,
-  audioTrackId: string,
-  options: {
-    language_code: string
-    name: string
-  }
-) {
-  const {dataset} = client.config()
-  return client.request<{data: MuxAsset}>({
-    url: `/addons/mux/assets/${dataset}/${assetId}/tracks/${audioTrackId}/generate-subtitles`,
-    withCredentials: true,
-    method: 'POST',
-    body: {
-      generated_subtitles: [
-        {
-          language_code: options.language_code,
-          name: options.name,
-        },
-      ],
-    },
-    headers: {
-      'Content-Type': 'application/json',
-    },
-    query: PLUGIN_VERSION_QUERY,
-  })
-}
-
-/**
- * Deletes a text track from an asset
- */
-export function deleteTextTrack(client: SanityClient, assetId: string, trackId: string) {
-  const {dataset} = client.config()
-  return client.request<{data: MuxAsset}>({
-    url: `/addons/mux/assets/${dataset}/${assetId}/tracks/${trackId}`,
-    withCredentials: true,
-    method: 'DELETE',
-    query: PLUGIN_VERSION_QUERY,
-  })
-}

package/src/actions/secrets.ts

@@ -1,111 +0,0 @@
-import {defer} from 'rxjs'
-import type {SanityClient} from 'sanity'
-
-import {PLUGIN_VERSION_QUERY} from '../util/pluginVersion'
-
-interface SecretsDocument {
-  _id: 'secrets.mux'
-  _type: 'mux.apiKey'
-  token: string
-  secretKey: string
-  enableSignedUrls: boolean
-  signingKeyId: string
-  signingKeyPrivate: string
-  drmConfigId: string
-}
-// eslint-disable-next-line max-params
-export function saveSecrets(
-  client: SanityClient,
-  token: string,
-  secretKey: string,
-  enableSignedUrls: boolean,
-  signingKeyId: string,
-  signingKeyPrivate: string,
-  drmConfigId: string
-): Promise<SecretsDocument> {
-  const doc: SecretsDocument = {
-    _id: 'secrets.mux',
-    _type: 'mux.apiKey',
-    token,
-    secretKey,
-    enableSignedUrls,
-    signingKeyId,
-    signingKeyPrivate,
-    drmConfigId,
-  }
-  doc.signingKeyId = enableSignedUrls ? signingKeyId : ''
-  doc.signingKeyPrivate = enableSignedUrls ? signingKeyPrivate : ''
-
-  return client.createOrReplace(doc)
-}
-
-export async function createSigningKeys(client: SanityClient) {
-  try {
-    const {dataset} = client.config()
-    const res = await client.request<{
-      data: {private_key: string; id: string; created_at: string}
-    }>({
-      url: `/addons/mux/signing-keys/${dataset}`,
-      withCredentials: true,
-      method: 'POST',
-      query: PLUGIN_VERSION_QUERY,
-    })
-    return res
-  } catch (error: any) {
-    console.error('Error creating signing keys', error)
-    const message =
-      error.response?.statusCode === 401
-        ? 'Unauthorized - Failed to create the Signing Key. Please ensure that the token has "System" permissions'
-        : error.message
-    throw new Error(message)
-  }
-}
-
-export function testSecrets(client: SanityClient) {
-  const {dataset} = client.config()
-  return client.request<{status: boolean}>({
-    url: `/addons/mux/secrets/${dataset}/test`,
-    withCredentials: true,
-    method: 'GET',
-    query: PLUGIN_VERSION_QUERY,
-  })
-}
-
-export async function haveValidSigningKeys(
-  client: SanityClient,
-  signingKeyId: string,
-  signingKeyPrivate: string
-) {
-  if (!(signingKeyId && signingKeyPrivate)) {
-    return false
-  }
-
-  const {dataset} = client.config()
-  try {
-    const res = await client.request<{data: {id: string; created_at: string}}>({
-      url: `/addons/mux/signing-keys/${dataset}/${signingKeyId}`,
-      withCredentials: true,
-      method: 'GET',
-      query: PLUGIN_VERSION_QUERY,
-    })
-    //
-    // if this signing key is valid it will return { data: { id: 'xxxx' } }
-    //
-    return !!(res.data && res.data.id)
-  } catch (e) {
-    console.error('Error fetching signingKeyId', signingKeyId, 'assuming it is not valid')
-    return false
-  }
-}
-
-export function testSecretsObservable(client: SanityClient) {
-  const {dataset} = client.config()
-  return defer(() =>
-    client.observable.request<{status: boolean}>({
-      url: `/addons/mux/secrets/${dataset}/test`,
-      withCredentials: true,
-      method: 'GET',
-      query: PLUGIN_VERSION_QUERY,
-    })
-  )
-}