sanity-plugin-mux-input 2.4.1 → 2.6.0

package/README.md

@@ -77,19 +77,19 @@ The Mux plugin will find its access tokens by fetching this document.
 
 When a Mux video is uploaded/chosen in a document via this plugin, it gets stored as a reference to the video document:
 
-```json
+```json5
 // example document
 {
-  "_type": "exampleSchemaWithVideo",
+  _type: 'exampleSchemaWithVideo',
   // Example video field
-  "myVideoField": {
-    "_type": "mux.video",
-    "asset": {
-      "_type": "reference",
-      "_weak": true,
-      "_ref": "4e37284e-cec2-406d-973c-fdf9ab1e5598" // 👈 ID of the document holding the video's Mux data
-    }
-  }
+  myVideoField: {
+    _type: 'mux.video',
+    asset: {
+      _type: 'reference',
+      _weak: true,
+      _ref: '4e37284e-cec2-406d-973c-fdf9ab1e5598', // 👈 ID of the document holding the video's Mux data
+    },
+  },
 }
 ```
 
@@ -112,54 +112,55 @@ Before you can display videos in your frontend, you need to follow these referen
 
 For reference, here's an example `mux.videoAsset` document:
 
-```json
+```json5
 {
-  "_id": "4e37284e-cec2-406d-973c-fdf9ab1e5598",
-  "_type": "mux.videoAsset",
-  "assetId": "7ovyI76F92n02H00mWP7lOCZMIU00N4iysDiQDNppX026HY",
-  "filename": "mux-example-video.mp4",
-  "status": "ready",
-  "playbackId": "YA02HBpY02fKWHDRMNilo301pdH02LY3k9HTcK43ItGJLWA",
+  _id: '4e37284e-cec2-406d-973c-fdf9ab1e5598',
+  _type: 'mux.videoAsset',
+  assetId: '7ovyI76F92n02H00mWP7lOCZMIU00N4iysDiQDNppX026HY',
+  filename: 'mux-example-video.mp4',
+  status: 'ready',
+  playbackId: 'YA02HBpY02fKWHDRMNilo301pdH02LY3k9HTcK43ItGJLWA',
+  thumbTime: 65.82,
   // Full Mux asset data:
-  "data": {
-    "encoding_tier": "smart",
-    "max_resolution_tier": "1080p",
-    "aspect_ratio": "16:9",
-    "created_at": "1706645034",
-    "duration": 25.492133,
-    "status": "ready",
-    "master_access": "none",
-    "max_stored_frame_rate": 29.97,
-    "playback_ids": [
+  data: {
+    encoding_tier: 'smart',
+    max_resolution_tier: '1080p',
+    aspect_ratio: '16:9',
+    created_at: '1706645034',
+    duration: 25.492133,
+    status: 'ready',
+    master_access: 'none',
+    max_stored_frame_rate: 29.97,
+    playback_ids: [
       {
-        "id": "YA02HBpY02fKWHDRMNilo301pdH02LY3k9HTcK43ItGJLWA",
-        "policy": "signed"
-      }
+        id: 'YA02HBpY02fKWHDRMNilo301pdH02LY3k9HTcK43ItGJLWA',
+        policy: 'signed',
+      },
     ],
-    "resolution_tier": "1080p",
-    "ingest_type": "on_demand_url",
-    "max_stored_resolution": "HD",
-    "tracks": [
+    resolution_tier: '1080p',
+    ingest_type: 'on_demand_url',
+    max_stored_resolution: 'HD',
+    tracks: [
       {
-        "max_channel_layout": "stereo",
-        "max_channels": 2,
-        "id": "00MKMC73SYimw1YTh0102lPJJp9w2R5rHddpNX1N9opAMk",
-        "type": "audio",
-        "primary": true,
-        "duration": 25.45
+        max_channel_layout: 'stereo',
+        max_channels: 2,
+        id: '00MKMC73SYimw1YTh0102lPJJp9w2R5rHddpNX1N9opAMk',
+        type: 'audio',
+        primary: true,
+        duration: 25.45,
       },
       {
-        "max_frame_rate": 29.97,
-        "max_height": 1080,
-        "id": "g1wEph3CVvbJL01YNKzAWMyH8N1SxW00WeECGjqwEHW9g",
-        "type": "video",
-        "duration": 25.4254,
-        "max_width": 1920
-      }
+        max_frame_rate: 29.97,
+        max_height: 1080,
+        id: 'g1wEph3CVvbJL01YNKzAWMyH8N1SxW00WeECGjqwEHW9g',
+        type: 'video',
+        duration: 25.4254,
+        max_width: 1920,
+      },
     ],
-    "id": "7ovyI76F92n02H00mWP7lOCZMIU00N4iysDiQDNppX026HY",
-    "mp4_support": "none"
-  }
+    id: '7ovyI76F92n02H00mWP7lOCZMIU00N4iysDiQDNppX026HY',
+    mp4_support: 'none',
+  },
 }
 ```
 
@@ -187,6 +188,8 @@ export default function MuxVideo({playbackId, title}: {playbackId?: string; titl
 
 To enable [signed URLs](https://docs.mux.com/docs/security-signed-urls) with content uploaded to Mux, you will need to check the "Enable Signed Urls" option in the Mux Plugin configuration. This feature requires you to set the API Access Token and Secret Key (as per the [Quick start](#quick-start) section).
 
+⚠️ **Important:** To use Signed URLs, the API Access Token must have **System permissions**. Without these permissions, the signing key cannot be created, and authentication will fail.
+
 📌 **Note**: When the signed URL option is triggered, the plugin will cache a `signingKeyPrivate` in a private document in the dataset. This key is used by Mux to sign the uploads, and if it's incorrect your uploads will fail. If that's the case, you can delete the secrets document and try again:
 
 ```bash
@@ -279,7 +282,7 @@ Issues are actively monitored and PRs are welcome. When developing this plugin t
 
 ### Publishing
 
-Run the ["CI" workflow](https://github.com/sanity-io/sanity-plugin-mux-input/actions/workflows/ci.yml).
+You can run the ["CI and Release" workflow](<[https://github.com/sanity-io/sanity-plugin-mux-input/actions/workflows/ci.yml](https://github.com/sanity-io/sanity-plugin-mux-input/actions/workflows/main.yml)>).
 Make sure to select the main branch and check "Release new version".
 
 Semantic release will only release on configured branches, so it is safe to run release on any branch.
@@ -301,11 +304,12 @@ After Studio v3 turns stable this behavior will change. The v2 version will then
 
 ### Develop & test
 
-This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
-with default configuration for build & watch scripts.
+You can run the example locally by doing the following:
 
-See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
-on how to run this plugin with hotreload in the studio.
+1. run `npm install` and `npm dev` on the root of the repo
+2. In the terminal, a command with `yalc` will be shown, that command will allow you to run the version that you have locally directly on the example or on your own app.
+3. run `npm install` and `npm dev` on the `/example` directory where the app with the example exists or in your own app
+4. the studio and app should auto reload with your changes in the plugin package you have locally
 
 ### Release new version