@syra.fm/sdk 0.1.0 → 0.3.0

package/README.md

@@ -18,11 +18,15 @@ import { createSyraClient } from '@syra.fm/sdk';
 
 const syra = createSyraClient(); // defaults to https://api.syra.fm
 
-// Search the catalog (only tracks with a public preview are returned)
-const tracks = await syra.searchTracks('lofi beats', { limit: 10 });
+// Search the catalog — returns one page; only tracks with a public preview are
+// in `items`. Paginate for infinite scroll by advancing `offset` by `limit`.
+const page = await syra.searchTracks('lofi beats', { limit: 10, offset: 0 });
+if (page.hasMore) {
+  const next = await syra.searchTracks('lofi beats', { limit: 10, offset: 10 });
+}
 
 // Fetch a single track
-const track = await syra.getTrack(tracks[0].id);
+const track = await syra.getTrack(page.items[0].id);
 
 // Build a public 30s preview URL (directly playable MP3)
 const url = syra.previewUrl(track.id);          // .../api/preview/<id>.mp3?start=0
@@ -48,10 +52,18 @@ authenticated transport can be layered in a future version.
 
 | Method | Description |
 | --- | --- |
-| `searchTracks(query, { limit })` | Preview-available `TrackSummary[]` matching `query`. |
+| `searchTracks(query, { limit, offset })` | A `SearchPage<TrackSummary>` of preview-available tracks (`{ items, hasMore, limit, offset }`). |
 | `getTrack(id)` | A single `TrackSummary`, schema-validated. |
 | `previewUrl(id, startSec = 0)` | Public 30s preview URL. |
 | `artworkUrl(trackOrCoverArt, size?)` | Absolute artwork URL, or `undefined`. |
+| `searchPodcasts(query, { limit, offset })` | A `SearchPage<PodcastSummary>` of podcast shows. |
+| `getPodcast(id)` | A single `PodcastSummary`, schema-validated. |
+| `podcastUrl(id)` | Syra web deep link (`/podcasts/:id`). |
+| `podcastArtworkUrl(show, size?)` | Absolute show-artwork URL, or `undefined`. |
+
+`hasMore` reflects the backend's pagination over the full result set, so it is
+not affected by the client-side preview filter on `searchTracks` — paginate by
+advancing `offset` by `limit`, never by `items.length`.
 
 Responses are validated at runtime with the package's own self-contained Zod
 schemas (`trackSummarySchema`), so there are no shared internal dependencies.

package/dist/cjs/client.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_SYRA_BASE_URL = void 0;
+exports.DEFAULT_SYRA_WEB_BASE_URL = exports.DEFAULT_SYRA_BASE_URL = void 0;
 exports.createSyraClient = createSyraClient;
 const schema_1 = require("./schema");
 const errors_1 = require("./errors");
 /** Default base URL of the public Syra API. */
 exports.DEFAULT_SYRA_BASE_URL = 'https://api.syra.fm';
+/** Default base URL of the Syra web app, used for deep links. */
+exports.DEFAULT_SYRA_WEB_BASE_URL = 'https://syra.fm';
 /** Order used to pick the best available artwork variant when none is named. */
 const ARTWORK_FALLBACK_ORDER = [
     'original',
@@ -16,12 +18,17 @@ const ARTWORK_FALLBACK_ORDER = [
     'small',
 ];
 const OBJECT_ID_PATTERN = /^[a-f\d]{24}$/i;
+/** Read a finite number from an unknown response field, else a fallback. */
+function numberOr(value, fallback) {
+    return typeof value === 'number' && Number.isFinite(value) ? value : fallback;
+}
 /**
  * Create a headless client for the public Syra API. Public reads only — there
  * is no authentication in this version.
  */
 function createSyraClient(options = {}) {
     const baseURL = (options.baseURL ?? exports.DEFAULT_SYRA_BASE_URL).replace(/\/+$/, '');
+    const webBaseURL = (options.webBaseURL ?? exports.DEFAULT_SYRA_WEB_BASE_URL).replace(/\/+$/, '');
     function resolveFetch() {
         if (options.fetch) {
             return options.fetch;
@@ -64,17 +71,29 @@ function createSyraClient(options = {}) {
             if (typeof searchOptions.limit === 'number') {
                 params.set('limit', String(searchOptions.limit));
             }
+            if (typeof searchOptions.offset === 'number') {
+                params.set('offset', String(searchOptions.offset));
+            }
             const json = (await getJson(`/api/search?${params.toString()}`));
             const rawTracks = Array.isArray(json?.results?.tracks) ? json.results.tracks : [];
-            const tracks = [];
+            const items = [];
             for (const raw of rawTracks) {
                 // A single malformed catalog row must not fail the whole search.
                 const parsed = schema_1.trackSummarySchema.safeParse(raw);
                 if (parsed.success && parsed.data.previewAvailable === true) {
-                    tracks.push(parsed.data);
+                    items.push(parsed.data);
                 }
             }
-            return tracks;
+            return {
+                items,
+                // `hasMore` is sourced from the backend's pagination over the FULL result
+                // set; the client-side preview filter above may shrink `items` below
+                // `limit`, but must NOT corrupt `hasMore` (else a page whose tail was
+                // filtered out would falsely report the end of the catalog).
+                hasMore: json?.hasMore === true,
+                limit: numberOr(json?.limit, searchOptions.limit ?? rawTracks.length),
+                offset: numberOr(json?.offset, searchOptions.offset ?? 0),
+            };
         },
         async getTrack(id) {
             const json = await getJson(`/api/tracks/${encodeURIComponent(id)}`);
@@ -108,5 +127,59 @@ function createSyraClient(options = {}) {
             }
             return undefined;
         },
+        async searchPodcasts(query, searchOptions = {}) {
+            const params = new URLSearchParams({ q: query });
+            if (typeof searchOptions.limit === 'number') {
+                params.set('limit', String(searchOptions.limit));
+            }
+            if (typeof searchOptions.offset === 'number') {
+                params.set('offset', String(searchOptions.offset));
+            }
+            const json = (await getJson(`/api/podcasts/search?${params.toString()}`));
+            const rawPodcasts = Array.isArray(json?.data) ? json.data : [];
+            const items = [];
+            for (const raw of rawPodcasts) {
+                // A single malformed catalog row must not fail the whole search.
+                const parsed = schema_1.podcastSummarySchema.safeParse(raw);
+                if (parsed.success) {
+                    items.push(parsed.data);
+                }
+            }
+            return {
+                items,
+                // `hasMore` reflects the backend's pagination over the full result set.
+                hasMore: json?.hasMore === true,
+                limit: numberOr(json?.limit, searchOptions.limit ?? rawPodcasts.length),
+                offset: numberOr(json?.offset, searchOptions.offset ?? 0),
+            };
+        },
+        async getPodcast(id) {
+            const json = (await getJson(`/api/podcasts/${encodeURIComponent(id)}`));
+            return schema_1.podcastSummarySchema.parse(json?.data?.podcast);
+        },
+        podcastUrl(id) {
+            return `${webBaseURL}/podcasts/${encodeURIComponent(id)}`;
+        },
+        podcastArtworkUrl(source, size) {
+            if (size && source.imageSizes) {
+                const resolved = resolveImageRef(source.imageSizes[size]?.url);
+                if (resolved) {
+                    return resolved;
+                }
+            }
+            const fromImage = resolveImageRef(source.image);
+            if (fromImage) {
+                return fromImage;
+            }
+            if (source.imageSizes) {
+                for (const key of ARTWORK_FALLBACK_ORDER) {
+                    const resolved = resolveImageRef(source.imageSizes[key]?.url);
+                    if (resolved) {
+                        return resolved;
+                    }
+                }
+            }
+            return resolveImageRef(source.imageSourceUrl);
+        },
     };
 }

package/dist/cjs/index.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SyraApiError = exports.coverArtVariantSchema = exports.coverArtSizesSchema = exports.trackSummarySchema = exports.DEFAULT_SYRA_BASE_URL = exports.createSyraClient = void 0;
+exports.SyraApiError = exports.coverArtVariantSchema = exports.coverArtSizesSchema = exports.podcastSummarySchema = exports.trackSummarySchema = exports.DEFAULT_SYRA_WEB_BASE_URL = exports.DEFAULT_SYRA_BASE_URL = exports.createSyraClient = void 0;
 var client_1 = require("./client");
 Object.defineProperty(exports, "createSyraClient", { enumerable: true, get: function () { return client_1.createSyraClient; } });
 Object.defineProperty(exports, "DEFAULT_SYRA_BASE_URL", { enumerable: true, get: function () { return client_1.DEFAULT_SYRA_BASE_URL; } });
+Object.defineProperty(exports, "DEFAULT_SYRA_WEB_BASE_URL", { enumerable: true, get: function () { return client_1.DEFAULT_SYRA_WEB_BASE_URL; } });
 var schema_1 = require("./schema");
 Object.defineProperty(exports, "trackSummarySchema", { enumerable: true, get: function () { return schema_1.trackSummarySchema; } });
+Object.defineProperty(exports, "podcastSummarySchema", { enumerable: true, get: function () { return schema_1.podcastSummarySchema; } });
 Object.defineProperty(exports, "coverArtSizesSchema", { enumerable: true, get: function () { return schema_1.coverArtSizesSchema; } });
 Object.defineProperty(exports, "coverArtVariantSchema", { enumerable: true, get: function () { return schema_1.coverArtVariantSchema; } });
 var errors_1 = require("./errors");

package/dist/cjs/schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trackSummarySchema = exports.coverArtSizesSchema = exports.coverArtVariantSchema = void 0;
+exports.podcastSummarySchema = exports.trackSummarySchema = exports.coverArtSizesSchema = exports.coverArtVariantSchema = void 0;
 const zod_1 = require("zod");
 /**
  * Minimal, self-contained schemas for the public Syra API response shapes this
@@ -41,3 +41,22 @@ exports.trackSummarySchema = zod_1.z.object({
     coverArtSizes: exports.coverArtSizesSchema.optional(),
     previewAvailable: zod_1.z.boolean().optional(),
 });
+/**
+ * The summary view of a podcast SHOW returned by the public podcast endpoints
+ * (`GET /api/podcasts/search`, `GET /api/podcasts/:id`) — just enough to render
+ * a show card and deep-link into the Syra app.
+ *
+ * Artwork mirrors tracks: `image` is the re-hosted Syra image id (resolved via
+ * `/api/images/:id`); `imageSizes` is the multi-resolution variant set (each
+ * variant `url` is `/api/images/:id`); `imageSourceUrl` keeps the original
+ * external artwork URL as an absolute fallback when re-hosting has not run yet.
+ */
+exports.podcastSummarySchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    title: zod_1.z.string(),
+    author: zod_1.z.string().optional(),
+    description: zod_1.z.string().optional(),
+    image: zod_1.z.string().optional(),
+    imageSizes: exports.coverArtSizesSchema.optional(),
+    imageSourceUrl: zod_1.z.string().optional(),
+});

package/dist/esm/client.js

@@ -1,7 +1,9 @@
-import { trackSummarySchema, } from './schema.js';
+import { trackSummarySchema, podcastSummarySchema, } from './schema.js';
 import { SyraApiError } from './errors.js';
 /** Default base URL of the public Syra API. */
 export const DEFAULT_SYRA_BASE_URL = 'https://api.syra.fm';
+/** Default base URL of the Syra web app, used for deep links. */
+export const DEFAULT_SYRA_WEB_BASE_URL = 'https://syra.fm';
 /** Order used to pick the best available artwork variant when none is named. */
 const ARTWORK_FALLBACK_ORDER = [
     'original',
@@ -12,12 +14,17 @@ const ARTWORK_FALLBACK_ORDER = [
     'small',
 ];
 const OBJECT_ID_PATTERN = /^[a-f\d]{24}$/i;
+/** Read a finite number from an unknown response field, else a fallback. */
+function numberOr(value, fallback) {
+    return typeof value === 'number' && Number.isFinite(value) ? value : fallback;
+}
 /**
  * Create a headless client for the public Syra API. Public reads only — there
  * is no authentication in this version.
  */
 export function createSyraClient(options = {}) {
     const baseURL = (options.baseURL ?? DEFAULT_SYRA_BASE_URL).replace(/\/+$/, '');
+    const webBaseURL = (options.webBaseURL ?? DEFAULT_SYRA_WEB_BASE_URL).replace(/\/+$/, '');
     function resolveFetch() {
         if (options.fetch) {
             return options.fetch;
@@ -60,17 +67,29 @@ export function createSyraClient(options = {}) {
             if (typeof searchOptions.limit === 'number') {
                 params.set('limit', String(searchOptions.limit));
             }
+            if (typeof searchOptions.offset === 'number') {
+                params.set('offset', String(searchOptions.offset));
+            }
             const json = (await getJson(`/api/search?${params.toString()}`));
             const rawTracks = Array.isArray(json?.results?.tracks) ? json.results.tracks : [];
-            const tracks = [];
+            const items = [];
             for (const raw of rawTracks) {
                 // A single malformed catalog row must not fail the whole search.
                 const parsed = trackSummarySchema.safeParse(raw);
                 if (parsed.success && parsed.data.previewAvailable === true) {
-                    tracks.push(parsed.data);
+                    items.push(parsed.data);
                 }
             }
-            return tracks;
+            return {
+                items,
+                // `hasMore` is sourced from the backend's pagination over the FULL result
+                // set; the client-side preview filter above may shrink `items` below
+                // `limit`, but must NOT corrupt `hasMore` (else a page whose tail was
+                // filtered out would falsely report the end of the catalog).
+                hasMore: json?.hasMore === true,
+                limit: numberOr(json?.limit, searchOptions.limit ?? rawTracks.length),
+                offset: numberOr(json?.offset, searchOptions.offset ?? 0),
+            };
         },
         async getTrack(id) {
             const json = await getJson(`/api/tracks/${encodeURIComponent(id)}`);
@@ -104,5 +123,59 @@ export function createSyraClient(options = {}) {
             }
             return undefined;
         },
+        async searchPodcasts(query, searchOptions = {}) {
+            const params = new URLSearchParams({ q: query });
+            if (typeof searchOptions.limit === 'number') {
+                params.set('limit', String(searchOptions.limit));
+            }
+            if (typeof searchOptions.offset === 'number') {
+                params.set('offset', String(searchOptions.offset));
+            }
+            const json = (await getJson(`/api/podcasts/search?${params.toString()}`));
+            const rawPodcasts = Array.isArray(json?.data) ? json.data : [];
+            const items = [];
+            for (const raw of rawPodcasts) {
+                // A single malformed catalog row must not fail the whole search.
+                const parsed = podcastSummarySchema.safeParse(raw);
+                if (parsed.success) {
+                    items.push(parsed.data);
+                }
+            }
+            return {
+                items,
+                // `hasMore` reflects the backend's pagination over the full result set.
+                hasMore: json?.hasMore === true,
+                limit: numberOr(json?.limit, searchOptions.limit ?? rawPodcasts.length),
+                offset: numberOr(json?.offset, searchOptions.offset ?? 0),
+            };
+        },
+        async getPodcast(id) {
+            const json = (await getJson(`/api/podcasts/${encodeURIComponent(id)}`));
+            return podcastSummarySchema.parse(json?.data?.podcast);
+        },
+        podcastUrl(id) {
+            return `${webBaseURL}/podcasts/${encodeURIComponent(id)}`;
+        },
+        podcastArtworkUrl(source, size) {
+            if (size && source.imageSizes) {
+                const resolved = resolveImageRef(source.imageSizes[size]?.url);
+                if (resolved) {
+                    return resolved;
+                }
+            }
+            const fromImage = resolveImageRef(source.image);
+            if (fromImage) {
+                return fromImage;
+            }
+            if (source.imageSizes) {
+                for (const key of ARTWORK_FALLBACK_ORDER) {
+                    const resolved = resolveImageRef(source.imageSizes[key]?.url);
+                    if (resolved) {
+                        return resolved;
+                    }
+                }
+            }
+            return resolveImageRef(source.imageSourceUrl);
+        },
     };
 }

package/dist/esm/index.js

@@ -1,3 +1,3 @@
-export { createSyraClient, DEFAULT_SYRA_BASE_URL, } from './client.js';
-export { trackSummarySchema, coverArtSizesSchema, coverArtVariantSchema, } from './schema.js';
+export { createSyraClient, DEFAULT_SYRA_BASE_URL, DEFAULT_SYRA_WEB_BASE_URL, } from './client.js';
+export { trackSummarySchema, podcastSummarySchema, coverArtSizesSchema, coverArtVariantSchema, } from './schema.js';
 export { SyraApiError } from './errors.js';

package/dist/esm/schema.js

@@ -38,3 +38,22 @@ export const trackSummarySchema = z.object({
     coverArtSizes: coverArtSizesSchema.optional(),
     previewAvailable: z.boolean().optional(),
 });
+/**
+ * The summary view of a podcast SHOW returned by the public podcast endpoints
+ * (`GET /api/podcasts/search`, `GET /api/podcasts/:id`) — just enough to render
+ * a show card and deep-link into the Syra app.
+ *
+ * Artwork mirrors tracks: `image` is the re-hosted Syra image id (resolved via
+ * `/api/images/:id`); `imageSizes` is the multi-resolution variant set (each
+ * variant `url` is `/api/images/:id`); `imageSourceUrl` keeps the original
+ * external artwork URL as an absolute fallback when re-hosting has not run yet.
+ */
+export const podcastSummarySchema = z.object({
+    id: z.string(),
+    title: z.string(),
+    author: z.string().optional(),
+    description: z.string().optional(),
+    image: z.string().optional(),
+    imageSizes: coverArtSizesSchema.optional(),
+    imageSourceUrl: z.string().optional(),
+});

package/dist/types/client.d.ts

@@ -1,9 +1,17 @@
-import { type TrackSummary, type CoverArtSizes, type ArtworkSize } from './schema';
+import { type TrackSummary, type PodcastSummary, type CoverArtSizes, type ArtworkSize } from './schema';
 /** Default base URL of the public Syra API. */
 export declare const DEFAULT_SYRA_BASE_URL = "https://api.syra.fm";
+/** Default base URL of the Syra web app, used for deep links. */
+export declare const DEFAULT_SYRA_WEB_BASE_URL = "https://syra.fm";
 export interface SyraClientOptions {
     /** Base URL of the Syra API. Defaults to {@link DEFAULT_SYRA_BASE_URL}. */
     baseURL?: string;
+    /**
+     * Base URL of the Syra WEB app (not the API host), used to build deep links
+     * such as {@link SyraClient.podcastUrl}. Defaults to
+     * {@link DEFAULT_SYRA_WEB_BASE_URL}.
+     */
+    webBaseURL?: string;
     /**
      * `fetch` implementation. Defaults to the global `fetch` (Node 18+, browsers,
      * React Native). Inject one (e.g. `node-fetch`) when no global is available.
@@ -12,20 +20,55 @@ export interface SyraClientOptions {
     fetch?: typeof fetch;
 }
 export interface SearchTracksOptions {
-    /** Maximum number of tracks to request from the API. */
+    /** Maximum number of tracks to request from the API (the page size). */
+    limit?: number;
+    /** Zero-based offset of the first track to return (for infinite scroll). */
+    offset?: number;
+}
+export interface SearchPodcastsOptions {
+    /** Maximum number of podcast shows to request from the API (the page size). */
     limit?: number;
+    /** Zero-based offset of the first show to return (for infinite scroll). */
+    offset?: number;
+}
+/**
+ * One page of paginated catalog search results.
+ *
+ * `hasMore` reflects the BACKEND's pagination over the full matching set — NOT
+ * `items.length`. {@link SyraClient.searchTracks} additionally filters its page
+ * client-side to preview-available tracks, so `items.length` can be smaller than
+ * `limit` while `hasMore` is still `true`; callers must paginate by advancing
+ * `offset` by `limit` (the page size), never by `items.length`.
+ */
+export interface SearchPage<T> {
+    /** The validated rows for this page. */
+    items: T[];
+    /** Whether the backend has results beyond this page. */
+    hasMore: boolean;
+    /** The page size the backend applied. */
+    limit: number;
+    /** The zero-based offset of this page. */
+    offset: number;
 }
-/** Minimal shape from which artwork URLs can be derived. */
+/** Minimal shape from which track artwork URLs can be derived. */
 export interface ArtworkSource {
     coverArt?: string | null;
     coverArtSizes?: CoverArtSizes | null;
 }
+/** Minimal shape from which podcast-show artwork URLs can be derived. */
+export interface PodcastArtworkSource {
+    image?: string | null;
+    imageSizes?: CoverArtSizes | null;
+    imageSourceUrl?: string | null;
+}
 export interface SyraClient {
     /**
-     * Search the public catalog for tracks. Results are validated against the
-     * track-summary schema and filtered to those that expose a public preview.
+     * Search the public catalog for tracks. Returns one paginated page: rows are
+     * validated against the track-summary schema and filtered to those that expose
+     * a public preview. `hasMore` comes from the backend's pagination, so it is
+     * unaffected by the client-side preview filter (see {@link SearchPage}).
      */
-    searchTracks(query: string, options?: SearchTracksOptions): Promise<TrackSummary[]>;
+    searchTracks(query: string, options?: SearchTracksOptions): Promise<SearchPage<TrackSummary>>;
     /** Fetch a single track by id, validated against the track-summary schema. */
     getTrack(id: string): Promise<TrackSummary>;
     /** Build the public 30s preview URL for a track at the given start offset. */
@@ -35,6 +78,26 @@ export interface SyraClient {
      * `undefined` when no artwork can be derived.
      */
     artworkUrl(source: string | ArtworkSource, size?: ArtworkSize): string | undefined;
+    /**
+     * Search the public catalog for podcast SHOWS (not episodes). Returns one
+     * paginated page: rows are validated against the podcast-summary schema and
+     * malformed rows are dropped. `hasMore` comes from the backend's pagination.
+     */
+    searchPodcasts(query: string, options?: SearchPodcastsOptions): Promise<SearchPage<PodcastSummary>>;
+    /**
+     * Fetch a single podcast show by id, validated against the podcast-summary
+     * schema. The by-id endpoint also returns episodes and resolved persons; this
+     * returns just the show summary needed to render a card.
+     */
+    getPodcast(id: string): Promise<PodcastSummary>;
+    /** Build the Syra web app deep link for a podcast show (`/podcasts/:id`). */
+    podcastUrl(id: string): string;
+    /**
+     * Resolve an absolute artwork URL from a podcast show reference. Prefers the
+     * re-hosted Syra image, then the requested/fallback variant, then the original
+     * external artwork URL. Returns `undefined` when no artwork can be derived.
+     */
+    podcastArtworkUrl(source: PodcastArtworkSource, size?: ArtworkSize): string | undefined;
 }
 /**
  * Create a headless client for the public Syra API. Public reads only — there

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-export { createSyraClient, DEFAULT_SYRA_BASE_URL, } from './client';
-export type { SyraClient, SyraClientOptions, SearchTracksOptions, ArtworkSource, } from './client';
-export { trackSummarySchema, coverArtSizesSchema, coverArtVariantSchema, } from './schema';
-export type { TrackSummary, CoverArtSizes, CoverArtVariant, ArtworkSize, } from './schema';
+export { createSyraClient, DEFAULT_SYRA_BASE_URL, DEFAULT_SYRA_WEB_BASE_URL, } from './client';
+export type { SyraClient, SyraClientOptions, SearchTracksOptions, SearchPodcastsOptions, SearchPage, ArtworkSource, PodcastArtworkSource, } from './client';
+export { trackSummarySchema, podcastSummarySchema, coverArtSizesSchema, coverArtVariantSchema, } from './schema';
+export type { TrackSummary, PodcastSummary, CoverArtSizes, CoverArtVariant, ArtworkSize, } from './schema';
 export { SyraApiError } from './errors';