npm - @redseat/api - Versions diffs - 0.0.12 → 0.0.14 - Mend

@redseat/api 0.0.12 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/libraries.md CHANGED Viewed

@@ -1,1652 +1,1652 @@
-# LibraryApi
-The `LibraryApi` class provides comprehensive operations for managing media, tags, people, series, movies, and more within a specific library.
-## Overview
-`LibraryApi` handles all library-specific operations including:
-- Media management (upload, download, update, delete)
-- Tags, people, series, and movies
-- Face recognition and clustering
-- Encryption support for encrypted libraries
-- Plugin integration
-## Constructor
-```typescript
-new LibraryApi(client: RedseatClient, libraryId: string, library: ILibrary)
-```
-**Parameters:**
-- `client`: An initialized `RedseatClient` instance
-- `libraryId`: The ID of the library
-- `library`: The `ILibrary` object with library configuration
-**Example:**
-```typescript
-import { RedseatClient, LibraryApi, ServerApi } from '@redseat/api';
-const client = new RedseatClient({ /* ... */ });
-const serverApi = new ServerApi(client);
-const libraries = await serverApi.getLibraries();
-const library = libraries[0];
-const libraryApi = new LibraryApi(client, library.id!, library);
-```
-## Initialization
-### `setKey(passPhrase: string): Promise<void>`
-Sets the encryption key for encrypted libraries. Must be called before any operations on encrypted libraries.
-**Parameters:**
-- `passPhrase`: The passphrase to derive encryption keys from
-**Throws:** Error if the passphrase is incorrect (for encrypted libraries)
-**Example:**
-```typescript
-if (library.crypt) {
-    try {
-        await libraryApi.setKey('my-secure-password');
-        console.log('Encryption key set successfully');
-    } catch (error) {
-        console.error('Invalid encryption key:', error.message);
-    }
-}
-```
-**Note:** This method verifies the key by attempting to decrypt a media thumbnail. If decryption fails, it throws an error.
----
-## Tags
-### `getTags(): Promise<ITag[]>`
-Retrieves all tags in the library.
-**Returns:** Promise resolving to an array of `ITag` objects
-**Example:**
-```typescript
-const tags = await libraryApi.getTags();
-tags.forEach(tag => console.log(tag.name));
-```
-### `createTag(tag: Partial<ITag>): Promise<ITag>`
-Creates a new tag.
-**Parameters:**
-- `tag`: Partial tag object with at least `name` property
-**Returns:** Promise resolving to the created `ITag` object
-**Example:**
-```typescript
-const newTag = await libraryApi.createTag({ name: 'Vacation' });
-```
-### `removeTag(tagId: string): Promise<void>`
-Deletes a tag.
-**Parameters:**
-- `tagId`: The ID of the tag to remove
-**Example:**
-```typescript
-await libraryApi.removeTag('tag-id-123');
-```
-### `renameTag(tagId: string, newName: string): Promise<ITag>`
-Renames a tag.
-**Parameters:**
-- `tagId`: The ID of the tag
-- `newName`: The new name for the tag
-**Returns:** Promise resolving to the updated `ITag` object
-**Example:**
-```typescript
-const updated = await libraryApi.renameTag('tag-id', 'New Tag Name');
-```
-### `tagChangeParent(tagId: string, newParent?: string): Promise<ITag>`
-Changes the parent tag (for tag hierarchy).
-**Parameters:**
-- `tagId`: The ID of the tag
-- `newParent`: Optional parent tag ID (undefined to remove parent)
-**Returns:** Promise resolving to the updated `ITag` object
-**Example:**
-```typescript
-// Set parent
-await libraryApi.tagChangeParent('child-tag-id', 'parent-tag-id');
-// Remove parent
-await libraryApi.tagChangeParent('tag-id', undefined);
-```
-### `tagMerge(fromId: string, intoId: string): Promise<ITag>`
-Merges one tag into another.
-**Parameters:**
-- `fromId`: The tag ID to merge from (will be deleted)
-- `intoId`: The tag ID to merge into
-**Returns:** Promise resolving to the merged `ITag` object
-**Example:**
-```typescript
-await libraryApi.tagMerge('old-tag-id', 'new-tag-id');
-```
-### `tagAddAlt(tagId: string, alt: string): Promise<ITag>`
-Adds an alternative name to a tag.
-**Parameters:**
-- `tagId`: The ID of the tag
-- `alt`: Alternative name to add
-**Returns:** Promise resolving to the updated `ITag` object
-**Example:**
-```typescript
-await libraryApi.tagAddAlt('tag-id', 'alternative-name');
-```
-### `tagRemoveAlt(tagId: string, alt: string): Promise<ITag>`
-Removes an alternative name from a tag.
-**Parameters:**
-- `tagId`: The ID of the tag
-- `alt`: Alternative name to remove
-**Returns:** Promise resolving to the updated `ITag` object
-**Example:**
-```typescript
-await libraryApi.tagRemoveAlt('tag-id', 'alternative-name');
-```
----
-## People
-### `getPeople(): Promise<IPerson[]>`
-Retrieves all people in the library.
-**Returns:** Promise resolving to an array of `IPerson` objects
-**Example:**
-```typescript
-const people = await libraryApi.getPeople();
-```
-### `createPerson(person: Partial<IPerson>): Promise<IPerson>`
-Creates a new person.
-**Parameters:**
-- `person`: Partial person object with at least `name` property
-**Returns:** Promise resolving to the created `IPerson` object
-**Example:**
-```typescript
-const person = await libraryApi.createPerson({ name: 'John Doe' });
-```
-### `removePerson(personId: string): Promise<void>`
-Deletes a person.
-**Parameters:**
-- `personId`: The ID of the person to remove
-**Example:**
-```typescript
-await libraryApi.removePerson('person-id');
-```
-### `updatePerson(personId: string, updates: Partial<IPerson>): Promise<IPerson>`
-Updates a person's information.
-**Parameters:**
-- `personId`: The ID of the person
-- `updates`: Partial person object with fields to update
-**Returns:** Promise resolving to the updated `IPerson` object
-**Example:**
-```typescript
-await libraryApi.updatePerson('person-id', { birthday: 1234567890 });
-```
-### `personRename(personId: string, newName: string): Promise<IPerson>`
-Renames a person.
-**Parameters:**
-- `personId`: The ID of the person
-- `newName`: The new name
-**Returns:** Promise resolving to the updated `IPerson` object
-**Example:**
-```typescript
-await libraryApi.personRename('person-id', 'Jane Doe');
-```
-### `personAddAlt(personId: string, alt: string): Promise<IPerson>`
-Adds an alternative name to a person.
-**Parameters:**
-- `personId`: The ID of the person
-- `alt`: Alternative name to add
-**Returns:** Promise resolving to the updated `IPerson` object
-**Example:**
-```typescript
-await libraryApi.personAddAlt('person-id', 'nickname');
-```
-### `personRemoveAlt(personId: string, alt: string): Promise<IPerson>`
-Removes an alternative name from a person.
-**Parameters:**
-- `personId`: The ID of the person
-- `alt`: Alternative name to remove
-**Returns:** Promise resolving to the updated `IPerson` object
-**Example:**
-```typescript
-await libraryApi.personRemoveAlt('person-id', 'nickname');
-```
-### `personAddSocial(personId: string, social: any): Promise<IPerson>`
-Adds a social media link to a person.
-**Parameters:**
-- `personId`: The ID of the person
-- `social`: Social media object with `id`, `type`, and `platform`
-**Returns:** Promise resolving to the updated `IPerson` object
-**Example:**
-```typescript
-await libraryApi.personAddSocial('person-id', {
-    id: 'username',
-    type: 'profile',
-    platform: 'instagram'
-});
-```
-### `personRemoveSocial(personId: string, social: any): Promise<IPerson>`
-Removes a social media link from a person.
-**Parameters:**
-- `personId`: The ID of the person
-- `social`: Social media object to remove
-**Returns:** Promise resolving to the updated `IPerson` object
-**Example:**
-```typescript
-await libraryApi.personRemoveSocial('person-id', socialObject);
-```
-### `updatePersonPortrait(personId: string, portrait: FormData): Promise<void>`
-Updates a person's portrait image.
-**Parameters:**
-- `personId`: The ID of the person
-- `portrait`: FormData containing the portrait image
-**Example:**
-```typescript
-const formData = new FormData();
-formData.append('file', imageBlob);
-await libraryApi.updatePersonPortrait('person-id', formData);
-```
----
-## Series
-### `getSeries(): Promise<ISerie[]>`
-Retrieves all series in the library, sorted by name.
-**Returns:** Promise resolving to an array of `ISerie` objects
-**Example:**
-```typescript
-const series = await libraryApi.getSeries();
-```
-### `createSerie(serie: Partial<ISerie>): Promise<ISerie>`
-Creates a new series.
-**Parameters:**
-- `serie`: Partial series object
-**Returns:** Promise resolving to the created `ISerie` object
-**Example:**
-```typescript
-const serie = await libraryApi.createSerie({ name: 'Breaking Bad' });
-```
-### `createEpisode(episode: Partial<IEpisode>): Promise<IEpisode>`
-Creates a new episode.
-**Parameters:**
-- `episode`: Partial episode object
-**Returns:** Promise resolving to the created `IEpisode` object
-**Example:**
-```typescript
-const episode = await libraryApi.createEpisode({
-    serie: 'serie-id',
-    season: 1,
-    number: 1,
-    name: 'Pilot'
-});
-```
-### `serieScrap(serieId: string, date?: number): Promise<void>`
-Triggers metadata scraping for a series.
-**Parameters:**
-- `serieId`: The ID of the series
-- `date`: Optional date parameter
-**Example:**
-```typescript
-await libraryApi.serieScrap('serie-id');
-```
-### `removeSerie(serieId: string): Promise<void>`
-Deletes a series.
-**Parameters:**
-- `serieId`: The ID of the series to remove
-**Example:**
-```typescript
-await libraryApi.removeSerie('serie-id');
-```
-### `updateSerie(serieId: string, updates: Partial<ISerie>): Promise<ISerie>`
-Updates a series.
-**Parameters:**
-- `serieId`: The ID of the series
-- `updates`: Partial series object with fields to update
-**Returns:** Promise resolving to the updated `ISerie` object
-**Example:**
-```typescript
-await libraryApi.updateSerie('serie-id', { description: 'New description' });
-```
-### `getSerieImages(serieId: string): Promise<ExternalImage[]>`
-Gets available images for a series from external sources.
-**Parameters:**
-- `serieId`: The ID of the series
-**Returns:** Promise resolving to an array of `ExternalImage` objects
-**Example:**
-```typescript
-const images = await libraryApi.getSerieImages('serie-id');
-```
-### `updateSeriePoster(serieId: string, poster: FormData, type: string): Promise<void>`
-Updates a series poster image.
-**Parameters:**
-- `serieId`: The ID of the series
-- `poster`: FormData containing the poster image
-- `type`: Poster type (e.g., 'poster', 'backdrop')
-**Example:**
-```typescript
-const formData = new FormData();
-formData.append('file', posterBlob);
-await libraryApi.updateSeriePoster('serie-id', formData, 'poster');
-```
-### `updateSeriePosterWithMediaThumb(serieId: string, mediaId: string, type: string): Promise<ISerie>`
-Sets a series poster using a media thumbnail.
-**Parameters:**
-- `serieId`: The ID of the series
-- `mediaId`: The ID of the media to use as poster
-- `type`: Poster type
-**Returns:** Promise resolving to the updated `ISerie` object
-**Example:**
-```typescript
-await libraryApi.updateSeriePosterWithMediaThumb('serie-id', 'media-id', 'poster');
-```
-### `updateSerieImageFetch(serieId: string, image: ExternalImage): Promise<void>`
-Fetches and sets an external image as series poster.
-**Parameters:**
-- `serieId`: The ID of the series
-- `image`: External image object to fetch
-**Example:**
-```typescript
-await libraryApi.updateSerieImageFetch('serie-id', externalImage);
-```
-### `serieRename(serieId: string, newName: string): Promise<ISerie>`
-Renames a series.
-**Parameters:**
-- `serieId`: The ID of the series
-- `newName`: The new name
-**Returns:** Promise resolving to the updated `ISerie` object
-**Example:**
-```typescript
-await libraryApi.serieRename('serie-id', 'New Series Name');
-```
-### `serieAddAlt(serieId: string, alt: string): Promise<ISerie>`
-Adds an alternative name to a series.
-**Parameters:**
-- `serieId`: The ID of the series
-- `alt`: Alternative name to add
-**Returns:** Promise resolving to the updated `ISerie` object
-**Example:**
-```typescript
-await libraryApi.serieAddAlt('serie-id', 'alternative-name');
-```
-### `serieRemoveAlt(serieId: string, alt: string): Promise<ISerie>`
-Removes an alternative name from a series.
-**Parameters:**
-- `serieId`: The ID of the series
-- `alt`: Alternative name to remove
-**Returns:** Promise resolving to the updated `ISerie` object
-**Example:**
-```typescript
-await libraryApi.serieRemoveAlt('serie-id', 'alternative-name');
-```
-### `searchSeries(name: string): Promise<ISerie[]>`
-Searches for series by name.
-**Parameters:**
-- `name`: Search query
-**Returns:** Promise resolving to an array of matching `ISerie` objects
-**Example:**
-```typescript
-const results = await libraryApi.searchSeries('Breaking');
-```
-### `setEpisodeWatched(serieId: string, season: number, number: number, date: number): Promise<void>`
-Marks an episode as watched.
-**Parameters:**
-- `serieId`: The ID of the series
-- `season`: Season number
-- `number`: Episode number
-- `date`: Timestamp of when it was watched
-**Example:**
-```typescript
-await libraryApi.setEpisodeWatched('serie-id', 1, 1, Date.now());
-```
----
-## Movies
-### `getMovies(): Promise<IMovie[]>`
-Retrieves all movies in the library.
-**Returns:** Promise resolving to an array of `IMovie` objects
-**Example:**
-```typescript
-const movies = await libraryApi.getMovies();
-```
-### `createMovie(movie: Partial<IMovie>): Promise<IMovie>`
-Creates a new movie.
-**Parameters:**
-- `movie`: Partial movie object
-**Returns:** Promise resolving to the created `IMovie` object
-**Example:**
-```typescript
-const movie = await libraryApi.createMovie({ name: 'The Matrix' });
-```
-### `movieScrap(movieId: string, date?: number): Promise<void>`
-Triggers metadata scraping for a movie.
-**Parameters:**
-- `movieId`: The ID of the movie
-- `date`: Optional date parameter
-**Example:**
-```typescript
-await libraryApi.movieScrap('movie-id');
-```
-### `removeMovie(movieId: string): Promise<void>`
-Deletes a movie.
-**Parameters:**
-- `movieId`: The ID of the movie to remove
-**Example:**
-```typescript
-await libraryApi.removeMovie('movie-id');
-```
-### `updateMovie(movieId: string, updates: Partial<IMovie>): Promise<IMovie>`
-Updates a movie.
-**Parameters:**
-- `movieId`: The ID of the movie
-- `updates`: Partial movie object with fields to update
-**Returns:** Promise resolving to the updated `IMovie` object
-**Example:**
-```typescript
-await libraryApi.updateMovie('movie-id', { description: 'New description' });
-```
-### `getMovieImages(movieId: string): Promise<ExternalImage[]>`
-Gets available images for a movie from external sources.
-**Parameters:**
-- `movieId`: The ID of the movie
-**Returns:** Promise resolving to an array of `ExternalImage` objects
-**Example:**
-```typescript
-const images = await libraryApi.getMovieImages('movie-id');
-```
-### `setMovieWatched(movieId: string, date: number): Promise<void>`
-Marks a movie as watched.
-**Parameters:**
-- `movieId`: The ID of the movie
-- `date`: Timestamp of when it was watched
-**Example:**
-```typescript
-await libraryApi.setMovieWatched('movie-id', Date.now());
-```
-### `searchMovies(name: string): Promise<IMovie[]>`
-Searches for movies by name.
-**Parameters:**
-- `name`: Search query
-**Returns:** Promise resolving to an array of matching `IMovie` objects
-**Example:**
-```typescript
-const results = await libraryApi.searchMovies('Matrix');
-```
-### `movieRename(movieId: string, newName: string): Promise<IMovie>`
-Renames a movie.
-**Parameters:**
-- `movieId`: The ID of the movie
-- `newName`: The new name
-**Returns:** Promise resolving to the updated `IMovie` object
-**Example:**
-```typescript
-await libraryApi.movieRename('movie-id', 'New Movie Name');
-```
-### `updateMoviePoster(movieId: string, poster: FormData, type: string): Promise<void>`
-Updates a movie poster image.
-**Parameters:**
-- `movieId`: The ID of the movie
-- `poster`: FormData containing the poster image
-- `type`: Poster type
-**Example:**
-```typescript
-const formData = new FormData();
-formData.append('file', posterBlob);
-await libraryApi.updateMoviePoster('movie-id', formData, 'poster');
-```
-### `updateMovieImageFetch(movieId: string, image: ExternalImage): Promise<void>`
-Fetches and sets an external image as movie poster.
-**Parameters:**
-- `movieId`: The ID of the movie
-- `image`: External image object to fetch
-**Example:**
-```typescript
-await libraryApi.updateMovieImageFetch('movie-id', externalImage);
-```
----
-## Media
-### `getMedias(filter?: MediaRequest): Promise<IFile[]>`
-Retrieves media files with optional filtering.
-**Parameters:**
-- `filter`: Optional `MediaRequest` object for filtering/sorting
-**Returns:** Promise resolving to an array of `IFile` objects
-**Example:**
-```typescript
-// Get all media
-const allMedias = await libraryApi.getMedias();
-// Get filtered media
-const photos = await libraryApi.getMedias({
-    type: 'photo',
-    limit: 50,
-    offset: 0
-});
-```
-### `getMedia(mediaId: string, options?: { type?: 'stream' | 'arraybuffer' | 'blob' }): Promise<ReadableStream | ArrayBuffer | Blob>`
-Downloads a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `options`: Optional object with `type` property ('stream', 'arraybuffer', or 'blob')
-**Returns:** Promise resolving to the media data in the requested format
-**Example:**
-```typescript
-// Get as blob
-const blob = await libraryApi.getMedia('media-id', { type: 'blob' });
-// Get as stream
-const stream = await libraryApi.getMedia('media-id', { type: 'stream' });
-// For encrypted libraries, decrypt after getting
-if (library.crypt) {
-    const encryptedBlob = await libraryApi.getMedia('media-id', { type: 'arraybuffer' });
-    const decrypted = await libraryApi.decryptFile('passphrase', encryptedBlob);
-}
-```
-### `getThumb(mediaId: string, options?: { type?: 'stream' | 'arraybuffer' | 'blob' }): Promise<ReadableStream | ArrayBuffer | Blob>`
-Gets a media thumbnail.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `options`: Optional object with `type` property
-**Returns:** Promise resolving to the thumbnail data
-**Example:**
-```typescript
-// Get thumbnail as blob
-const thumbBlob = await libraryApi.getThumb('media-id', { type: 'blob' });
-// For encrypted libraries, decrypt thumbnail
-if (library.crypt) {
-    const media = await libraryApi.getMediaMetadata('media-id');
-    const iv = uint8ArrayFromBase64(media.iv!);
-    const encryptedThumb = await libraryApi.getThumb('media-id', { type: 'arraybuffer' });
-    const decryptedThumb = await libraryApi.decryptMedia('passphrase', encryptedThumb, iv);
-}
-```
-### `getMediaMetadata(mediaId: string): Promise<IFile>`
-Gets metadata for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-**Returns:** Promise resolving to `IFile` object with metadata
-**Example:**
-```typescript
-const metadata = await libraryApi.getMediaMetadata('media-id');
-console.log(`File: ${metadata.name}, Size: ${metadata.size}`);
-```
-### `getMediaBackupMetadatas(mediaId: string): Promise<IBackupFile[]>`
-Gets backup metadata for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-**Returns:** Promise resolving to an array of `IBackupFile` objects
-**Example:**
-```typescript
-const backups = await libraryApi.getMediaBackupMetadatas('media-id');
-```
-### `uploadMedia(data: ArrayBuffer | Uint8Array, options: UploadMediaOptions): Promise<IFile>`
-Uploads a media file to the library.
-**Parameters:**
-- `data`: File data as `ArrayBuffer` or `Uint8Array`
-- `options`: Upload options object:
-  - `thumb?`: Optional thumbnail data (`ArrayBuffer` or `Uint8Array`) - only for encrypted libraries
-  - `metadata`: Media metadata (see `MediaForUpdate` interface)
-  - `fileMime`: MIME type of the file (e.g., 'image/jpeg')
-  - `thumbMime?`: Optional MIME type of thumbnail (default: 'image/jpeg')
-  - `progressCallback?`: Optional callback for upload progress `(loaded: number, total: number) => void`
-**Returns:** Promise resolving to the created `IFile` object
-**Throws:** Error if encryption key not set for encrypted libraries, or if thumbnail provided for non-encrypted libraries
-**Example:**
-```typescript
-// Upload to non-encrypted library
-const fileData = await file.arrayBuffer();
-const uploaded = await libraryApi.uploadMedia(fileData, {
-    metadata: {
-        name: 'photo.jpg',
-        description: 'My photo'
-    },
-    fileMime: 'image/jpeg',
-    progressCallback: (loaded, total) => {
-        console.log(`Upload: ${(loaded / total * 100).toFixed(1)}%`);
-    }
-});
-// Upload to encrypted library
-if (library.crypt) {
-    await libraryApi.setKey('passphrase');
-    const fileData = await file.arrayBuffer();
-    const thumbData = await thumbnail.arrayBuffer();
-    const uploaded = await libraryApi.uploadMedia(fileData, {
-        thumb: thumbData,
-        metadata: {
-            name: 'photo.jpg'
-        },
-        fileMime: 'image/jpeg',
-        thumbMime: 'image/jpeg'
-    });
-    // uploaded.iv contains the IV for decryption
-}
-```
-### `removeMedias(mediaIds: string[]): Promise<void>`
-Deletes multiple media files.
-**Parameters:**
-- `mediaIds`: Array of media IDs to delete
-**Example:**
-```typescript
-await libraryApi.removeMedias(['media-1', 'media-2', 'media-3']);
-```
-### `mediaTransfer(formData: FormData): Promise<void>`
-Transfers media using FormData (legacy method).
-**Parameters:**
-- `formData`: FormData containing transfer information
-**Example:**
-```typescript
-const formData = new FormData();
-formData.append('ids', JSON.stringify(['media-1', 'media-2']));
-formData.append('toLibrary', 'target-library-id');
-await libraryApi.mediaTransfer(formData);
-```
-### `mediaTransferMany(medias: string[], deleteOriginal: boolean, toLibraryId: string): Promise<void>`
-Transfers multiple media files to another library.
-**Parameters:**
-- `medias`: Array of media IDs to transfer
-- `deleteOriginal`: Whether to delete originals after transfer
-- `toLibraryId`: Target library ID
-**Example:**
-```typescript
-await libraryApi.mediaTransferMany(
-    ['media-1', 'media-2'],
-    false, // Keep originals
-    'target-library-id'
-);
-```
-### `mediaTransferSingle(mediaId: string, toLibraryId: string, formData: FormData, params?: Map<string, string>): Promise<void>`
-Transfers a single media file to another library.
-**Parameters:**
-- `mediaId`: The ID of the media to transfer
-- `toLibraryId`: Target library ID
-- `formData`: FormData with additional transfer data
-- `params`: Optional query parameters
-**Example:**
-```typescript
-const formData = new FormData();
-formData.append('option', 'value');
-await libraryApi.mediaTransferSingle('media-id', 'target-library-id', formData);
-```
-### `addTagToMedia(mediaId: string, tagId: string): Promise<void>`
-Adds a tag to a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `tagId`: The ID of the tag to add
-**Example:**
-```typescript
-await libraryApi.addTagToMedia('media-id', 'tag-id');
-```
-### `removeTagFromMedia(mediaId: string, tagId: string): Promise<void>`
-Removes a tag from a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `tagId`: The ID of the tag to remove
-**Example:**
-```typescript
-await libraryApi.removeTagFromMedia('media-id', 'tag-id');
-```
-### `mediaUpdate(mediaId: string, update: any): Promise<IFile[]>`
-Updates a media file's metadata.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `update`: Update object (see `MediaForUpdate` interface)
-**Returns:** Promise resolving to an array of updated `IFile` objects
-**Example:**
-```typescript
-await libraryApi.mediaUpdate('media-id', {
-    description: 'New description',
-    rating: 5
-});
-```
-### `mediaUpdateMany(update: any, ids: string[]): Promise<IFile[]>`
-Updates multiple media files.
-**Parameters:**
-- `update`: Update object
-- `ids`: Array of media IDs to update
-**Returns:** Promise resolving to an array of updated `IFile` objects
-**Example:**
-```typescript
-await libraryApi.mediaUpdateMany(
-    { rating: 5 },
-    ['media-1', 'media-2', 'media-3']
-);
-```
-### `mediaUpdateProgress(mediaId: string, progress: number): Promise<{ progress: number }>`
-Updates the watch progress for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `progress`: Progress value (0-100 or time-based)
-**Returns:** Promise resolving to object with updated progress
-**Example:**
-```typescript
-await libraryApi.mediaUpdateProgress('media-id', 50);
-```
-### `mediaUpdateChannel(mediaId: string, update: any): Promise<IFile[]>`
-Updates channel information for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `update`: Channel update object
-**Returns:** Promise resolving to an array of updated `IFile` objects
-**Example:**
-```typescript
-await libraryApi.mediaUpdateChannel('media-id', { channel: 'new-channel' });
-```
-### `refreshMedia(mediaId: string): Promise<IFile[]>`
-Refreshes metadata for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-**Returns:** Promise resolving to an array of updated `IFile` objects
-**Example:**
-```typescript
-await libraryApi.refreshMedia('media-id');
-```
-### `aiTagMedia(mediaId: string): Promise<IFile[]>`
-Triggers AI tagging for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-**Returns:** Promise resolving to an array of updated `IFile` objects with new tags
-**Example:**
-```typescript
-await libraryApi.aiTagMedia('media-id');
-```
-### `splitZip(mediaId: string, from: number, to: number): Promise<IFile>`
-Splits a ZIP archive into a new archive containing pages from `from` to `to`.
-**Parameters:**
-- `mediaId`: The ID of the ZIP media
-- `from`: Starting page number
-- `to`: Ending page number
-**Returns:** Promise resolving to the new `IFile` object
-**Example:**
-```typescript
-const newZip = await libraryApi.splitZip('zip-id', 1, 10);
-```
-### `deleteFromZip(mediaId: string, pages: number[]): Promise<IFile>`
-Deletes pages from a ZIP archive.
-**Parameters:**
-- `mediaId`: The ID of the ZIP media
-- `pages`: Array of page numbers to delete
-**Returns:** Promise resolving to the updated `IFile` object
-**Example:**
-```typescript
-await libraryApi.deleteFromZip('zip-id', [5, 6, 7]);
-```
-### `updateMediaThumb(mediaId: string, thumb: FormData): Promise<void>`
-Updates the thumbnail for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `thumb`: FormData containing the thumbnail image
-**Example:**
-```typescript
-const formData = new FormData();
-formData.append('file', thumbBlob);
-await libraryApi.updateMediaThumb('media-id', formData);
-```
-### `getMediaShares(mediaId: string): Promise<any>`
-Gets sharing information for a media file.
-**Parameters:**
-- `mediaId`: The ID of the media
-**Returns:** Promise resolving to sharing information
-**Example:**
-```typescript
-const shares = await libraryApi.getMediaShares('media-id');
-```
-### `shareMediaToProvider(mediaId: string, provider: string, formData?: FormData): Promise<any>`
-Shares a media file to an external provider.
-**Parameters:**
-- `mediaId`: The ID of the media
-- `provider`: Provider name (e.g., 'instagram', 'twitter')
-- `formData`: Optional FormData with additional sharing data
-**Returns:** Promise resolving to sharing result
-**Example:**
-```typescript
-const result = await libraryApi.shareMediaToProvider('media-id', 'instagram');
-```
----
-## Faces
-### `getUnassignedFaces(params?: Map<string, string>): Promise<any>`
-Gets unassigned faces (faces not yet linked to a person).
-**Parameters:**
-- `params`: Optional query parameters
-**Returns:** Promise resolving to unassigned faces data
-**Example:**
-```typescript
-const params = new Map([['limit', '50']]);
-const faces = await libraryApi.getUnassignedFaces(params);
-```
-### `getClusters(): Promise<any>`
-Gets face clusters (groups of similar faces).
-**Returns:** Promise resolving to clusters data
-**Example:**
-```typescript
-const clusters = await libraryApi.getClusters();
-```
-### `assignFaces(request: any): Promise<any>`
-Assigns faces to a person.
-**Parameters:**
-- `request`: Assignment request object with face IDs and person ID
-**Returns:** Promise resolving to assignment result
-**Example:**
-```typescript
-await libraryApi.assignFaces({
-    faceIds: ['face-1', 'face-2'],
-    personId: 'person-id'
-});
-```
-### `createPersonFromCluster(request: any): Promise<any>`
-Creates a new person from a face cluster.
-**Parameters:**
-- `request`: Request object with cluster ID and person name
-**Returns:** Promise resolving to created person
-**Example:**
-```typescript
-await libraryApi.createPersonFromCluster({
-    clusterId: 'cluster-id',
-    name: 'John Doe'
-});
-```
-### `splitCluster(request: any): Promise<any>`
-Splits a face cluster into multiple clusters.
-**Parameters:**
-- `request`: Split request object
-**Returns:** Promise resolving to split result
-**Example:**
-```typescript
-await libraryApi.splitCluster({
-    clusterId: 'cluster-id',
-    faceIds: ['face-1', 'face-2']
-});
-```
-### `unassignFace(request: any): Promise<any>`
-Unassigns a face from a person.
-**Parameters:**
-- `request`: Unassign request object with face ID
-**Returns:** Promise resolving to unassign result
-**Example:**
-```typescript
-await libraryApi.unassignFace({ faceId: 'face-id' });
-```
-### `deleteFace(faceId: string): Promise<any>`
-Deletes a face.
-**Parameters:**
-- `faceId`: The ID of the face to delete
-**Returns:** Promise resolving to deletion result
-**Example:**
-```typescript
-await libraryApi.deleteFace('face-id');
-```
-### `getAssignedFaces(personId: string): Promise<any>`
-Gets all faces assigned to a person.
-**Parameters:**
-- `personId`: The ID of the person
-**Returns:** Promise resolving to assigned faces
-**Example:**
-```typescript
-const faces = await libraryApi.getAssignedFaces('person-id');
-```
-### `faceClusterPerson(personId: string): Promise<void>`
-Triggers face clustering for a person.
-**Parameters:**
-- `personId`: The ID of the person
-**Example:**
-```typescript
-await libraryApi.faceClusterPerson('person-id');
-```
-### `mergePeople(request: any): Promise<any>`
-Merges multiple people into one.
-**Parameters:**
-- `request`: Merge request object with source and target person IDs
-**Returns:** Promise resolving to merge result
-**Example:**
-```typescript
-await libraryApi.mergePeople({
-    fromIds: ['person-1', 'person-2'],
-    intoId: 'person-3'
-});
-```
-### `clusterFaces(personId: string): Promise<any>`
-Clusters faces for a person.
-**Parameters:**
-- `personId`: The ID of the person
-**Returns:** Promise resolving to clustering result
-**Example:**
-```typescript
-await libraryApi.clusterFaces('person-id');
-```
----
-## Encryption
-These methods are convenience wrappers around the encryption module. For detailed encryption documentation, see [encryption.md](encryption.md).
-### `encryptText(passPhrase: string, text: string): Promise<string>`
-Encrypts a text string using a passphrase.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `text`: The plaintext to encrypt
-**Returns:** Promise resolving to encrypted string in format `${IV}.${encryptedData}` (base64url encoded)
-**Example:**
-```typescript
-const encrypted = await libraryApi.encryptText('password', 'Hello World');
-```
-### `decryptText(passPhrase: string, encryptedText: string): Promise<string>`
-Decrypts a text string using a passphrase.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `encryptedText`: The encrypted text in format `${IV}.${encryptedData}`
-**Returns:** Promise resolving to decrypted plaintext
-**Example:**
-```typescript
-const decrypted = await libraryApi.decryptText('password', encryptedText);
-```
-### `encryptMedia(passPhrase: string, buffer: ArrayBuffer | Uint8Array, iv?: ArrayBuffer | Uint8Array): Promise<ArrayBuffer>`
-Encrypts binary media data using a passphrase.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `buffer`: The binary data to encrypt
-- `iv`: Optional IV (if not provided, a random one is generated)
-**Returns:** Promise resolving to encrypted ArrayBuffer
-**Example:**
-```typescript
-const encrypted = await libraryApi.encryptMedia('password', fileBuffer);
-```
-### `decryptMedia(passPhrase: string, buffer: ArrayBuffer | Uint8Array, iv: ArrayBuffer | Uint8Array): Promise<ArrayBuffer>`
-Decrypts binary media data using a passphrase.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `buffer`: The encrypted binary data
-- `iv`: The IV used during encryption
-**Returns:** Promise resolving to decrypted ArrayBuffer
-**Example:**
-```typescript
-const decrypted = await libraryApi.decryptMedia('password', encryptedBuffer, iv);
-```
-### `encryptFile(passPhrase: string, options: EncryptFileOptions): Promise<EncryptedFile>`
-Encrypts a complete file with thumbnail and metadata.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `options`: Encryption options (see `EncryptFileOptions` interface)
-**Returns:** Promise resolving to `EncryptedFile` object
-**Example:**
-```typescript
-const encrypted = await libraryApi.encryptFile('password', {
-    filename: 'photo.jpg',
-    buffer: fileBuffer,
-    thumb: thumbBuffer,
-    thumbMime: 'image/jpeg',
-    mime: 'image/jpeg'
-});
-```
-### `decryptFile(passPhrase: string, buffer: ArrayBuffer): Promise<ArrayBuffer>`
-Decrypts file data from an encrypted file structure.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `buffer`: The complete encrypted file structure
-**Returns:** Promise resolving to decrypted file ArrayBuffer
-**Example:**
-```typescript
-const decrypted = await libraryApi.decryptFile('password', encryptedFileBlob);
-```
-### `decryptMediaThumb(passPhrase: string, buffer: ArrayBuffer): Promise<ArrayBuffer>`
-Decrypts thumbnail from an encrypted file structure.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `buffer`: The complete encrypted file structure
-**Returns:** Promise resolving to decrypted thumbnail ArrayBuffer
-**Example:**
-```typescript
-const decryptedThumb = await libraryApi.decryptMediaThumb('password', encryptedFileBlob);
-```
-### `encryptFilename(passPhrase: string, filename: string, iv: ArrayBuffer | Uint8Array): Promise<string>`
-Encrypts a filename using a passphrase and IV.
-**Parameters:**
-- `passPhrase`: The passphrase to derive the key from
-- `filename`: The filename to encrypt
-- `iv`: The IV to use (should match the file's IV)
-**Returns:** Promise resolving to base64url encoded encrypted filename
-**Example:**
-```typescript
-const iv = libraryApi.getRandomIV();
-const encryptedFilename = await libraryApi.encryptFilename('password', 'photo.jpg', iv);
-```
-### `getRandomIV(): Uint8Array`
-Generates a random 16-byte IV (Initialization Vector).
-**Returns:** `Uint8Array` of 16 random bytes
-**Example:**
-```typescript
-const iv = libraryApi.getRandomIV();
-```
----
-## Utilities
-### `getCryptChallenge(): Promise<string>`
-Gets a cryptographic challenge for encryption verification.
-**Returns:** Promise resolving to challenge string
-**Example:**
-```typescript
-const challenge = await libraryApi.getCryptChallenge();
-```
-### `getChannels(): Promise<any[]>`
-Gets all channels (for IPTV libraries).
-**Returns:** Promise resolving to an array of channel objects
-**Example:**
-```typescript
-const channels = await libraryApi.getChannels();
-```
-### `getWatermarks(): Promise<string[]>`
-Gets list of available watermark names.
-**Returns:** Promise resolving to an array of watermark names
-**Example:**
-```typescript
-const watermarks = await libraryApi.getWatermarks();
-```
-### `getWatermark(watermark: string, options?: { type?: 'blob' | 'arraybuffer' }): Promise<Blob | ArrayBuffer>`
-Gets a watermark image.
-**Parameters:**
-- `watermark`: Watermark name (or 'default')
-- `options`: Optional object with `type` property
-**Returns:** Promise resolving to watermark data
-**Example:**
-```typescript
-const watermark = await libraryApi.getWatermark('default', { type: 'blob' });
-```
-### `expandUrl(parsedUrl: any): Promise<string | undefined>`
-Expands a parsed URL using plugins.
-**Parameters:**
-- `parsedUrl`: Parsed URL object
-**Returns:** Promise resolving to expanded URL or undefined
-**Example:**
-```typescript
-const expanded = await libraryApi.expandUrl(parsedUrl);
-```
-### `parseUrl(url: string): Promise<any>`
-Parses a URL using plugins.
-**Parameters:**
-- `url`: URL string to parse
-**Returns:** Promise resolving to parsed URL object
-**Example:**
-```typescript
-const parsed = await libraryApi.parseUrl('https://example.com/video');
-```
-### `listVideoConvertPlugins(): Promise<any[]>`
-Lists available video conversion plugins.
-**Returns:** Promise resolving to an array of plugin objects
-**Example:**
-```typescript
-const plugins = await libraryApi.listVideoConvertPlugins();
-```
-### `clean(): Promise<string>`
-Triggers library cleanup operation.
-**Returns:** Promise resolving to cleanup result message
-**Example:**
-```typescript
-const result = await libraryApi.clean();
-```
-### `locs(): Promise<any>`
-Gets location data.
-**Returns:** Promise resolving to location data
-**Example:**
-```typescript
-const locations = await libraryApi.locs();
-```
-### `mergeMedias(request: any): Promise<IFile>`
-Merges multiple media files into one.
-**Parameters:**
-- `request`: Merge request object with media IDs
-**Returns:** Promise resolving to merged `IFile` object
-**Example:**
-```typescript
-const merged = await libraryApi.mergeMedias({
-    ids: ['media-1', 'media-2']
-});
-```
----
-## Common Workflows
-### Uploading Media to Encrypted Library
-```typescript
-// 1. Set encryption key
-await libraryApi.setKey('my-password');
-// 2. Prepare file and thumbnail
-const fileData = await file.arrayBuffer();
-const thumbData = await thumbnail.arrayBuffer();
-// 3. Upload with progress tracking
-const uploaded = await libraryApi.uploadMedia(fileData, {
-    thumb: thumbData,
-    metadata: {
-        name: 'photo.jpg',
-        description: 'My encrypted photo'
-    },
-    fileMime: 'image/jpeg',
-    thumbMime: 'image/jpeg',
-    progressCallback: (loaded, total) => {
-        console.log(`Upload: ${(loaded / total * 100).toFixed(1)}%`);
-    }
-});
-console.log(`Uploaded with IV: ${uploaded.iv}`);
-```
-### Downloading and Decrypting Media
-```typescript
-// 1. Set encryption key
-await libraryApi.setKey('my-password');
-// 2. Get media metadata
-const metadata = await libraryApi.getMediaMetadata('media-id');
-// 3. Download encrypted file
-const encryptedBlob = await libraryApi.getMedia('media-id', { type: 'arraybuffer' });
-// 4. Decrypt file
-const decrypted = await libraryApi.decryptFile('my-password', encryptedBlob);
-// 5. Use decrypted data
-const blob = new Blob([decrypted], { type: metadata.mimetype });
-const url = URL.createObjectURL(blob);
-```
-### Tagging Media
-```typescript
-// 1. Get or create tags
-const tags = await libraryApi.getTags();
-let vacationTag = tags.find(t => t.name === 'Vacation');
-if (!vacationTag) {
-    vacationTag = await libraryApi.createTag({ name: 'Vacation' });
-}
-// 2. Add tag to media
-await libraryApi.addTagToMedia('media-id', vacationTag.id!);
-```
-### Managing People and Faces
-```typescript
-// 1. Create person
-const person = await libraryApi.createPerson({ name: 'John Doe' });
-// 2. Get unassigned faces
-const faces = await libraryApi.getUnassignedFaces();
-// 3. Assign faces to person
-await libraryApi.assignFaces({
-    faceIds: ['face-1', 'face-2'],
-    personId: person.id!
-});
-// 4. Cluster faces for better organization
-await libraryApi.faceClusterPerson(person.id!);
-```
-## Related Documentation
-- [RedseatClient Documentation](client.md) - HTTP client used by LibraryApi
-- [ServerApi Documentation](server.md) - Server-level operations
-- [Encryption Documentation](encryption.md) - Detailed encryption module documentation
-- [README](README.md) - Package overview
+# LibraryApi
+The `LibraryApi` class provides comprehensive operations for managing media, tags, people, series, movies, and more within a specific library.
+## Overview
+`LibraryApi` handles all library-specific operations including:
+- Media management (upload, download, update, delete)
+- Tags, people, series, and movies
+- Face recognition and clustering
+- Encryption support for encrypted libraries
+- Plugin integration
+## Constructor
+```typescript
+new LibraryApi(client: RedseatClient, libraryId: string, library: ILibrary)
+```
+**Parameters:**
+- `client`: An initialized `RedseatClient` instance
+- `libraryId`: The ID of the library
+- `library`: The `ILibrary` object with library configuration
+**Example:**
+```typescript
+import { RedseatClient, LibraryApi, ServerApi } from '@redseat/api';
+const client = new RedseatClient({ /* ... */ });
+const serverApi = new ServerApi(client);
+const libraries = await serverApi.getLibraries();
+const library = libraries[0];
+const libraryApi = new LibraryApi(client, library.id!, library);
+```
+## Initialization
+### `setKey(passPhrase: string): Promise<void>`
+Sets the encryption key for encrypted libraries. Must be called before any operations on encrypted libraries.
+**Parameters:**
+- `passPhrase`: The passphrase to derive encryption keys from
+**Throws:** Error if the passphrase is incorrect (for encrypted libraries)
+**Example:**
+```typescript
+if (library.crypt) {
+    try {
+        await libraryApi.setKey('my-secure-password');
+        console.log('Encryption key set successfully');
+    } catch (error) {
+        console.error('Invalid encryption key:', error.message);
+    }
+}
+```
+**Note:** This method verifies the key by attempting to decrypt a media thumbnail. If decryption fails, it throws an error.
+---
+## Tags
+### `getTags(): Promise<ITag[]>`
+Retrieves all tags in the library.
+**Returns:** Promise resolving to an array of `ITag` objects
+**Example:**
+```typescript
+const tags = await libraryApi.getTags();
+tags.forEach(tag => console.log(tag.name));
+```
+### `createTag(tag: Partial<ITag>): Promise<ITag>`
+Creates a new tag.
+**Parameters:**
+- `tag`: Partial tag object with at least `name` property
+**Returns:** Promise resolving to the created `ITag` object
+**Example:**
+```typescript
+const newTag = await libraryApi.createTag({ name: 'Vacation' });
+```
+### `removeTag(tagId: string): Promise<void>`
+Deletes a tag.
+**Parameters:**
+- `tagId`: The ID of the tag to remove
+**Example:**
+```typescript
+await libraryApi.removeTag('tag-id-123');
+```
+### `renameTag(tagId: string, newName: string): Promise<ITag>`
+Renames a tag.
+**Parameters:**
+- `tagId`: The ID of the tag
+- `newName`: The new name for the tag
+**Returns:** Promise resolving to the updated `ITag` object
+**Example:**
+```typescript
+const updated = await libraryApi.renameTag('tag-id', 'New Tag Name');
+```
+### `tagChangeParent(tagId: string, newParent?: string): Promise<ITag>`
+Changes the parent tag (for tag hierarchy).
+**Parameters:**
+- `tagId`: The ID of the tag
+- `newParent`: Optional parent tag ID (undefined to remove parent)
+**Returns:** Promise resolving to the updated `ITag` object
+**Example:**
+```typescript
+// Set parent
+await libraryApi.tagChangeParent('child-tag-id', 'parent-tag-id');
+// Remove parent
+await libraryApi.tagChangeParent('tag-id', undefined);
+```
+### `tagMerge(fromId: string, intoId: string): Promise<ITag>`
+Merges one tag into another.
+**Parameters:**
+- `fromId`: The tag ID to merge from (will be deleted)
+- `intoId`: The tag ID to merge into
+**Returns:** Promise resolving to the merged `ITag` object
+**Example:**
+```typescript
+await libraryApi.tagMerge('old-tag-id', 'new-tag-id');
+```
+### `tagAddAlt(tagId: string, alt: string): Promise<ITag>`
+Adds an alternative name to a tag.
+**Parameters:**
+- `tagId`: The ID of the tag
+- `alt`: Alternative name to add
+**Returns:** Promise resolving to the updated `ITag` object
+**Example:**
+```typescript
+await libraryApi.tagAddAlt('tag-id', 'alternative-name');
+```
+### `tagRemoveAlt(tagId: string, alt: string): Promise<ITag>`
+Removes an alternative name from a tag.
+**Parameters:**
+- `tagId`: The ID of the tag
+- `alt`: Alternative name to remove
+**Returns:** Promise resolving to the updated `ITag` object
+**Example:**
+```typescript
+await libraryApi.tagRemoveAlt('tag-id', 'alternative-name');
+```
+---
+## People
+### `getPeople(): Promise<IPerson[]>`
+Retrieves all people in the library.
+**Returns:** Promise resolving to an array of `IPerson` objects
+**Example:**
+```typescript
+const people = await libraryApi.getPeople();
+```
+### `createPerson(person: Partial<IPerson>): Promise<IPerson>`
+Creates a new person.
+**Parameters:**
+- `person`: Partial person object with at least `name` property
+**Returns:** Promise resolving to the created `IPerson` object
+**Example:**
+```typescript
+const person = await libraryApi.createPerson({ name: 'John Doe' });
+```
+### `removePerson(personId: string): Promise<void>`
+Deletes a person.
+**Parameters:**
+- `personId`: The ID of the person to remove
+**Example:**
+```typescript
+await libraryApi.removePerson('person-id');
+```
+### `updatePerson(personId: string, updates: Partial<IPerson>): Promise<IPerson>`
+Updates a person's information.
+**Parameters:**
+- `personId`: The ID of the person
+- `updates`: Partial person object with fields to update
+**Returns:** Promise resolving to the updated `IPerson` object
+**Example:**
+```typescript
+await libraryApi.updatePerson('person-id', { birthday: 1234567890 });
+```
+### `personRename(personId: string, newName: string): Promise<IPerson>`
+Renames a person.
+**Parameters:**
+- `personId`: The ID of the person
+- `newName`: The new name
+**Returns:** Promise resolving to the updated `IPerson` object
+**Example:**
+```typescript
+await libraryApi.personRename('person-id', 'Jane Doe');
+```
+### `personAddAlt(personId: string, alt: string): Promise<IPerson>`
+Adds an alternative name to a person.
+**Parameters:**
+- `personId`: The ID of the person
+- `alt`: Alternative name to add
+**Returns:** Promise resolving to the updated `IPerson` object
+**Example:**
+```typescript
+await libraryApi.personAddAlt('person-id', 'nickname');
+```
+### `personRemoveAlt(personId: string, alt: string): Promise<IPerson>`
+Removes an alternative name from a person.
+**Parameters:**
+- `personId`: The ID of the person
+- `alt`: Alternative name to remove
+**Returns:** Promise resolving to the updated `IPerson` object
+**Example:**
+```typescript
+await libraryApi.personRemoveAlt('person-id', 'nickname');
+```
+### `personAddSocial(personId: string, social: any): Promise<IPerson>`
+Adds a social media link to a person.
+**Parameters:**
+- `personId`: The ID of the person
+- `social`: Social media object with `id`, `type`, and `platform`
+**Returns:** Promise resolving to the updated `IPerson` object
+**Example:**
+```typescript
+await libraryApi.personAddSocial('person-id', {
+    id: 'username',
+    type: 'profile',
+    platform: 'instagram'
+});
+```
+### `personRemoveSocial(personId: string, social: any): Promise<IPerson>`
+Removes a social media link from a person.
+**Parameters:**
+- `personId`: The ID of the person
+- `social`: Social media object to remove
+**Returns:** Promise resolving to the updated `IPerson` object
+**Example:**
+```typescript
+await libraryApi.personRemoveSocial('person-id', socialObject);
+```
+### `updatePersonPortrait(personId: string, portrait: FormData): Promise<void>`
+Updates a person's portrait image.
+**Parameters:**
+- `personId`: The ID of the person
+- `portrait`: FormData containing the portrait image
+**Example:**
+```typescript
+const formData = new FormData();
+formData.append('file', imageBlob);
+await libraryApi.updatePersonPortrait('person-id', formData);
+```
+---
+## Series
+### `getSeries(): Promise<ISerie[]>`
+Retrieves all series in the library, sorted by name.
+**Returns:** Promise resolving to an array of `ISerie` objects
+**Example:**
+```typescript
+const series = await libraryApi.getSeries();
+```
+### `createSerie(serie: Partial<ISerie>): Promise<ISerie>`
+Creates a new series.
+**Parameters:**
+- `serie`: Partial series object
+**Returns:** Promise resolving to the created `ISerie` object
+**Example:**
+```typescript
+const serie = await libraryApi.createSerie({ name: 'Breaking Bad' });
+```
+### `createEpisode(episode: Partial<IEpisode>): Promise<IEpisode>`
+Creates a new episode.
+**Parameters:**
+- `episode`: Partial episode object
+**Returns:** Promise resolving to the created `IEpisode` object
+**Example:**
+```typescript
+const episode = await libraryApi.createEpisode({
+    serie: 'serie-id',
+    season: 1,
+    number: 1,
+    name: 'Pilot'
+});
+```
+### `serieScrap(serieId: string, date?: number): Promise<void>`
+Triggers metadata scraping for a series.
+**Parameters:**
+- `serieId`: The ID of the series
+- `date`: Optional date parameter
+**Example:**
+```typescript
+await libraryApi.serieScrap('serie-id');
+```
+### `removeSerie(serieId: string): Promise<void>`
+Deletes a series.
+**Parameters:**
+- `serieId`: The ID of the series to remove
+**Example:**
+```typescript
+await libraryApi.removeSerie('serie-id');
+```
+### `updateSerie(serieId: string, updates: Partial<ISerie>): Promise<ISerie>`
+Updates a series.
+**Parameters:**
+- `serieId`: The ID of the series
+- `updates`: Partial series object with fields to update
+**Returns:** Promise resolving to the updated `ISerie` object
+**Example:**
+```typescript
+await libraryApi.updateSerie('serie-id', { description: 'New description' });
+```
+### `getSerieImages(serieId: string): Promise<ExternalImage[]>`
+Gets available images for a series from external sources.
+**Parameters:**
+- `serieId`: The ID of the series
+**Returns:** Promise resolving to an array of `ExternalImage` objects
+**Example:**
+```typescript
+const images = await libraryApi.getSerieImages('serie-id');
+```
+### `updateSeriePoster(serieId: string, poster: FormData, type: string): Promise<void>`
+Updates a series poster image.
+**Parameters:**
+- `serieId`: The ID of the series
+- `poster`: FormData containing the poster image
+- `type`: Poster type (e.g., 'poster', 'backdrop')
+**Example:**
+```typescript
+const formData = new FormData();
+formData.append('file', posterBlob);
+await libraryApi.updateSeriePoster('serie-id', formData, 'poster');
+```
+### `updateSeriePosterWithMediaThumb(serieId: string, mediaId: string, type: string): Promise<ISerie>`
+Sets a series poster using a media thumbnail.
+**Parameters:**
+- `serieId`: The ID of the series
+- `mediaId`: The ID of the media to use as poster
+- `type`: Poster type
+**Returns:** Promise resolving to the updated `ISerie` object
+**Example:**
+```typescript
+await libraryApi.updateSeriePosterWithMediaThumb('serie-id', 'media-id', 'poster');
+```
+### `updateSerieImageFetch(serieId: string, image: ExternalImage): Promise<void>`
+Fetches and sets an external image as series poster.
+**Parameters:**
+- `serieId`: The ID of the series
+- `image`: External image object to fetch
+**Example:**
+```typescript
+await libraryApi.updateSerieImageFetch('serie-id', externalImage);
+```
+### `serieRename(serieId: string, newName: string): Promise<ISerie>`
+Renames a series.
+**Parameters:**
+- `serieId`: The ID of the series
+- `newName`: The new name
+**Returns:** Promise resolving to the updated `ISerie` object
+**Example:**
+```typescript
+await libraryApi.serieRename('serie-id', 'New Series Name');
+```
+### `serieAddAlt(serieId: string, alt: string): Promise<ISerie>`
+Adds an alternative name to a series.
+**Parameters:**
+- `serieId`: The ID of the series
+- `alt`: Alternative name to add
+**Returns:** Promise resolving to the updated `ISerie` object
+**Example:**
+```typescript
+await libraryApi.serieAddAlt('serie-id', 'alternative-name');
+```
+### `serieRemoveAlt(serieId: string, alt: string): Promise<ISerie>`
+Removes an alternative name from a series.
+**Parameters:**
+- `serieId`: The ID of the series
+- `alt`: Alternative name to remove
+**Returns:** Promise resolving to the updated `ISerie` object
+**Example:**
+```typescript
+await libraryApi.serieRemoveAlt('serie-id', 'alternative-name');
+```
+### `searchSeries(name: string): Promise<ISerie[]>`
+Searches for series by name.
+**Parameters:**
+- `name`: Search query
+**Returns:** Promise resolving to an array of matching `ISerie` objects
+**Example:**
+```typescript
+const results = await libraryApi.searchSeries('Breaking');
+```
+### `setEpisodeWatched(serieId: string, season: number, number: number, date: number): Promise<void>`
+Marks an episode as watched.
+**Parameters:**
+- `serieId`: The ID of the series
+- `season`: Season number
+- `number`: Episode number
+- `date`: Timestamp of when it was watched
+**Example:**
+```typescript
+await libraryApi.setEpisodeWatched('serie-id', 1, 1, Date.now());
+```
+---
+## Movies
+### `getMovies(): Promise<IMovie[]>`
+Retrieves all movies in the library.
+**Returns:** Promise resolving to an array of `IMovie` objects
+**Example:**
+```typescript
+const movies = await libraryApi.getMovies();
+```
+### `createMovie(movie: Partial<IMovie>): Promise<IMovie>`
+Creates a new movie.
+**Parameters:**
+- `movie`: Partial movie object
+**Returns:** Promise resolving to the created `IMovie` object
+**Example:**
+```typescript
+const movie = await libraryApi.createMovie({ name: 'The Matrix' });
+```
+### `movieScrap(movieId: string, date?: number): Promise<void>`
+Triggers metadata scraping for a movie.
+**Parameters:**
+- `movieId`: The ID of the movie
+- `date`: Optional date parameter
+**Example:**
+```typescript
+await libraryApi.movieScrap('movie-id');
+```
+### `removeMovie(movieId: string): Promise<void>`
+Deletes a movie.
+**Parameters:**
+- `movieId`: The ID of the movie to remove
+**Example:**
+```typescript
+await libraryApi.removeMovie('movie-id');
+```
+### `updateMovie(movieId: string, updates: Partial<IMovie>): Promise<IMovie>`
+Updates a movie.
+**Parameters:**
+- `movieId`: The ID of the movie
+- `updates`: Partial movie object with fields to update
+**Returns:** Promise resolving to the updated `IMovie` object
+**Example:**
+```typescript
+await libraryApi.updateMovie('movie-id', { description: 'New description' });
+```
+### `getMovieImages(movieId: string): Promise<ExternalImage[]>`
+Gets available images for a movie from external sources.
+**Parameters:**
+- `movieId`: The ID of the movie
+**Returns:** Promise resolving to an array of `ExternalImage` objects
+**Example:**
+```typescript
+const images = await libraryApi.getMovieImages('movie-id');
+```
+### `setMovieWatched(movieId: string, date: number): Promise<void>`
+Marks a movie as watched.
+**Parameters:**
+- `movieId`: The ID of the movie
+- `date`: Timestamp of when it was watched
+**Example:**
+```typescript
+await libraryApi.setMovieWatched('movie-id', Date.now());
+```
+### `searchMovies(name: string): Promise<IMovie[]>`
+Searches for movies by name.
+**Parameters:**
+- `name`: Search query
+**Returns:** Promise resolving to an array of matching `IMovie` objects
+**Example:**
+```typescript
+const results = await libraryApi.searchMovies('Matrix');
+```
+### `movieRename(movieId: string, newName: string): Promise<IMovie>`
+Renames a movie.
+**Parameters:**
+- `movieId`: The ID of the movie
+- `newName`: The new name
+**Returns:** Promise resolving to the updated `IMovie` object
+**Example:**
+```typescript
+await libraryApi.movieRename('movie-id', 'New Movie Name');
+```
+### `updateMoviePoster(movieId: string, poster: FormData, type: string): Promise<void>`
+Updates a movie poster image.
+**Parameters:**
+- `movieId`: The ID of the movie
+- `poster`: FormData containing the poster image
+- `type`: Poster type
+**Example:**
+```typescript
+const formData = new FormData();
+formData.append('file', posterBlob);
+await libraryApi.updateMoviePoster('movie-id', formData, 'poster');
+```
+### `updateMovieImageFetch(movieId: string, image: ExternalImage): Promise<void>`
+Fetches and sets an external image as movie poster.
+**Parameters:**
+- `movieId`: The ID of the movie
+- `image`: External image object to fetch
+**Example:**
+```typescript
+await libraryApi.updateMovieImageFetch('movie-id', externalImage);
+```
+---
+## Media
+### `getMedias(filter?: MediaRequest): Promise<IFile[]>`
+Retrieves media files with optional filtering.
+**Parameters:**
+- `filter`: Optional `MediaRequest` object for filtering/sorting
+**Returns:** Promise resolving to an array of `IFile` objects
+**Example:**
+```typescript
+// Get all media
+const allMedias = await libraryApi.getMedias();
+// Get filtered media
+const photos = await libraryApi.getMedias({
+    type: 'photo',
+    limit: 50,
+    offset: 0
+});
+```
+### `getMedia(mediaId: string, options?: { type?: 'stream' | 'arraybuffer' | 'blob' }): Promise<ReadableStream | ArrayBuffer | Blob>`
+Downloads a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `options`: Optional object with `type` property ('stream', 'arraybuffer', or 'blob')
+**Returns:** Promise resolving to the media data in the requested format
+**Example:**
+```typescript
+// Get as blob
+const blob = await libraryApi.getMedia('media-id', { type: 'blob' });
+// Get as stream
+const stream = await libraryApi.getMedia('media-id', { type: 'stream' });
+// For encrypted libraries, decrypt after getting
+if (library.crypt) {
+    const encryptedBlob = await libraryApi.getMedia('media-id', { type: 'arraybuffer' });
+    const decrypted = await libraryApi.decryptFile('passphrase', encryptedBlob);
+}
+```
+### `getThumb(mediaId: string, options?: { type?: 'stream' | 'arraybuffer' | 'blob' }): Promise<ReadableStream | ArrayBuffer | Blob>`
+Gets a media thumbnail.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `options`: Optional object with `type` property
+**Returns:** Promise resolving to the thumbnail data
+**Example:**
+```typescript
+// Get thumbnail as blob
+const thumbBlob = await libraryApi.getThumb('media-id', { type: 'blob' });
+// For encrypted libraries, decrypt thumbnail
+if (library.crypt) {
+    const media = await libraryApi.getMediaMetadata('media-id');
+    const iv = uint8ArrayFromBase64(media.iv!);
+    const encryptedThumb = await libraryApi.getThumb('media-id', { type: 'arraybuffer' });
+    const decryptedThumb = await libraryApi.decryptMedia('passphrase', encryptedThumb, iv);
+}
+```
+### `getMediaMetadata(mediaId: string): Promise<IFile>`
+Gets metadata for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+**Returns:** Promise resolving to `IFile` object with metadata
+**Example:**
+```typescript
+const metadata = await libraryApi.getMediaMetadata('media-id');
+console.log(`File: ${metadata.name}, Size: ${metadata.size}`);
+```
+### `getMediaBackupMetadatas(mediaId: string): Promise<IBackupFile[]>`
+Gets backup metadata for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+**Returns:** Promise resolving to an array of `IBackupFile` objects
+**Example:**
+```typescript
+const backups = await libraryApi.getMediaBackupMetadatas('media-id');
+```
+### `uploadMedia(data: ArrayBuffer | Uint8Array, options: UploadMediaOptions): Promise<IFile>`
+Uploads a media file to the library.
+**Parameters:**
+- `data`: File data as `ArrayBuffer` or `Uint8Array`
+- `options`: Upload options object:
+  - `thumb?`: Optional thumbnail data (`ArrayBuffer` or `Uint8Array`) - only for encrypted libraries
+  - `metadata`: Media metadata (see `MediaForUpdate` interface)
+  - `fileMime`: MIME type of the file (e.g., 'image/jpeg')
+  - `thumbMime?`: Optional MIME type of thumbnail (default: 'image/jpeg')
+  - `progressCallback?`: Optional callback for upload progress `(loaded: number, total: number) => void`
+**Returns:** Promise resolving to the created `IFile` object
+**Throws:** Error if encryption key not set for encrypted libraries, or if thumbnail provided for non-encrypted libraries
+**Example:**
+```typescript
+// Upload to non-encrypted library
+const fileData = await file.arrayBuffer();
+const uploaded = await libraryApi.uploadMedia(fileData, {
+    metadata: {
+        name: 'photo.jpg',
+        description: 'My photo'
+    },
+    fileMime: 'image/jpeg',
+    progressCallback: (loaded, total) => {
+        console.log(`Upload: ${(loaded / total * 100).toFixed(1)}%`);
+    }
+});
+// Upload to encrypted library
+if (library.crypt) {
+    await libraryApi.setKey('passphrase');
+    const fileData = await file.arrayBuffer();
+    const thumbData = await thumbnail.arrayBuffer();
+    const uploaded = await libraryApi.uploadMedia(fileData, {
+        thumb: thumbData,
+        metadata: {
+            name: 'photo.jpg'
+        },
+        fileMime: 'image/jpeg',
+        thumbMime: 'image/jpeg'
+    });
+    // uploaded.iv contains the IV for decryption
+}
+```
+### `removeMedias(mediaIds: string[]): Promise<void>`
+Deletes multiple media files.
+**Parameters:**
+- `mediaIds`: Array of media IDs to delete
+**Example:**
+```typescript
+await libraryApi.removeMedias(['media-1', 'media-2', 'media-3']);
+```
+### `mediaTransfer(formData: FormData): Promise<void>`
+Transfers media using FormData (legacy method).
+**Parameters:**
+- `formData`: FormData containing transfer information
+**Example:**
+```typescript
+const formData = new FormData();
+formData.append('ids', JSON.stringify(['media-1', 'media-2']));
+formData.append('toLibrary', 'target-library-id');
+await libraryApi.mediaTransfer(formData);
+```
+### `mediaTransferMany(medias: string[], deleteOriginal: boolean, toLibraryId: string): Promise<void>`
+Transfers multiple media files to another library.
+**Parameters:**
+- `medias`: Array of media IDs to transfer
+- `deleteOriginal`: Whether to delete originals after transfer
+- `toLibraryId`: Target library ID
+**Example:**
+```typescript
+await libraryApi.mediaTransferMany(
+    ['media-1', 'media-2'],
+    false, // Keep originals
+    'target-library-id'
+);
+```
+### `mediaTransferSingle(mediaId: string, toLibraryId: string, formData: FormData, params?: Map<string, string>): Promise<void>`
+Transfers a single media file to another library.
+**Parameters:**
+- `mediaId`: The ID of the media to transfer
+- `toLibraryId`: Target library ID
+- `formData`: FormData with additional transfer data
+- `params`: Optional query parameters
+**Example:**
+```typescript
+const formData = new FormData();
+formData.append('option', 'value');
+await libraryApi.mediaTransferSingle('media-id', 'target-library-id', formData);
+```
+### `addTagToMedia(mediaId: string, tagId: string): Promise<void>`
+Adds a tag to a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `tagId`: The ID of the tag to add
+**Example:**
+```typescript
+await libraryApi.addTagToMedia('media-id', 'tag-id');
+```
+### `removeTagFromMedia(mediaId: string, tagId: string): Promise<void>`
+Removes a tag from a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `tagId`: The ID of the tag to remove
+**Example:**
+```typescript
+await libraryApi.removeTagFromMedia('media-id', 'tag-id');
+```
+### `mediaUpdate(mediaId: string, update: any): Promise<IFile[]>`
+Updates a media file's metadata.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `update`: Update object (see `MediaForUpdate` interface)
+**Returns:** Promise resolving to an array of updated `IFile` objects
+**Example:**
+```typescript
+await libraryApi.mediaUpdate('media-id', {
+    description: 'New description',
+    rating: 5
+});
+```
+### `mediaUpdateMany(update: any, ids: string[]): Promise<IFile[]>`
+Updates multiple media files.
+**Parameters:**
+- `update`: Update object
+- `ids`: Array of media IDs to update
+**Returns:** Promise resolving to an array of updated `IFile` objects
+**Example:**
+```typescript
+await libraryApi.mediaUpdateMany(
+    { rating: 5 },
+    ['media-1', 'media-2', 'media-3']
+);
+```
+### `mediaUpdateProgress(mediaId: string, progress: number): Promise<{ progress: number }>`
+Updates the watch progress for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `progress`: Progress value (0-100 or time-based)
+**Returns:** Promise resolving to object with updated progress
+**Example:**
+```typescript
+await libraryApi.mediaUpdateProgress('media-id', 50);
+```
+### `mediaUpdateChannel(mediaId: string, update: any): Promise<IFile[]>`
+Updates channel information for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `update`: Channel update object
+**Returns:** Promise resolving to an array of updated `IFile` objects
+**Example:**
+```typescript
+await libraryApi.mediaUpdateChannel('media-id', { channel: 'new-channel' });
+```
+### `refreshMedia(mediaId: string): Promise<IFile[]>`
+Refreshes metadata for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+**Returns:** Promise resolving to an array of updated `IFile` objects
+**Example:**
+```typescript
+await libraryApi.refreshMedia('media-id');
+```
+### `aiTagMedia(mediaId: string): Promise<IFile[]>`
+Triggers AI tagging for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+**Returns:** Promise resolving to an array of updated `IFile` objects with new tags
+**Example:**
+```typescript
+await libraryApi.aiTagMedia('media-id');
+```
+### `splitZip(mediaId: string, from: number, to: number): Promise<IFile>`
+Splits a ZIP archive into a new archive containing pages from `from` to `to`.
+**Parameters:**
+- `mediaId`: The ID of the ZIP media
+- `from`: Starting page number
+- `to`: Ending page number
+**Returns:** Promise resolving to the new `IFile` object
+**Example:**
+```typescript
+const newZip = await libraryApi.splitZip('zip-id', 1, 10);
+```
+### `deleteFromZip(mediaId: string, pages: number[]): Promise<IFile>`
+Deletes pages from a ZIP archive.
+**Parameters:**
+- `mediaId`: The ID of the ZIP media
+- `pages`: Array of page numbers to delete
+**Returns:** Promise resolving to the updated `IFile` object
+**Example:**
+```typescript
+await libraryApi.deleteFromZip('zip-id', [5, 6, 7]);
+```
+### `updateMediaThumb(mediaId: string, thumb: FormData): Promise<void>`
+Updates the thumbnail for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `thumb`: FormData containing the thumbnail image
+**Example:**
+```typescript
+const formData = new FormData();
+formData.append('file', thumbBlob);
+await libraryApi.updateMediaThumb('media-id', formData);
+```
+### `getMediaShares(mediaId: string): Promise<any>`
+Gets sharing information for a media file.
+**Parameters:**
+- `mediaId`: The ID of the media
+**Returns:** Promise resolving to sharing information
+**Example:**
+```typescript
+const shares = await libraryApi.getMediaShares('media-id');
+```
+### `shareMediaToProvider(mediaId: string, provider: string, formData?: FormData): Promise<any>`
+Shares a media file to an external provider.
+**Parameters:**
+- `mediaId`: The ID of the media
+- `provider`: Provider name (e.g., 'instagram', 'twitter')
+- `formData`: Optional FormData with additional sharing data
+**Returns:** Promise resolving to sharing result
+**Example:**
+```typescript
+const result = await libraryApi.shareMediaToProvider('media-id', 'instagram');
+```
+---
+## Faces
+### `getUnassignedFaces(params?: Map<string, string>): Promise<any>`
+Gets unassigned faces (faces not yet linked to a person).
+**Parameters:**
+- `params`: Optional query parameters
+**Returns:** Promise resolving to unassigned faces data
+**Example:**
+```typescript
+const params = new Map([['limit', '50']]);
+const faces = await libraryApi.getUnassignedFaces(params);
+```
+### `getClusters(): Promise<any>`
+Gets face clusters (groups of similar faces).
+**Returns:** Promise resolving to clusters data
+**Example:**
+```typescript
+const clusters = await libraryApi.getClusters();
+```
+### `assignFaces(request: any): Promise<any>`
+Assigns faces to a person.
+**Parameters:**
+- `request`: Assignment request object with face IDs and person ID
+**Returns:** Promise resolving to assignment result
+**Example:**
+```typescript
+await libraryApi.assignFaces({
+    faceIds: ['face-1', 'face-2'],
+    personId: 'person-id'
+});
+```
+### `createPersonFromCluster(request: any): Promise<any>`
+Creates a new person from a face cluster.
+**Parameters:**
+- `request`: Request object with cluster ID and person name
+**Returns:** Promise resolving to created person
+**Example:**
+```typescript
+await libraryApi.createPersonFromCluster({
+    clusterId: 'cluster-id',
+    name: 'John Doe'
+});
+```
+### `splitCluster(request: any): Promise<any>`
+Splits a face cluster into multiple clusters.
+**Parameters:**
+- `request`: Split request object
+**Returns:** Promise resolving to split result
+**Example:**
+```typescript
+await libraryApi.splitCluster({
+    clusterId: 'cluster-id',
+    faceIds: ['face-1', 'face-2']
+});
+```
+### `unassignFace(request: any): Promise<any>`
+Unassigns a face from a person.
+**Parameters:**
+- `request`: Unassign request object with face ID
+**Returns:** Promise resolving to unassign result
+**Example:**
+```typescript
+await libraryApi.unassignFace({ faceId: 'face-id' });
+```
+### `deleteFace(faceId: string): Promise<any>`
+Deletes a face.
+**Parameters:**
+- `faceId`: The ID of the face to delete
+**Returns:** Promise resolving to deletion result
+**Example:**
+```typescript
+await libraryApi.deleteFace('face-id');
+```
+### `getAssignedFaces(personId: string): Promise<any>`
+Gets all faces assigned to a person.
+**Parameters:**
+- `personId`: The ID of the person
+**Returns:** Promise resolving to assigned faces
+**Example:**
+```typescript
+const faces = await libraryApi.getAssignedFaces('person-id');
+```
+### `faceClusterPerson(personId: string): Promise<void>`
+Triggers face clustering for a person.
+**Parameters:**
+- `personId`: The ID of the person
+**Example:**
+```typescript
+await libraryApi.faceClusterPerson('person-id');
+```
+### `mergePeople(request: any): Promise<any>`
+Merges multiple people into one.
+**Parameters:**
+- `request`: Merge request object with source and target person IDs
+**Returns:** Promise resolving to merge result
+**Example:**
+```typescript
+await libraryApi.mergePeople({
+    fromIds: ['person-1', 'person-2'],
+    intoId: 'person-3'
+});
+```
+### `clusterFaces(personId: string): Promise<any>`
+Clusters faces for a person.
+**Parameters:**
+- `personId`: The ID of the person
+**Returns:** Promise resolving to clustering result
+**Example:**
+```typescript
+await libraryApi.clusterFaces('person-id');
+```
+---
+## Encryption
+These methods are convenience wrappers around the encryption module. For detailed encryption documentation, see [encryption.md](encryption.md).
+### `encryptText(passPhrase: string, text: string): Promise<string>`
+Encrypts a text string using a passphrase.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `text`: The plaintext to encrypt
+**Returns:** Promise resolving to encrypted string in format `${IV}.${encryptedData}` (base64url encoded)
+**Example:**
+```typescript
+const encrypted = await libraryApi.encryptText('password', 'Hello World');
+```
+### `decryptText(passPhrase: string, encryptedText: string): Promise<string>`
+Decrypts a text string using a passphrase.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `encryptedText`: The encrypted text in format `${IV}.${encryptedData}`
+**Returns:** Promise resolving to decrypted plaintext
+**Example:**
+```typescript
+const decrypted = await libraryApi.decryptText('password', encryptedText);
+```
+### `encryptMedia(passPhrase: string, buffer: ArrayBuffer | Uint8Array, iv?: ArrayBuffer | Uint8Array): Promise<ArrayBuffer>`
+Encrypts binary media data using a passphrase.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `buffer`: The binary data to encrypt
+- `iv`: Optional IV (if not provided, a random one is generated)
+**Returns:** Promise resolving to encrypted ArrayBuffer
+**Example:**
+```typescript
+const encrypted = await libraryApi.encryptMedia('password', fileBuffer);
+```
+### `decryptMedia(passPhrase: string, buffer: ArrayBuffer | Uint8Array, iv: ArrayBuffer | Uint8Array): Promise<ArrayBuffer>`
+Decrypts binary media data using a passphrase.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `buffer`: The encrypted binary data
+- `iv`: The IV used during encryption
+**Returns:** Promise resolving to decrypted ArrayBuffer
+**Example:**
+```typescript
+const decrypted = await libraryApi.decryptMedia('password', encryptedBuffer, iv);
+```
+### `encryptFile(passPhrase: string, options: EncryptFileOptions): Promise<EncryptedFile>`
+Encrypts a complete file with thumbnail and metadata.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `options`: Encryption options (see `EncryptFileOptions` interface)
+**Returns:** Promise resolving to `EncryptedFile` object
+**Example:**
+```typescript
+const encrypted = await libraryApi.encryptFile('password', {
+    filename: 'photo.jpg',
+    buffer: fileBuffer,
+    thumb: thumbBuffer,
+    thumbMime: 'image/jpeg',
+    mime: 'image/jpeg'
+});
+```
+### `decryptFile(passPhrase: string, buffer: ArrayBuffer): Promise<ArrayBuffer>`
+Decrypts file data from an encrypted file structure.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `buffer`: The complete encrypted file structure
+**Returns:** Promise resolving to decrypted file ArrayBuffer
+**Example:**
+```typescript
+const decrypted = await libraryApi.decryptFile('password', encryptedFileBlob);
+```
+### `decryptMediaThumb(passPhrase: string, buffer: ArrayBuffer): Promise<ArrayBuffer>`
+Decrypts thumbnail from an encrypted file structure.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `buffer`: The complete encrypted file structure
+**Returns:** Promise resolving to decrypted thumbnail ArrayBuffer
+**Example:**
+```typescript
+const decryptedThumb = await libraryApi.decryptMediaThumb('password', encryptedFileBlob);
+```
+### `encryptFilename(passPhrase: string, filename: string, iv: ArrayBuffer | Uint8Array): Promise<string>`
+Encrypts a filename using a passphrase and IV.
+**Parameters:**
+- `passPhrase`: The passphrase to derive the key from
+- `filename`: The filename to encrypt
+- `iv`: The IV to use (should match the file's IV)
+**Returns:** Promise resolving to base64url encoded encrypted filename
+**Example:**
+```typescript
+const iv = libraryApi.getRandomIV();
+const encryptedFilename = await libraryApi.encryptFilename('password', 'photo.jpg', iv);
+```
+### `getRandomIV(): Uint8Array`
+Generates a random 16-byte IV (Initialization Vector).
+**Returns:** `Uint8Array` of 16 random bytes
+**Example:**
+```typescript
+const iv = libraryApi.getRandomIV();
+```
+---
+## Utilities
+### `getCryptChallenge(): Promise<string>`
+Gets a cryptographic challenge for encryption verification.
+**Returns:** Promise resolving to challenge string
+**Example:**
+```typescript
+const challenge = await libraryApi.getCryptChallenge();
+```
+### `getChannels(): Promise<any[]>`
+Gets all channels (for IPTV libraries).
+**Returns:** Promise resolving to an array of channel objects
+**Example:**
+```typescript
+const channels = await libraryApi.getChannels();
+```
+### `getWatermarks(): Promise<string[]>`
+Gets list of available watermark names.
+**Returns:** Promise resolving to an array of watermark names
+**Example:**
+```typescript
+const watermarks = await libraryApi.getWatermarks();
+```
+### `getWatermark(watermark: string, options?: { type?: 'blob' | 'arraybuffer' }): Promise<Blob | ArrayBuffer>`
+Gets a watermark image.
+**Parameters:**
+- `watermark`: Watermark name (or 'default')
+- `options`: Optional object with `type` property
+**Returns:** Promise resolving to watermark data
+**Example:**
+```typescript
+const watermark = await libraryApi.getWatermark('default', { type: 'blob' });
+```
+### `expandUrl(parsedUrl: any): Promise<string | undefined>`
+Expands a parsed URL using plugins.
+**Parameters:**
+- `parsedUrl`: Parsed URL object
+**Returns:** Promise resolving to expanded URL or undefined
+**Example:**
+```typescript
+const expanded = await libraryApi.expandUrl(parsedUrl);
+```
+### `parseUrl(url: string): Promise<any>`
+Parses a URL using plugins.
+**Parameters:**
+- `url`: URL string to parse
+**Returns:** Promise resolving to parsed URL object
+**Example:**
+```typescript
+const parsed = await libraryApi.parseUrl('https://example.com/video');
+```
+### `listVideoConvertPlugins(): Promise<any[]>`
+Lists available video conversion plugins.
+**Returns:** Promise resolving to an array of plugin objects
+**Example:**
+```typescript
+const plugins = await libraryApi.listVideoConvertPlugins();
+```
+### `clean(): Promise<string>`
+Triggers library cleanup operation.
+**Returns:** Promise resolving to cleanup result message
+**Example:**
+```typescript
+const result = await libraryApi.clean();
+```
+### `locs(): Promise<any>`
+Gets location data.
+**Returns:** Promise resolving to location data
+**Example:**
+```typescript
+const locations = await libraryApi.locs();
+```
+### `mergeMedias(request: any): Promise<IFile>`
+Merges multiple media files into one.
+**Parameters:**
+- `request`: Merge request object with media IDs
+**Returns:** Promise resolving to merged `IFile` object
+**Example:**
+```typescript
+const merged = await libraryApi.mergeMedias({
+    ids: ['media-1', 'media-2']
+});
+```
+---
+## Common Workflows
+### Uploading Media to Encrypted Library
+```typescript
+// 1. Set encryption key
+await libraryApi.setKey('my-password');
+// 2. Prepare file and thumbnail
+const fileData = await file.arrayBuffer();
+const thumbData = await thumbnail.arrayBuffer();
+// 3. Upload with progress tracking
+const uploaded = await libraryApi.uploadMedia(fileData, {
+    thumb: thumbData,
+    metadata: {
+        name: 'photo.jpg',
+        description: 'My encrypted photo'
+    },
+    fileMime: 'image/jpeg',
+    thumbMime: 'image/jpeg',
+    progressCallback: (loaded, total) => {
+        console.log(`Upload: ${(loaded / total * 100).toFixed(1)}%`);
+    }
+});
+console.log(`Uploaded with IV: ${uploaded.iv}`);
+```
+### Downloading and Decrypting Media
+```typescript
+// 1. Set encryption key
+await libraryApi.setKey('my-password');
+// 2. Get media metadata
+const metadata = await libraryApi.getMediaMetadata('media-id');
+// 3. Download encrypted file
+const encryptedBlob = await libraryApi.getMedia('media-id', { type: 'arraybuffer' });
+// 4. Decrypt file
+const decrypted = await libraryApi.decryptFile('my-password', encryptedBlob);
+// 5. Use decrypted data
+const blob = new Blob([decrypted], { type: metadata.mimetype });
+const url = URL.createObjectURL(blob);
+```
+### Tagging Media
+```typescript
+// 1. Get or create tags
+const tags = await libraryApi.getTags();
+let vacationTag = tags.find(t => t.name === 'Vacation');
+if (!vacationTag) {
+    vacationTag = await libraryApi.createTag({ name: 'Vacation' });
+}
+// 2. Add tag to media
+await libraryApi.addTagToMedia('media-id', vacationTag.id!);
+```
+### Managing People and Faces
+```typescript
+// 1. Create person
+const person = await libraryApi.createPerson({ name: 'John Doe' });
+// 2. Get unassigned faces
+const faces = await libraryApi.getUnassignedFaces();
+// 3. Assign faces to person
+await libraryApi.assignFaces({
+    faceIds: ['face-1', 'face-2'],
+    personId: person.id!
+});
+// 4. Cluster faces for better organization
+await libraryApi.faceClusterPerson(person.id!);
+```
+## Related Documentation
+- [RedseatClient Documentation](client.md) - HTTP client used by LibraryApi
+- [ServerApi Documentation](server.md) - Server-level operations
+- [Encryption Documentation](encryption.md) - Detailed encryption module documentation
+- [README](README.md) - Package overview