@redseat/api 0.3.14 → 0.4.2

package/libraries.md

@@ -678,6 +678,40 @@ const nonSpecialEpisodes = await libraryApi.getEpisodes({
 });
 ````
 
+### `getSerieBooks(serieId: string): Promise<IBook[]>`
+
+Retrieves all books attached to a series.
+
+**Parameters:**
+
+- `serieId`: The ID of the series
+
+**Returns:** Promise resolving to an array of `IBook` objects
+
+**Example:**
+
+```typescript
+const serieBooks = await libraryApi.getSerieBooks('serie-id');
+console.log(serieBooks.length);
+```
+
+### `getBookMedias(bookId: string): Promise<IFile[]>`
+
+Retrieves all media files attached to a book.
+
+**Parameters:**
+
+- `bookId`: The ID of the book
+
+**Returns:** Promise resolving to an array of `IFile` objects
+
+**Example:**
+
+```typescript
+const medias = await libraryApi.getBookMedias('book-id');
+console.log(medias.map((media) => media.name));
+```
+
 ### `createSerie(serie: Partial<ISerie>): Promise<ISerie>`
 
 Creates a new series.
@@ -879,7 +913,7 @@ Removes an alternative name from a series.
 await libraryApi.serieRemoveAlt('serie-id', 'alternative-name');
 ```
 
-### `searchSeries(name: string): Promise<ISerie[]>`
+### `searchSeries(name: string): Promise<SerieSearchResult[]>`
 
 Searches for series by name.
 
@@ -887,12 +921,43 @@ Searches for series by name.
 
 - `name`: Search query
 
-**Returns:** Promise resolving to an array of matching `ISerie` objects
+**Returns:** Promise resolving to an array of `SerieSearchResult` items (`metadata.serie` + optional `relations.extImages`, `relations.peopleDetails`, `relations.tagsDetails`, `relations.people`, `relations.tags`)
 
 **Example:**
 
 ```typescript
 const results = await libraryApi.searchSeries('Breaking');
+const serie = results[0]?.metadata?.serie;
+const images = results[0]?.relations?.extImages;
+```
+
+### `searchSeriesStream(name: string, callbacks: SearchStreamCallbacks<SerieSearchStreamResult>): () => void`
+
+Starts a series search stream and emits grouped incremental results.
+
+**Parameters:**
+
+- `name`: Search query
+- `callbacks`: Stream callbacks (`onResults`, `onFinished`, `onError`)
+
+Each streamed item uses `SerieSearchStreamResult` shape:
+- `metadata.serie` contains the serie payload
+- `relations.extImages` contains external images (replaces old top-level `images`)
+- `relations.peopleDetails`, `relations.tagsDetails`, `relations.people`, `relations.tags` are optional relation fields
+
+**Returns:** Cleanup function that closes the stream and removes listeners
+
+**Example:**
+
+```typescript
+const stop = libraryApi.searchSeriesStream('Breaking', {
+	onResults: (groups) => console.log(groups),
+	onFinished: () => console.log('done'),
+	onError: (error) => console.error(error)
+});
+
+// Later
+stop();
 ```
 
 ### `setEpisodeWatched(serieId: string, season: number, number: number, date: number): Promise<void>`
@@ -1175,7 +1240,7 @@ Sets the view progress for a movie. Progress is stored in the global history sys
 await libraryApi.setMovieProgress('movie-id', 2700000);
 ```
 
-### `searchMovies(name: string): Promise<IMovie[]>`
+### `searchMovies(name: string): Promise<MovieSearchResult[]>`
 
 Searches for movies by name.
 
@@ -1183,12 +1248,86 @@ Searches for movies by name.
 
 - `name`: Search query
 
-**Returns:** Promise resolving to an array of matching `IMovie` objects
+**Returns:** Promise resolving to an array of `MovieSearchResult` items (`metadata.movie` + optional `relations.extImages`, `relations.peopleDetails`, `relations.tagsDetails`, `relations.people`, `relations.tags`)
 
 **Example:**
 
 ```typescript
 const results = await libraryApi.searchMovies('Matrix');
+const movie = results[0]?.metadata?.movie;
+const images = results[0]?.relations?.extImages;
+```
+
+### `searchMoviesStream(name: string, callbacks: SearchStreamCallbacks<MovieSearchStreamResult>): () => void`
+
+Starts a movie search stream and emits grouped incremental results.
+
+**Parameters:**
+
+- `name`: Search query
+- `callbacks`: Stream callbacks (`onResults`, `onFinished`, `onError`)
+
+Each streamed item uses `MovieSearchStreamResult` shape:
+- `metadata.movie` contains the movie payload
+- `relations.extImages` contains external images (replaces old top-level `images`)
+- `relations.peopleDetails`, `relations.tagsDetails`, `relations.people`, `relations.tags` are optional relation fields
+
+**Returns:** Cleanup function that closes the stream and removes listeners
+
+**Example:**
+
+```typescript
+const stop = libraryApi.searchMoviesStream('Matrix', {
+	onResults: (groups) => console.log(groups)
+});
+
+// Later
+stop();
+```
+
+### `searchBooks(name: string): Promise<BookSearchResult[]>`
+
+Searches for books by name.
+
+**Parameters:**
+
+- `name`: Search query
+
+**Returns:** Promise resolving to an array of `BookSearchResult` items (`metadata.book` + optional `relations.extImages`, `relations.peopleDetails`, `relations.tagsDetails`, `relations.people`, `relations.tags`)
+
+**Example:**
+
+```typescript
+const results = await libraryApi.searchBooks('Dune');
+const book = results[0]?.metadata?.book;
+const images = results[0]?.relations?.extImages;
+```
+
+### `searchBooksStream(name: string, callbacks: SearchStreamCallbacks<BookSearchStreamResult>): () => void`
+
+Starts a book search stream and emits grouped incremental results.
+
+**Parameters:**
+
+- `name`: Search query
+- `callbacks`: Stream callbacks (`onResults`, `onFinished`, `onError`)
+
+Each streamed item uses `BookSearchStreamResult` shape:
+- `metadata.book` contains the book payload
+- `relations.extImages` contains external images (replaces old top-level `images`)
+- `relations.peopleDetails`, `relations.tagsDetails`, `relations.people`, `relations.tags` are optional relation fields
+
+**Returns:** Cleanup function that closes the stream and removes listeners
+
+**Example:**
+
+```typescript
+const stop = libraryApi.searchBooksStream('Dune', {
+	onResults: (groups) => console.log(groups)
+});
+
+// Later
+stop();
 ```
 
 ### `movieRename(movieId: string, newName: string): Promise<IMovie>`
@@ -1407,6 +1546,34 @@ if (library.crypt) {
 }
 ```
 
+### `uploadMediaMultipart(options: UploadMediaMultipartOptions): Promise<unknown>`
+
+Uploads media with raw multipart form data.
+
+`info` is optional. When provided, it is sent as the `info` multipart field.
+
+**Parameters:**
+
+- `options.file`: Required file/blob payload
+- `options.info?`: Optional `MediaForUpdate` payload serialized into `info`
+- `options.filename?`: Optional multipart filename override
+- `options.progressCallback?`: Optional upload progress callback `(loaded, total) => void`
+
+**Example:**
+
+```typescript
+await libraryApi.uploadMediaMultipart({
+	file,
+	info: {
+		name: 'photo.jpg',
+		mimetype: 'image/jpeg'
+	},
+	progressCallback: (loaded, total) => {
+		console.log(loaded, total);
+	}
+});
+```
+
 ### `uploadGroup(download: RsGroupDownload, options?: { spawn?: boolean }): Promise<IFile[] | { downloading: boolean }>`
 
 Uploads a group of media files from URLs.
@@ -1591,14 +1758,14 @@ Removes a tag from a media file.
 await libraryApi.removeTagFromMedia('media-id', 'tag-id');
 ```
 
-### `mediaUpdate(mediaId: string, update: any): Promise<IFile[]>`
+### `mediaUpdate(mediaId: string, update: MediaForUpdate): Promise<IFile[]>`
 
 Updates a media file's metadata.
 
 **Parameters:**
 
 - `mediaId`: The ID of the media
-- `update`: Update object (see `MediaForUpdate` interface)
+- `update`: Rust-aligned media update object (`MediaForUpdate`, camelCase fields)
 
 **Returns:** Promise resolving to an array of updated `IFile` objects
 
@@ -1611,13 +1778,13 @@ await libraryApi.mediaUpdate('media-id', {
 });
 ```
 
-### `mediaUpdateMany(update: any, ids: string[]): Promise<IFile[]>`
+### `mediaUpdateMany(update: MediaForUpdate, ids: string[]): Promise<IFile[]>`
 
 Updates multiple media files.
 
 **Parameters:**
 
-- `update`: Update object
+- `update`: Rust-aligned media update object (`MediaForUpdate`, camelCase fields)
 - `ids`: Array of media IDs to update
 
 **Returns:** Promise resolving to an array of updated `IFile` objects
@@ -1645,7 +1812,7 @@ Updates the watch progress for a media file.
 await libraryApi.mediaUpdateProgress('media-id', 50);
 ```
 
-### `mediaUpdateChannel(mediaId: string, update: any): Promise<IFile[]>`
+### `mediaUpdateChannel(mediaId: string, update: IChannelUpdate): Promise<IFile[]>`
 
 Updates channel information for a media file.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@redseat/api",
-    "version": "0.3.14",
+    "version": "0.4.2",
     "description": "TypeScript API client library for interacting with Redseat servers",
     "type": "module",
     "main": "./dist/index.js",

package/server.md

@@ -64,7 +64,7 @@ Creates a new library.
 **Parameters:**
 - `library`: Partial library object with required fields:
   - `name`: Library name (required)
-  - `type`: Library type - `'photos'`, `'shows'`, `'movies'`, or `'iptv'` (required)
+  - `type`: Library type - `'photos'`, `'shows'`, `'movies'`, `'books'`, or `'iptv'` (required)
   - `source`: Optional source type
   - `crypt`: Optional boolean to enable encryption
   - `settings`: Optional library settings object:
@@ -90,13 +90,21 @@ const newLibrary = await serverApi.addLibrary({
 console.log(`Created library with ID: ${newLibrary.id}`);
 ```
 
-### `updateLibrary(libraryId: string, library: Partial<ILibrary>): Promise<ILibrary>`
+### `updateLibrary(libraryId: string, library: ServerLibraryForUpdate): Promise<ILibrary>`
 
 Updates an existing library.
 
 **Parameters:**
 - `libraryId`: The library ID to update
-- `library`: Partial library object containing fields to update (for example `name`, `source`, or `settings`)
+- `library`: Partial library update object. Supported fields:
+  - `name?: string`
+  - `source?: LibrarySources`
+  - `root?: string`
+  - `settings?: ServerLibrarySettings`
+  - `credentials?: string`
+  - `plugin?: string`
+
+`type` and `crypt` are not updatable through this endpoint.
 
 **Returns:** Promise resolving to the updated `ILibrary` object
 
@@ -125,6 +133,29 @@ plugins.forEach(plugin => {
 });
 ```
 
+### `searchLookupStream(query: string, type: string, callbacks: SearchStreamCallbacks<LookupSearchStreamResult>): () => void`
+
+Starts a plugin lookup search stream and emits grouped incremental results.
+
+**Parameters:**
+- `query`: Search query text
+- `type`: Lookup type (typically library type)
+- `callbacks`: Stream callbacks (`onResults`, `onFinished`, `onError`)
+
+**Returns:** Cleanup function that closes the stream and removes listeners
+
+**Example:**
+```typescript
+const stop = serverApi.searchLookupStream('matrix', 'movies', {
+    onResults: (groups) => console.log(groups),
+    onFinished: () => console.log('lookup done'),
+    onError: (error) => console.error(error)
+});
+
+// Later
+stop();
+```
+
 ### `getCredentials(): Promise<ICredential[]>`
 
 Retrieves all available credentials configured on the server.