@redseat/api 0.3.12 → 0.4.0

package/dist/sse-types.d.ts

@@ -1,4 +1,4 @@
-import { ILibrary, IFile, IEpisode, ISerie, IMovie, IPerson, ITag, IBackup, IWatched, IUnwatched, IRsRequestProcessing, VideoConvertRequest } from './interfaces.js';
+import { ILibrary, IFile, IEpisode, ISerie, IMovie, IBook, IPerson, ITag, IBackup, IWatched, IUnwatched, IRsRequestProcessing, VideoConvertRequest, type ItemWithRelations } from './interfaces.js';
 export type ElementAction = 'Added' | 'Updated' | 'Deleted';
 export type SSEConnectionState = 'disconnected' | 'connecting' | 'connected' | 'reconnecting' | 'error';
 export interface SSEConnectionOptions {
@@ -12,6 +12,18 @@ export interface SSEConnectionOptions {
     initialReconnectDelay?: number;
     /** Maximum reconnect delay in ms (default: 30000) */
     maxReconnectDelay?: number;
+    /** Reconnect when tab becomes visible after being hidden for a while (default: true) */
+    reconnectOnPageVisible?: boolean;
+    /** Minimum hidden time before reconnecting on visible, in ms (default: 30000) */
+    reconnectVisibleAfterMs?: number;
+    /** Reconnect when browser comes back online (default: true) */
+    reconnectOnOnline?: boolean;
+    /** Reconnect on window focus when disconnected/error (default: true) */
+    reconnectOnFocus?: boolean;
+    /** Retry reconnection on auth (401) errors (default: true) */
+    reconnectOnAuthError?: boolean;
+    /** Maximum auth-error reconnect attempts before giving up (default: 5) */
+    maxAuthReconnectAttempts?: number;
 }
 export interface SSEConnectionError {
     type: 'network' | 'auth' | 'server' | 'parse';
@@ -69,21 +81,28 @@ export interface SSEEpisodesEvent {
     library: string;
     episodes: {
         action: ElementAction;
-        episode: IEpisode;
+        episode: ItemWithRelations<IEpisode>;
     }[];
 }
 export interface SSESeriesEvent {
     library: string;
     series: {
         action: ElementAction;
-        serie: ISerie;
+        serie: ItemWithRelations<ISerie>;
     }[];
 }
 export interface SSEMoviesEvent {
     library: string;
     movies: {
         action: ElementAction;
-        movie: IMovie;
+        movie: ItemWithRelations<IMovie>;
+    }[];
+}
+export interface SSEBooksEvent {
+    library: string;
+    books: {
+        action: ElementAction;
+        book: ItemWithRelations<IBook>;
     }[];
 }
 export interface SSEPeopleEvent {
@@ -175,6 +194,7 @@ export interface SSEEventMap {
     'episodes': SSEEpisodesEvent;
     'series': SSESeriesEvent;
     'movies': SSEMoviesEvent;
+    'books': SSEBooksEvent;
     'people': SSEPeopleEvent;
     'tags': SSETagsEvent;
     'backups': SSEBackupsEvent;

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.12",
+    "version": "0.4.0",
     "description": "TypeScript API client library for interacting with Redseat servers",
     "type": "module",
     "main": "./dist/index.js",

package/server.md

@@ -6,6 +6,7 @@ The `ServerApi` class provides server-level operations for managing libraries, s
 
 `ServerApi` handles operations that are not specific to a single library, such as:
 - Listing and creating libraries
+- Updating libraries
 - Getting current user information
 - Managing server settings
 - Listing plugins and credentials
@@ -63,9 +64,15 @@ 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:
+    - `faceThreshold?: number`
+    - `ignoreGroups?: boolean`
+    - `preductionModel?: string` prediction model to use for tagging
+    - `mapProgress?: Record<string, any>[]` allow to map view progress from a user to another user
+    - `dataPath?: string` custom path to store library running data like thumnails, cache, portraits...
   - `hidden`: Optional boolean to hide library
 
 **Returns:** Promise resolving to the created `ILibrary` object with generated `id`
@@ -75,24 +82,41 @@ Creates a new library.
 const newLibrary = await serverApi.addLibrary({
     name: 'My Photos',
     type: 'photos',
-    crypt: true // Enable encryption
+    crypt: true, // Enable encryption
+    settings: {
+        faceThreshold: 0.7
+    }
 });
 console.log(`Created library with ID: ${newLibrary.id}`);
 ```
 
-### `getSetting(key: string): Promise<string>`
+### `updateLibrary(libraryId: string, library: ServerLibraryForUpdate): Promise<ILibrary>`
 
-Retrieves a server setting value by key.
+Updates an existing library.
 
 **Parameters:**
-- `key`: The setting key to retrieve
+- `libraryId`: The library ID to update
+- `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 setting value as a string
+**Returns:** Promise resolving to the updated `ILibrary` object
 
 **Example:**
 ```typescript
-const maxUploadSize = await serverApi.getSetting('max_upload_size');
-console.log(`Max upload size: ${maxUploadSize}`);
+const updatedLibrary = await serverApi.updateLibrary('library-123', {
+    name: 'Renamed Library',
+    settings: {
+        faceThreshold: 0.8
+    }
+});
+console.log(`Updated library: ${updatedLibrary.name}`);
 ```
 
 ### `getPlugins(): Promise<any[]>`
@@ -109,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.
@@ -509,6 +556,11 @@ const newLibrary = await serverApi.addLibrary({
     crypt: true
 });
 
+// Update the library settings
+const updatedLibrary = await serverApi.updateLibrary(newLibrary.id!, {
+    name: 'Encrypted Family Photos'
+});
+
 // Get server settings
 const maxUpload = await serverApi.getSetting('max_upload_size');
 console.log(`Max upload size: ${maxUpload}`);
@@ -535,4 +587,3 @@ try {
 - [RedseatClient Documentation](client.md) - HTTP client used by ServerApi
 - [LibraryApi Documentation](libraries.md) - Library-specific operations
 - [README](README.md) - Package overview
-