@pbvision/partner-sdk 0.0.3 → 0.1.1

package/README.md

@@ -76,8 +76,14 @@ Next, tell us to download and work on the video. You can do this using our SDK:
 import { PBVision } from '@pbvision/partner-sdk'
 
 const pbv = new PBVision(YOUR_API_KEY)
-const userEmails = [] // optional!
-await pbv.sendVideoUrlToDownload(YOUR_VIDEO_URL, userEmails)
+// you can omit this metadata, or provide some or all of this object-- whatever you'd like!
+const optionalMetadata = {
+  userEmails: [],
+  name: 'Dink Championship 2024',
+  desc: 'A longer description, if you want',
+  gameStartEpoch: 1711393200 // when the game was played
+}
+await pbv.sendVideoUrlToDownload(YOUR_VIDEO_URL, optionalMetadata)
 ```
 
 Alternatively, you can just use `curl`:
@@ -98,7 +104,7 @@ You can directly upload your video from a file using the SDK too:
 import { PBVision } from '@pbvision/partner-sdk'
 
 const pbv = new PBVision(YOUR_API_KEY)
-// you can omit this metadata, or provide it-- whatever you'd like!
+// you can omit this metadata, or provide some or all of this object-- whatever you'd like!
 const optionalMetadata = {
   userEmails: [],
   name: 'Dink Championship 2024',
@@ -124,6 +130,7 @@ The HTTP POST body will contain JSON which looks like this:
 {
     "from_url": "https://example.com/my-video.mp4",
     "webpage": "https://app.pb.vision/video/xyz",
+    "cutVideo": "https://storage.googleapis.com/pbv-pro/xyz/f50272db-69a8-49ed-9d92-3a4d067af87c/rallies.mp4",
     "events": EVENTS_DATA,
     "insights": INSIGHTS_DATA,
     "error": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pbvision/partner-sdk",
   "description": "SDK for interacting with the PB Vision pickleball AI engine.",
-  "version": "0.0.3",
+  "version": "0.1.1",
   "license": "MIT",
   "type": "module",
   "engines": {

package/src/index.js

@@ -43,14 +43,15 @@ export class PBVision {
    * processing is complete, your webhook URL will receive a callback.
    *
    * @param {string} videoUrl the publicly available URL of the video
-   * @param {Array<string>} [userEmails] the email addresses of players in
-   *   this video; they'll be notified when the video is done processing
+   * @param {VideoMetadata} [metadata]
    */
-  async sendVideoUrlToDownload (videoUrl, userEmails = []) {
+  async sendVideoUrlToDownload (videoUrl, { userEmails = [], name, desc, gameStartEpoch } = {}) {
     assert(typeof videoUrl === 'string' && videoUrl.startsWith('http'),
       'URL must be a string beginning with http')
-    assert(videoUrl.endsWith('.mp4'), 'video URL must have the .mp4 extension')
-    this.__callAPI('add_video_by_url', { url: videoUrl, userEmails })
+    assert(videoUrl.split('?')[0].endsWith('.mp4'), 'video URL must have the .mp4 extension')
+    this.__callAPI(
+      'add_video_by_url',
+      { url: videoUrl, userEmails, name, desc, gameStartEpoch })
   }
 
   async __callAPI (path, body) {