sanity-plugin-mux-input 3.0.4 → 4.0.0

package/README.md

@@ -1,7 +1,5 @@
 # Mux Video Input Sanity Plugin
 
-> For the v2 version, please refer to the [v2-branch](https://github.com/sanity-io/sanity-plugin-mux-input/tree/studio-v2).
-
 This plugin lets you use [Mux](https://www.mux.com) video assets in your Sanity studio.
 
 The Mux plugin for Sanity allows you to easily upload and preview videos.

package/dist/index.d.ts

@@ -1,89 +1,10 @@
-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 {
+import MuxPlayerElement from "@mux/mux-player";
+import { PartialDeep } from "type-fest";
+/**
+ * All static rendition resolution options supported by Mux
+ */
+type StaticRenditionResolution = 'highest' | 'audio-only' | '270p' | '360p' | '480p' | '540p' | '720p' | '1080p' | '1440p' | '2160p';
+interface MuxInputConfig {
   /**
    * Enable static renditions by default. Can be overwritten on a per-asset basis.
    * Supports:
@@ -103,14 +24,14 @@ declare interface MuxInputConfig {
    * @see {@link https://docs.mux.com/guides/video/enable-static-mp4-renditions#why-enable-mp4-support}
    * @defaultValue 'none'
    */
-  mp4_support: "none" | "standard";
+  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";
+  max_resolution_tier: '2160p' | '1440p' | '1080p';
   /**
    * @deprecated Use {@link video_quality}
    * <br>
@@ -118,13 +39,13 @@ declare interface MuxInputConfig {
    * @see {@link https://docs.mux.com/guides/use-encoding-tiers}
    * @defaultValue 'smart'
    */
-  encoding_tier?: "baseline" | "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";
+  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}
@@ -186,13 +107,12 @@ declare interface MuxInputConfig {
    */
   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/*")[];
+   * 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.
@@ -224,61 +144,19 @@ declare interface MuxInputConfig {
    * }
    * ```
    */
-  hlsConfig?: MuxPlayerElement["_hlsConfig"];
+  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 {
+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;
-      };
+  tool: false | {
+    title?: string;
+    icon?: React.ComponentType;
+  };
   /**
    * The roles that are allowed to configure the plugin.
    *
@@ -287,53 +165,114 @@ declare interface PluginConfig extends MuxInputConfig {
    */
   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 {
+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")[];
+type SupportedMuxLanguage = (typeof SUPPORTED_MUX_LANGUAGES_VALUES)[number];
+type PlaybackPolicy = 'signed' | 'public' | 'drm';
+interface MuxErrors {
+  type: string;
+  messages: string[];
+}
+interface MuxPlaybackId {
+  id: string;
+  policy: PlaybackPolicy;
+}
+interface MuxVideoTrack {
+  type: 'video';
+  id: string;
+  max_width: number;
+  max_height: number;
+  max_frame_rate: -1 | number;
+  duration?: number;
+}
+interface MuxAudioTrack {
+  type: 'audio';
+  id: string;
+  duration?: number;
+  max_channels: number;
+  max_channel_layout: 'stereo' | string;
+}
+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[];
+  };
+}
+type MuxTrack = MuxVideoTrack | MuxAudioTrack | MuxTextTrack;
+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;
+  };
+}
+interface VideoAssetDocument {
   _id: string;
-  _type: "mux.videoAsset";
+  _type: 'mux.videoAsset';
   _createdAt: string;
   _updatedAt?: string;
   status?: string;
@@ -343,5 +282,7 @@ export declare interface VideoAssetDocument {
   thumbTime?: number;
   data?: PartialDeep<MuxAsset>;
 }
-
-export {};
+declare const defaultConfig: PluginConfig;
+declare const muxInput: import("sanity").Plugin<void | Partial<PluginConfig>>;
+export { type VideoAssetDocument, defaultConfig, muxInput };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/util/types.ts","../src/_exports/index.ts"],"mappings":";;AAOA;;;AAAA,KAAY,yBAAA;AAAA,UAYK,cAAA;EAAA;;;;;;;;;;;EAYf,iBAAA,EAAmB,yBAAA;EAiBnB;;;;;;;EARA,WAAA;EA4DoC;;;;;;EApDpC,mBAAA;EAuGA;;;;;AA0B4B;AAG9B;EA3HE,aAAA;;;;;;EAOA,aAAA;EA+Ha;;;;AASe;EAjI5B,eAAA;EA6JsF;;;AAAA;AAExF;EAxJE,aAAA;;;AAwJuE;AA6LzE;EA/UE,aAAA;;;AA+UwB;AAE1B;;EA1UE,UAAA;EA2UA;AACQ;AAGV;;;;;EAtUE,iCAAA,GAAoC,oBAAA;EAwU5B;;AAAc;AAGxB;;;EAnUE,gCAAA,GAAmC,oBAAA;EAoUnC;;;;;;;EA3TA,mBAAA;EAoUe;;;;;;;EA3Tf,sBAAA;EAgUA;;AAAkB;AAEpB;;EA3TE,yBAAA;EA2T2B;;;;;;EAlT3B,iBAAA;EAmUA;;;;;;AAIU;EA9TV,gBAAA;EAiUkB;;;;;;;EAxTlB,gBAAA;EAwTqC;;;AAA4B;AAEnE;;;;;;;;;;;EAzSE,SAAA,GAAY,gBAAA;AAAA;AAAA,UAGG,YAAA,SAAqB,cAAc;EAgTlD;;;;;;EAzSA,IAAA;IAGM,KAAA;IACA,IAAA,GAAO,KAAA,CAAM,aAAA;EAAA;EA6SnB;;;;;;EApSA,4BAAA;AAAA;AAAA,cA4BW,8BAAA;AAAA,KAED,oBAAA,WAA+B,8BAA8B;AAAA,KA6L7D,cAAA;AAAA,UAEK,SAAA;EACf,IAAA;EACA,QAAQ;AAAA;AAAA,UAGO,aAAA;EACf,EAAA;EACA,MAAA,EAAQ,cAAc;AAAA;AAAA,UAGP,aAAA;EACf,IAAA;EACA,EAAA;EACA,SAAA;EACA,UAAA;EAEA,cAAA;EAEA,QAAA;AAAA;AAAA,UAEe,aAAA;EACf,IAAA;EACA,EAAA;EACA,QAAA;EACA,YAAA;EACA,kBAAA;AAAA;AAAA,UAEe,YAAA;EACf,IAAA;EACA,EAAA;EACA,SAAA;EAEA,WAAA;EAOA,aAAA;EAEA,IAAA;EACA,eAAA;EAEA,WAAA;EACA,MAAA;EACA,KAAA;IACE,IAAA;IACA,QAAA;EAAA;AAAA;AAAA,KAGQ,QAAA,GAAW,aAAA,GAAgB,aAAA,GAAgB,YAAA;AAAA,UAEtC,QAAA;EACf,EAAA;;EAEA,UAAA;EACA,MAAA;EACA,QAAA;EACA,qBAAA;EAEA,qBAAA;EAEA,YAAA;EACA,YAAA,EAAc,aAAA;EACd,MAAA,EAAQ,QAAA;EACR,MAAA,GAAS,SAAA;EACT,SAAA;EACA,OAAA;EAEA,WAAA;EACA,cAAA;EACA,MAAA;IACE,MAAA;IAEA,GAAA;EAAA;EAEF,aAAA;EACA,WAAA;EAEA,eAAA;EAEA,eAAA;EAEA,iBAAA;IACE,MAAA;IACA,KAAA;MACE,IAAA;MACA,GAAA;MACA,MAAA;MACA,KAAA;MACA,OAAA;MACA,QAAA;MACA,IAAA;MACA,MAAA;MACA,eAAA;MACA,UAAA;MACA,EAAA;MACA,WAAA;IAAA;EAAA;EAGJ,eAAA;IACE,UAAA;IACA,QAAA;IACA,IAAA;EAAA;EAGF,0BAAA;IACE,WAAA;IACA,WAAA;IACA,cAAA;IACA,gBAAA;IACA,gBAAA;IACA,aAAA;IACA,kBAAA;IACA,eAAA;IACA,eAAA;IACA,gCAAA;IACA,IAAA;EAAA;EAEF,IAAA;IACE,KAAA;EAAA;AAAA;AAAA,UAIa,kBAAA;EACf,GAAA;EACA,KAAA;EACA,UAAA;EACA,UAAA;EACA,MAAA;EACA,OAAA;EACA,UAAA;EACA,QAAA;EACA,SAAA;EAEA,IAAA,GAAO,WAAW,CAAC,QAAA;AAAA;AAAA,cCriBR,aAAA,EAAe,YAY3B;AAAA,cAqBY,QAAA,mBAAQ,MAAA,QAAA,OAAA,CAAA,YAAA"}