react-native-audio-browser 0.2.0-next.9 → 0.2.0

package/lib/typescript/src/types/browser-nodes.d.ts

@@ -20,97 +20,17 @@ export interface ImageSource {
     /** HTTP body for POST requests (rare for images) */
     body?: string;
 }
-/**
- * Per-track override applied as the most-specific layer of THIS track's media
- * request (after the shared `request` and `media` layers). Deliberately narrow:
- * a track may customize HOW its request is made (identity, auth, signed-URL
- * params), not WHERE it goes — `baseUrl`/`path`/`method`/`body` are intentionally
- * absent so a (often server-sourced) track can't repoint its own host or verb.
- * Carried verbatim on the Track and round-tripped like any other field.
- */
-export interface TrackRequest {
-    userAgent?: string;
-    headers?: Record<string, string>;
-    query?: Record<string, string>;
-}
-/**
- * Artwork URLs for a track that ships a different image per appearance.
- *
- * Both are required: a pair with one side missing has no sensible fallback at
- * render time, and making that unrepresentable is the reason this is a pair
- * rather than two optional fields.
- *
- * Android Auto is dark-only and takes `dark`.
- */
-export interface ArtworkVariants {
-    /** Shown in light mode. */
-    light: string;
-    /** Shown in dark mode, and on Android Auto. */
-    dark: string;
-}
-/** A single artwork URL, or one per appearance. */
-export type TrackArtwork = string | ArtworkVariants;
 export interface ImageRowItem {
-    /**
-     * Opaque, stable identifier for this item's track. Round-tripped like
-     * `Track.id` when the thumbnail is played (see `src`).
-     */
-    id?: string;
     /** Navigation path. Tapping this thumbnail navigates to this URL. */
     url?: string;
-    /**
-     * Direct audio source. When present, tapping this thumbnail plays it
-     * immediately (same selection path as a playable list row) instead of
-     * navigating. Takes precedence over `url`.
-     */
-    src?: string;
     /** Artwork URL for the thumbnail image. */
     artwork?: string;
     /** Output only — populated by the artwork transform pipeline. */
     readonly artworkSource?: ImageSource;
-    /** Title of this item. Shown as the thumbnail caption; used for identification and accessibility. */
+    /** Title of this item. Used for identification and accessibility. */
     title: string;
-    /** Now-playing secondary line when played via `src` (mirrors `Track.artist`). */
-    artist?: string;
-    /** Now-playing album line when played via `src` (mirrors `Track.album`). */
-    album?: string;
-    /** Navigation target of the album line when played via `src` (mirrors `Track.albumUrl`). */
-    albumUrl?: string;
-    /** Live stream indicator when played via `src` (mirrors `Track.live`). */
-    live?: boolean;
-    /** Per-item media-request override when played via `src` (mirrors `Track.request`). */
-    request?: TrackRequest;
 }
 export interface Track {
-    /**
-     * Opaque, stable identifier for this track.
-     *
-     * The library never parses or derives anything from this value — it is
-     * round-tripped verbatim through `setQueue`, `getActiveTrack`, the queue, and
-     * `onActiveTrackChanged`, so consumers can recognise which item became active
-     * after an external transport change (lock screen / CarPlay / Android Auto /
-     * Bluetooth next-previous) without parsing the playable `src`.
-     *
-     * When present on a playable track it is also the track's *identity* on car
-     * browse surfaces: CarPlay's and Android Auto's "now playing" row indicator
-     * match the active track to browse rows by `id` (falling back to exact `src`
-     * equality for tracks without one). Assign ids when your playable `src`
-     * strings for the same item can differ between browse rows and loaded tracks
-     * (absolute vs relative URLs, volatile query params) — otherwise the
-     * indicator never matches.
-     *
-     * It is also handed to the per-track `MediaRequestConfig.resolve` and
-     * `ArtworkRequestConfig.resolve` hooks, so requests can be built from a stable
-     * id (e.g. supply tracks with only an `id` and synthesise `src` in `resolve`).
-     *
-     * Optional: consumers whose `url`/`src` strings are already stable across
-     * surfaces can ignore it.
-     *
-     * Note: an Android Auto item selected directly from the browse tree that the
-     * consumer never queued is identified only by `url`/`src`, so `id` may be
-     * undefined on that specific path.
-     */
-    id?: string;
     /**
      * Navigation path. When present, this track is a container (tab, album, playlist, folder)
      * that can be navigated into to view its contents.
@@ -129,17 +49,12 @@ export interface Track {
      */
     src?: string;
     /**
-     * Artwork URL for the item, or a URL per appearance.
+     * Artwork URL for the item.
      *
      * The artwork URL is also returned by native in the `artworkSource` property
      * for use in an `<Image>` component, which will contain the transformed version
      * if `artwork` configuration is set in `BrowserConfiguration` or a route.
      *
-     * Pass an {@link ArtworkVariants} pair to supply genuinely different images
-     * per appearance — a logo that changes colour, say. For a monochrome glyph
-     * that only needs recolouring, prefer a single URL plus
-     * {@link Track.artworkCarPlayTinted}, which is one fetch instead of two.
-     *
      * **iOS:** supports {@link https://developer.apple.com/sf-symbols/ | SF Symbols}
      * with the `sf:` prefix and optional color params:
      * `sf:heart.fill?bg=#FF0090&fg=#fff`. `bg` sets the background color
@@ -147,7 +62,7 @@ export interface Track {
      * On CarPlay, SF Symbols without explicit colors automatically adapt to
      * light/dark mode.
      */
-    artwork?: TrackArtwork;
+    artwork?: string;
     /**
      * Ready-to-use image source for React Native's `<Image>` component.
      *
@@ -163,8 +78,6 @@ export interface Track {
      * ```
      */
     readonly artworkSource?: ImageSource;
-    /** Per-track media-request override; merged last (request → media → track.request). */
-    request?: TrackRequest;
     /**
      * Whether this artwork should be tinted based on CarPlay's current appearance (light/dark mode).
      *
@@ -181,46 +94,12 @@ export interface Track {
      * @default false
      */
     artworkCarPlayTinted?: boolean;
-    /** Primary line shown for this item, in both browse lists and now-playing. */
     title: string;
-    /**
-     * Secondary line shown for this item in **browse lists** (CarPlay list detail
-     * text, Android Auto list subtitle). Free-form, per-context display text — set
-     * it to whatever the row should show, or leave it unset for a blank line. It is
-     * *not* shown on the now-playing screen; use {@link artist} for that.
-     */
     subtitle?: string;
-    /**
-     * Secondary line shown on the **now-playing / lock-screen** UI, and the value
-     * sent to Bluetooth / car head units — it maps to the platform's "artist"
-     * metadata slot.
-     *
-     * Distinct from {@link subtitle}: `artist` drives the now-playing line,
-     * `subtitle` drives browse-list rows. Neither falls back to the other — set
-     * each for the surface you want it on.
-     */
     artist?: string;
-    /**
-     * Browse path the {@link album} line navigates to (same path namespace as
-     * {@link url}). On CarPlay, when the active track has an `albumUrl`, its
-     * album line on the Now Playing screen becomes tappable and navigates the
-     * browse stack there. See also `resolveAlbumUrl` in the browser
-     * configuration for a dynamic fallback.
-     *
-     * Requires {@link album} to be set: CarPlay renders the tappable line from
-     * the album metadata — without an album there is no line to tap.
-     *
-     * @platform ios
-     */
-    albumUrl?: string;
     album?: string;
     description?: string;
     genre?: string;
-    /**
-     * Duration in seconds, as catalog metadata for app UI (e.g. an episode
-     * list). Does not drive the now-playing scrubber — every platform surface
-     * derives elapsed/duration from the player itself.
-     */
     duration?: number;
     /**
      * Display style for this item in Android Auto/AAOS.
@@ -247,7 +126,7 @@ export interface Track {
      */
     childrenStyle?: TrackStyle;
     /**
-     * Whether this track is favorited. When the `favorite` capability is enabled,
+     * Whether this track is favorited. When the `set-rating` capability is enabled,
      * displays a filled/empty heart icon in media controllers (notification, Android Auto).
      */
     favorited?: boolean;
@@ -268,18 +147,13 @@ export interface Track {
      *
      * - Track.title → row header text
      * - Track.url → navigated when header is tapped (optional)
-     * - Each ImageRowItem → one thumbnail in the horizontal row; a thumbnail
-     *   with `src` plays immediately on tap, otherwise its `url` is navigated
+     * - Each ImageRowItem → one thumbnail in the horizontal row
      *
      * On CarPlay: maps to CPListImageRowItem. Limits visible images by display
-     * width (~4-5). Excess silently truncated. A row whose track has no `url`
-     * is a pure preview: its header is not tappable.
+     * width (~4-5). Excess silently truncated.
      *
-     * On Android Auto: there is no image-row rendering, so the row expands into
-     * its items as grid-styled rows (artwork tiles where the host honors the
-     * per-item content-style hint, list rows otherwise) grouped under the
-     * track's title, followed by the track itself as a browsable "view all"
-     * link when it has a `url`.
+     * On Android Auto: ignored; the parent Track renders as a regular
+     * browsable item using its own artwork/title/url.
      *
      * On app side: consumable by React Native UI for horizontal thumbnail layouts.
      */
@@ -293,13 +167,10 @@ export interface Track {
  *
  * @example
  * ```ts
- * // navigate() is fire-and-forget (returns void); read the resolved page
- * // from getContent() / useContent() / onContentChanged.
- * navigate('albums/abbey-road');
- * const resolved = getContent();
- * console.log(resolved?.url); // "albums/abbey-road"
- * console.log(resolved?.title); // "Abbey Road"
- * console.log(resolved?.children); // Array of tracks in this album
+ * const resolved = await audioBrowser.navigate('albums/abbey-road');
+ * console.log(resolved.url); // "albums/abbey-road"
+ * console.log(resolved.title); // "Abbey Road"
+ * console.log(resolved.children); // Array of tracks in this album
  * ```
  */
 export interface ResolvedTrack extends Track {
@@ -314,10 +185,7 @@ export interface ResolvedTrack extends Track {
     children?: Track[];
     /**
      * Shows the "Ask Siri to Play Audio" assistant cell on the CarPlay list template
-     * for this content. Requires the Siri entitlement, the `INPlayMediaIntent` keys in
-     * Info.plist, and an in-app intent handler in your `AppDelegate`
-     * (`application(_:handlerFor:)`) — no separate Intents Extension is needed. See the
-     * setup guide for the full wiring.
+     * for this content. Requires an Intents Extension to be configured in the app.
      *
      * - `'top'`: Shows at the top of the list
      * - `'bottom'`: Shows at the bottom of the list

package/lib/typescript/src/types/browser-nodes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser-nodes.d.ts","sourceRoot":"","sources":["../../../../src/types/browser-nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAE1E,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,+DAA+D;IAC/D,GAAG,EAAE,MAAM,CAAA;IACX,2CAA2C;IAC3C,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAQD;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAA;CACb;AAOD,mDAAmD;AACnD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,eAAe,CAAA;AAEnD,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAA;IACpC,qGAAqG;IACrG,KAAK,EAAE,MAAM,CAAA;IACb,iFAAiF;IACjF,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,4EAA4E;IAC5E,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0EAA0E;IAC1E,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,uFAAuF;IACvF,OAAO,CAAC,EAAE,YAAY,CAAA;CACvB;AAED,MAAM,WAAW,KAAK;IACpB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,EAAE,YAAY,CAAA;IAEtB;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAA;IAEpC,uFAAuF;IACvF,OAAO,CAAC,EAAE,YAAY,CAAA;IAEtB;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAG9B,8EAA8E;IAC9E,KAAK,EAAE,MAAM,CAAA;IAEb;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;OAQG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,UAAU,CAAA;IAElB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,UAAU,CAAA;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAA;IAElB;;;;;;;;;;;;OAYG;IACH,qBAAqB,CAAC,EAAE,6BAA6B,CAAA;CACtD"}
+{"version":3,"file":"browser-nodes.d.ts","sourceRoot":"","sources":["../../../../src/types/browser-nodes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,6BAA6B,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAE1E,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,CAAA;AAExC;;;;;;;;;GASG;AACH,MAAM,WAAW,WAAW;IAC1B,+DAA+D;IAC/D,GAAG,EAAE,MAAM,CAAA;IACX,2CAA2C;IAC3C,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAQD,MAAM,WAAW,YAAY;IAC3B,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iEAAiE;IACjE,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAA;IACpC,qEAAqE;IACrE,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,KAAK;IACpB;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,WAAW,CAAA;IAEpC;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAG9B,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,EAAE,UAAU,CAAA;IAElB;;;;;;;;;OASG;IACH,aAAa,CAAC,EAAE,UAAU,CAAA;IAE1B;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IAEd;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAA;CAC1B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,aAAc,SAAQ,KAAK;IAC1C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAA;IAElB;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,6BAA6B,CAAA;CACtD"}