@portpowered/reference-data 0.4.7 → 0.4.8

package/generated/public/docs/references/schemas/MediaSearchInterfaceMediaDetailsMessage.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "x-namespace": "port1/systems/zero/capability-interfaces/media-search",
+  "x-name": "media-details",
+  "x-version": "1.0",
+  "x-type": "message",
+  "x-directionality": "out",
+  "description": "Exact media resource details and a bounded page of its children.",
+  "type": "object",
+  "properties": {
+    "mediaId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string"
+    },
+    "resourceKind": {
+      "type": "string",
+      "description": "Provider resource kind from the media URI."
+    },
+    "tracks": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/Track.json"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "$ref": "/docs/references/schemas/PodcastEpisode.json"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "mediaId",
+    "resourceKind"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/MediaSearchInterfaceSearchMediaMessage.json

@@ -13,7 +13,7 @@
     },
     "type": {
       "type": "string",
-      "description": "Supported types, track, album, artist, playlist. Defaults to track",
+      "description": "Resource kind: track, album, artist, playlist, show or episode when advertised. Defaults to track",
       "default": "track"
     },
     "album": {
@@ -27,6 +27,18 @@
     "year": {
       "type": "string",
       "description": "Search by year, can only be used when searching albums, years, and tracks. You can pass a range like 1990-2000"
+    },
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20,
+      "description": "Maximum results on one page."
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Copy the opaque continuation from the previous result with the same query and filters."
     }
   },
   "required": [

package/generated/public/docs/references/schemas/Playlist.json

@@ -11,6 +11,14 @@
       "type": "string",
       "description": "Playlist name",
       "minLength": 1
+    },
+    "ownerId": {
+      "type": "string",
+      "description": "Provider-scoped owner identity, when supplied by the provider."
+    },
+    "ownerName": {
+      "type": "string",
+      "description": "Owner display name, useful for distinguishing owned and followed playlists."
     }
   },
   "required": [

package/generated/public/docs/references/schemas/PodcastEpisode.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Provider-qualified podcast episode with selection metadata.",
+  "properties": {
+    "id": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "showId": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "releaseDate": {
+      "type": "string",
+      "description": "Provider release date; precision can be year, month or day."
+    },
+    "releaseDatePrecision": {
+      "type": "string",
+      "description": "Provider date precision."
+    }
+  },
+  "required": [
+    "id",
+    "name"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/PodcastShow.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "description": "Provider-qualified podcast series; read episodes before playback.",
+  "properties": {
+    "id": {
+      "$ref": "/docs/references/schemas/MediaId.json"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "publisher": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "id",
+    "name"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/SupportedMediaResource.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "SupportedMediaResource",
+  "description": "A provider, media type and resource-kind combination accepted by a control route.",
+  "type": "object",
+  "properties": {
+    "provider": {
+      "$ref": "/docs/references/schemas/MediaProvider.json"
+    },
+    "mediaType": {
+      "type": "string",
+      "enum": [
+        "AUDIO",
+        "VIDEO",
+        "IMAGE"
+      ]
+    },
+    "resourceKinds": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "description": "Lowercase resource-kind segment from the provider URI."
+      }
+    }
+  },
+  "required": [
+    "provider",
+    "mediaType",
+    "resourceKinds"
+  ],
+  "additionalProperties": false
+}

package/generated/public/docs/references/schemas/configuration-6.json

@@ -18,7 +18,9 @@
           "ARTIST",
           "PLAYLIST",
           "GENRE",
-          "YEAR"
+          "YEAR",
+          "SHOW",
+          "EPISODE"
         ],
         "x-enum-varnames": [
           "Configuration6SupportedSearchTypesTrack",
@@ -26,7 +28,9 @@
           "Configuration6SupportedSearchTypesArtist",
           "Configuration6SupportedSearchTypesPlaylist",
           "Configuration6SupportedSearchTypesGenre",
-          "Configuration6SupportedSearchTypesYear"
+          "Configuration6SupportedSearchTypesYear",
+          "Configuration6SupportedSearchTypesShow",
+          "Configuration6SupportedSearchTypesEpisode"
         ]
       },
       "description": "List of supported search types"

package/generated/public/docs/references/schemas/index.json

@@ -2095,6 +2095,12 @@
       "path": "/docs/references/schemas/MediaPlayerInterfaceNextMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceNextMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaPlayerInterfaceNowPlayingAttribute",
+      "path": "/docs/references/schemas/MediaPlayerInterfaceNowPlayingAttribute.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlayerInterfaceNowPlayingAttribute"
+    },
     {
       "kind": "schemas",
       "name": "MediaPlayerInterfacePauseMessage",
@@ -2209,6 +2215,24 @@
       "path": "/docs/references/schemas/MediaPlaylistInterfaceGetPlaylistMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceGetPlaylistMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaPlaylistInterfaceListPlaylistsMessage",
+      "path": "/docs/references/schemas/MediaPlaylistInterfaceListPlaylistsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfaceListPlaylistsMessage"
+    },
+    {
+      "kind": "schemas",
+      "name": "MediaPlaylistInterfacePlaylistContentsMessage",
+      "path": "/docs/references/schemas/MediaPlaylistInterfacePlaylistContentsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfacePlaylistContentsMessage"
+    },
+    {
+      "kind": "schemas",
+      "name": "MediaPlaylistInterfacePlaylistsMessage",
+      "path": "/docs/references/schemas/MediaPlaylistInterfacePlaylistsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaPlaylistInterfacePlaylistsMessage"
+    },
     {
       "kind": "schemas",
       "name": "MediaPlaylistInterfacePlayPlaylistMessage",
@@ -2245,6 +2269,18 @@
       "path": "/docs/references/schemas/MediaSearchInterfaceAudioMediaResultsMessage.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/MediaSearchInterfaceAudioMediaResultsMessage"
     },
+    {
+      "kind": "schemas",
+      "name": "MediaSearchInterfaceGetMediaMessage",
+      "path": "/docs/references/schemas/MediaSearchInterfaceGetMediaMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaSearchInterfaceGetMediaMessage"
+    },
+    {
+      "kind": "schemas",
+      "name": "MediaSearchInterfaceMediaDetailsMessage",
+      "path": "/docs/references/schemas/MediaSearchInterfaceMediaDetailsMessage.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/MediaSearchInterfaceMediaDetailsMessage"
+    },
     {
       "kind": "schemas",
       "name": "MediaSearchInterfaceSearchMediaMessage",
@@ -2791,6 +2827,18 @@
       "path": "/docs/references/schemas/PM25ConcentrationMeasurementInterfaceMeasuredValueAttribute.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/PM25ConcentrationMeasurementInterfaceMeasuredValueAttribute"
     },
+    {
+      "kind": "schemas",
+      "name": "PodcastEpisode",
+      "path": "/docs/references/schemas/PodcastEpisode.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/PodcastEpisode"
+    },
+    {
+      "kind": "schemas",
+      "name": "PodcastShow",
+      "path": "/docs/references/schemas/PodcastShow.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/PodcastShow"
+    },
     {
       "kind": "schemas",
       "name": "Position",
@@ -3853,6 +3901,12 @@
       "path": "/docs/references/schemas/SupportedInput.json",
       "source": "/docs/references/openapi.yaml#/components/schemas/SupportedInput"
     },
+    {
+      "kind": "schemas",
+      "name": "SupportedMediaResource",
+      "path": "/docs/references/schemas/SupportedMediaResource.json",
+      "source": "/docs/references/openapi.yaml#/components/schemas/SupportedMediaResource"
+    },
     {
       "kind": "schemas",
       "name": "SynchronizationItemError",

package/generated/resources/media-player/configuration.json

@@ -2,6 +2,43 @@
   "description": "Media players select media by its Port OS media ID, play supplied audio or a URI, and control playback. Read playback state and use only the commands supported by the connected player.",
   "type": "object",
   "properties": {
+    "supportedMediaResources": {
+      "type": "array",
+      "description": "Exact play-media URI combinations accepted by this route. Member or endpoint unions do not imply support by every route.",
+      "items": {
+        "title": "SupportedMediaResource",
+        "description": "A provider, media type and resource-kind combination accepted by a control route.",
+        "type": "object",
+        "properties": {
+          "provider": {
+            "$ref": "#/properties/supportedAudioProviders/items"
+          },
+          "mediaType": {
+            "type": "string",
+            "enum": [
+              "AUDIO",
+              "VIDEO",
+              "IMAGE"
+            ]
+          },
+          "resourceKinds": {
+            "type": "array",
+            "minItems": 1,
+            "uniqueItems": true,
+            "items": {
+              "type": "string",
+              "description": "Lowercase resource-kind segment from the provider URI."
+            }
+          }
+        },
+        "required": [
+          "provider",
+          "mediaType",
+          "resourceKinds"
+        ],
+        "additionalProperties": false
+      }
+    },
     "supportedAudioProviders": {
       "type": "array",
       "uniqueItems": true,

package/generated/resources/media-player/message-play-media.json

@@ -5,7 +5,9 @@
       "title": "MediaId",
       "type": "string",
       "minLength": 1,
-      "description": "Media IDs are a standardized identifier that Port OS uses to represent media across YouTube, Spotify, and other media providers. See https://portpowered.com/docs/media for the current media identifiers documentation."
+      "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+      "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+      "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
     }
   },
   "required": [

package/generated/resources/media-player/state-now-playing.json

@@ -0,0 +1,27 @@
+{
+  "description": "Media identity observed on this route. Active false means the provider session is on another target; it does not prove the speaker is silent through other providers.",
+  "type": "object",
+  "properties": {
+    "active": {
+      "type": "boolean"
+    },
+    "mediaId": {
+      "title": "MediaId",
+      "type": "string",
+      "minLength": 1,
+      "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+      "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+      "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
+    },
+    "contextMediaId": {
+      "$ref": "#/properties/mediaId"
+    },
+    "name": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "active"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/media-playlist/message-get-playlist.json

@@ -5,6 +5,17 @@
       "type": "string",
       "description": "ID of the playlist to retrieve",
       "minLength": 1
+    },
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque continuation for the same playlist."
     }
   },
   "required": [

package/generated/resources/media-playlist/message-list-playlists.json

@@ -0,0 +1,18 @@
+{
+  "description": "List the connected customer's owned or followed playlists; use search-media for catalog search.",
+  "type": "object",
+  "properties": {
+    "maxResults": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [],
+  "additionalProperties": false
+}

package/generated/resources/media-playlist/message-playlist-contents.json

@@ -0,0 +1,140 @@
+{
+  "description": "A bounded playlist page containing playable tracks or episodes.",
+  "type": "object",
+  "properties": {
+    "playlistId": {
+      "title": "MediaId",
+      "type": "string",
+      "minLength": 1,
+      "example": "portos-media://portpowered.com/spotify/audio/track/Ab123",
+      "pattern": "^(portos-media://portpowered[.]com/[a-z][a-z0-9_-]*/(audio|video|image)/[a-z][a-z0-9_-]*/([^/?#\\s]|%[0-9A-Fa-f]{2})+|https?://[^\\s]+|portos://[^\\s]+|youtube:video:[A-Za-z0-9_-]+)$",
+      "description": "Exact provider resource identity. The canonical form is portos-media://portpowered.com/provider/media-type/resource-kind/resource-id, with no URI version. Spotify emits audio track, playlist, album, artist, show and episode identities. Copy an ID returned by search or library discovery; do not send a search phrase as an ID. Legacy providers retain their own input contracts until explicitly migrated. See https://portpowered.com/docs/media.\n"
+    },
+    "tracks": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Track information",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier for the track",
+            "minLength": 1
+          },
+          "name": {
+            "type": "string",
+            "description": "Track name",
+            "minLength": 1
+          },
+          "artists": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "description": "Artist information",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Unique identifier for the artist",
+                  "minLength": 1
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Artist name",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ],
+              "additionalProperties": false,
+              "title": "Artist"
+            },
+            "description": "Track artists"
+          },
+          "album": {
+            "description": "Track album",
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Unique identifier for the album",
+                "minLength": 1
+              },
+              "name": {
+                "type": "string",
+                "description": "Album name",
+                "minLength": 1
+              },
+              "artists": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/properties/tracks/items/properties/artists/items"
+                },
+                "description": "Album artists"
+              }
+            },
+            "required": [
+              "id",
+              "name",
+              "artists"
+            ],
+            "additionalProperties": false,
+            "title": "Album"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "artists",
+          "album"
+        ],
+        "additionalProperties": false,
+        "title": "Track"
+      }
+    },
+    "episodes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "description": "Provider-qualified podcast episode with selection metadata.",
+        "properties": {
+          "id": {
+            "$ref": "#/properties/playlistId"
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1
+          },
+          "showId": {
+            "$ref": "#/properties/playlistId"
+          },
+          "releaseDate": {
+            "type": "string",
+            "description": "Provider release date; precision can be year, month or day."
+          },
+          "releaseDatePrecision": {
+            "type": "string",
+            "description": "Provider date precision."
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false,
+        "title": "PodcastEpisode"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "playlistId",
+    "tracks",
+    "episodes"
+  ],
+  "additionalProperties": false
+}

package/generated/resources/media-playlist/message-playlists.json

@@ -0,0 +1,46 @@
+{
+  "description": "A page of the connected customer's playlists with exact resource IDs.",
+  "type": "object",
+  "properties": {
+    "playlists": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Unique identifier for the playlist",
+            "minLength": 1
+          },
+          "name": {
+            "type": "string",
+            "description": "Playlist name",
+            "minLength": 1
+          },
+          "ownerId": {
+            "type": "string",
+            "description": "Provider-scoped owner identity, when supplied by the provider."
+          },
+          "ownerName": {
+            "type": "string",
+            "description": "Owner display name, useful for distinguishing owned and followed playlists."
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ],
+        "additionalProperties": false,
+        "title": "Playlist"
+      }
+    },
+    "nextToken": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "playlists"
+  ],
+  "additionalProperties": false
+}