@portpowered/reference-data 0.4.6 → 0.4.8

package/generated/public/docs/references/capability-interfaces/media-search/1.0.yaml

@@ -100,18 +100,240 @@ messages:
                 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
           description: Playlist results
+        shows:
+          type: array
+          items:
+            type: object
+            description: Provider-qualified podcast series; read episodes before playback.
+            properties:
+              id:
+                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.
+              name:
+                type: string
+                minLength: 1
+              publisher:
+                type: string
+            required:
+              - id
+              - name
+            additionalProperties: false
+            title: PodcastShow
+        episodes:
+          type: array
+          items:
+            type: object
+            description: Provider-qualified podcast episode with selection metadata.
+            properties:
+              id:
+                $ref: '#/properties/shows/items/properties/id'
+              name:
+                type: string
+                minLength: 1
+              showId:
+                $ref: '#/properties/shows/items/properties/id'
+              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
+          description: Opaque continuation for the same search; omit when exhausted.
       required:
         - artists
         - albums
         - tracks
         - playlists
       additionalProperties: false
+  - name: get-media
+    description: >-
+      Inspect an exact media resource or traverse an album/show. Use get-playlist for playlist
+      contents.
+    directionality: in
+    schema:
+      description: >-
+        Inspect an exact media resource or traverse an album/show. Use get-playlist for playlist
+        contents.
+      type: object
+      properties:
+        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.
+        maxResults:
+          type: integer
+          minimum: 1
+          maximum: 50
+          default: 20
+        nextToken:
+          type: string
+          minLength: 1
+          description: Opaque continuation for the same resource.
+      required:
+        - mediaId
+      additionalProperties: false
+  - name: media-details
+    description: Exact media resource details and a bounded page of its children.
+    directionality: out
+    schema:
+      description: Exact media resource details and a bounded page of its children.
+      type: object
+      properties:
+        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.
+        name:
+          type: string
+        resourceKind:
+          type: string
+          description: Provider resource kind from the media URI.
+        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/mediaId'
+              name:
+                type: string
+                minLength: 1
+              showId:
+                $ref: '#/properties/mediaId'
+              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:
+        - mediaId
+        - resourceKind
+      additionalProperties: false
   - name: search-media
     description: null
     directionality: in
@@ -123,7 +345,9 @@ messages:
           description: Freeform query string
         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:
           type: string
@@ -136,6 +360,16 @@ messages:
           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:
         - query
       additionalProperties: false

package/generated/public/docs/references/capability-interfaces/media-search.yaml

@@ -100,18 +100,240 @@ messages:
                 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
           description: Playlist results
+        shows:
+          type: array
+          items:
+            type: object
+            description: Provider-qualified podcast series; read episodes before playback.
+            properties:
+              id:
+                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.
+              name:
+                type: string
+                minLength: 1
+              publisher:
+                type: string
+            required:
+              - id
+              - name
+            additionalProperties: false
+            title: PodcastShow
+        episodes:
+          type: array
+          items:
+            type: object
+            description: Provider-qualified podcast episode with selection metadata.
+            properties:
+              id:
+                $ref: '#/properties/shows/items/properties/id'
+              name:
+                type: string
+                minLength: 1
+              showId:
+                $ref: '#/properties/shows/items/properties/id'
+              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
+          description: Opaque continuation for the same search; omit when exhausted.
       required:
         - artists
         - albums
         - tracks
         - playlists
       additionalProperties: false
+  - name: get-media
+    description: >-
+      Inspect an exact media resource or traverse an album/show. Use get-playlist for playlist
+      contents.
+    directionality: in
+    schema:
+      description: >-
+        Inspect an exact media resource or traverse an album/show. Use get-playlist for playlist
+        contents.
+      type: object
+      properties:
+        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.
+        maxResults:
+          type: integer
+          minimum: 1
+          maximum: 50
+          default: 20
+        nextToken:
+          type: string
+          minLength: 1
+          description: Opaque continuation for the same resource.
+      required:
+        - mediaId
+      additionalProperties: false
+  - name: media-details
+    description: Exact media resource details and a bounded page of its children.
+    directionality: out
+    schema:
+      description: Exact media resource details and a bounded page of its children.
+      type: object
+      properties:
+        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.
+        name:
+          type: string
+        resourceKind:
+          type: string
+          description: Provider resource kind from the media URI.
+        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/mediaId'
+              name:
+                type: string
+                minLength: 1
+              showId:
+                $ref: '#/properties/mediaId'
+              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:
+        - mediaId
+        - resourceKind
+      additionalProperties: false
   - name: search-media
     description: null
     directionality: in
@@ -123,7 +345,9 @@ messages:
           description: Freeform query string
         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:
           type: string
@@ -136,6 +360,16 @@ messages:
           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:
         - query
       additionalProperties: false

package/generated/public/docs/references/capability-interfaces/recordings/1.0/messages/list-recordings-response.yaml

@@ -15,11 +15,17 @@ properties:
           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.
         startedAt:
           type: string
           format: date-time

package/generated/public/docs/references/capability-interfaces/recordings/1.0.yaml

@@ -104,11 +104,16 @@ messages:
                 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.
               startedAt:
                 type: string
                 format: date-time

package/generated/public/docs/references/capability-interfaces/recordings.yaml

@@ -104,11 +104,16 @@ messages:
                 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.
               startedAt:
                 type: string
                 format: date-time

package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0/configuration.yaml

@@ -0,0 +1,14 @@
+type: object
+properties:
+  supportedInputTypes:
+    type: array
+    uniqueItems: true
+    items:
+      type: string
+      enum:
+        - SSML
+        - CANNED_TTS
+additionalProperties: false
+description: >-
+  Speech synthesizers accept a request to speak. Use them to send spoken output to a connected
+  device or integration.

package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0/messages/speak.yaml

@@ -12,7 +12,14 @@ properties:
         type: string
         enum:
           - SSML
+          - CANNED_TTS
       ssml:
         type: string
+      cannedTtsStringId:
+        type: string
+        minLength: 1
+        description: >-
+          Provider-defined canned speech identifier; supported only by
+          integrations advertising canned speech.
     title: SpeechInput
 additionalProperties: false

package/generated/public/docs/references/capability-interfaces/speech-synthesizer/1.0.yaml

@@ -23,12 +23,33 @@ messages:
               type: string
               enum:
                 - SSML
+                - CANNED_TTS
             ssml:
               type: string
+            cannedTtsStringId:
+              type: string
+              minLength: 1
+              description: >-
+                Provider-defined canned speech identifier; supported only by integrations
+                advertising canned speech.
           title: SpeechInput
       additionalProperties: false
 attributes: []
-configuration: null
+configuration:
+  type: object
+  properties:
+    supportedInputTypes:
+      type: array
+      uniqueItems: true
+      items:
+        type: string
+        enum:
+          - SSML
+          - CANNED_TTS
+  additionalProperties: false
+  description: >-
+    Speech synthesizers accept a request to speak. Use them to send spoken output to a connected
+    device or integration.
 authorization:
   configuration: endpoint:read
   attributes: endpoint:read