@cliff-studio/sanity-plugin-bunny-input 1.2.0 → 2.0.0

package/README.md

@@ -1,37 +1,21 @@
-# @cliffstudio/sanity-plugin-bunny-input
+# @cliff-studio/sanity-plugin-bunny-input
 
 A Sanity Studio plugin for uploading and managing videos via [Bunny Stream](https://bunny.net/stream/).
 
 ## Features
 
-- Drag & drop video uploads directly in Sanity Studio
+- Upload videos directly from Sanity Studio
+- Browse and select existing videos from your Bunny collection
 - Upload progress indicator
 - Automatic status polling (uploading → processing → ready)
 - Thumbnail preview when video is ready
-- Video deletion support
+- Stores video metadata (dimensions, duration, orientation, URLs)
+- Proxy endpoint support to keep your API key server-side
 
 ## Installation
 
-### From GitHub (private repo)
-
 ```bash
-npm install github:cliffstudio/sanity-plugin-bunny-input
-```
-
-Or add to your `package.json`:
-
-```json
-{
-  "dependencies": {
-    "@cliffstudio/sanity-plugin-bunny-input": "github:cliffstudio/sanity-plugin-bunny-input"
-  }
-}
-```
-
-### From npm (if published)
-
-```bash
-npm install @cliffstudio/sanity-plugin-bunny-input
+npm install @cliff-studio/sanity-plugin-bunny-input
 ```
 
 ## Setup
@@ -41,25 +25,27 @@ npm install @cliffstudio/sanity-plugin-bunny-input
 1. Log in to [bunny.net](https://bunny.net)
 2. Go to **Stream** → Create or select a **Video Library**
 3. Find your **Library ID** (numeric ID in the URL or settings)
-4. Go to **API** section to find your **Stream API Key**
+4. Find your **CDN Hostname** in the library settings (e.g. `vz-abc123-xyz.b-cdn.net`)
+5. Go to the **API** section to find your **Stream API Key**
 
 ### 2. Add the plugin to your Sanity config
 
 ```ts
 // sanity.config.ts
 import {defineConfig} from 'sanity'
-import {bunnyInput} from '@cliffstudio/sanity-plugin-bunny-input'
+import {bunnyInput} from '@cliff-studio/sanity-plugin-bunny-input'
 
 export default defineConfig({
   // ... other config
   plugins: [
     bunnyInput({
       libraryId: process.env.SANITY_STUDIO_BUNNY_LIBRARY_ID,
-      // Optional: auto-create/use this Bunny Stream collection (folder) for uploads
+      cdnHostname: process.env.SANITY_STUDIO_BUNNY_CDN_HOSTNAME,
+      apiKey: process.env.SANITY_STUDIO_BUNNY_API_KEY,
+      // Optional: scope uploads and browsing to a specific collection
       collectionName: process.env.SANITY_STUDIO_BUNNY_COLLECTION_NAME,
-      // Optional alternative: hardcode an existing collection GUID
+      // Optional alternative: use an existing collection GUID directly
       // collectionId: process.env.SANITY_STUDIO_BUNNY_COLLECTION_ID,
-      apiKey: process.env.SANITY_STUDIO_BUNNY_API_KEY,
     }),
   ],
 })
@@ -67,14 +53,12 @@ export default defineConfig({
 
 ### 3. Configure environment variables
 
-#### For Sanity Studio (`.env`)
-
 ```bash
 SANITY_STUDIO_BUNNY_LIBRARY_ID=your-library-id
-SANITY_STUDIO_BUNNY_COLLECTION_NAME=my-project-videos
-# Optional alternative:
-# SANITY_STUDIO_BUNNY_COLLECTION_ID=existing-collection-guid
+SANITY_STUDIO_BUNNY_CDN_HOSTNAME=vz-abc123-xyz.b-cdn.net
 SANITY_STUDIO_BUNNY_API_KEY=your-api-key
+# Optional:
+SANITY_STUDIO_BUNNY_COLLECTION_NAME=my-project-videos
 ```
 
 ### 4. Use in your schemas
@@ -97,14 +81,25 @@ export default defineType({
 
 ## Collections (folders)
 
-You can route uploads into a Bunny Stream collection (folder):
+You can scope uploads and library browsing to a Bunny Stream collection (folder):
 
-- Set `collectionId` to use an existing collection GUID directly.
-- Or set `collectionName` to auto-create/use a collection by name.
-- If you use `collectionName`, the plugin will look up/create that collection before upload.
+- Set `collectionName` to auto-create/use a collection by name.
+- Or set `collectionId` to use an existing collection GUID directly.
 
 `collectionId` takes precedence if both are provided.
 
+## Security
+
+Passing `apiKey` directly exposes your Bunny API key in the browser. For production use, set up a `proxyEndpoint` instead — a small server-side proxy that adds the API key before forwarding requests to Bunny. Pass `proxyEndpoint` in place of `apiKey`:
+
+```ts
+bunnyInput({
+  libraryId: process.env.SANITY_STUDIO_BUNNY_LIBRARY_ID,
+  cdnHostname: process.env.SANITY_STUDIO_BUNNY_CDN_HOSTNAME,
+  proxyEndpoint: process.env.SANITY_STUDIO_BUNNY_PROXY_URL,
+})
+```
+
 ## Schema
 
 The `bunnyVideo` type stores:
@@ -112,16 +107,20 @@ The `bunnyVideo` type stores:
 ```ts
 {
   _type: 'bunnyVideo',
-  videoId: string,      // Bunny's GUID
-  libraryId: string,    // Your library ID
+  videoId: string,         // Bunny's GUID
+  libraryId: string,       // Your library ID
   collectionId?: string,   // Bunny collection GUID (if configured)
   collectionName?: string, // Bunny collection name (if configured)
-  title: string,        // Video title
+  title: string,           // Video title
   status: 'uploading' | 'processing' | 'ready' | 'error',
-  thumbnailUrl: string, // Auto-generated thumbnail
-  playbackUrl: string,  // HLS playlist URL
-  mp4Url: string,       // Direct MP4 URL
-  duration: number,     // Duration in seconds
+  width: number,           // Video width in pixels
+  height: number,          // Video height in pixels
+  ratio: number,           // width / height
+  orientation: 'landscape' | 'portrait' | 'square',
+  duration: number,        // Duration in seconds
+  thumbnailUrl: string,    // Auto-generated thumbnail
+  playbackUrl: string,     // HLS playlist URL
+  mp4Url: string,          // Direct MP4 URL (highest available resolution)
 }
 ```