@redseat/api 0.0.1

package/dist/library.d.ts

@@ -0,0 +1,231 @@
+import { IFile, ITag, IPerson, ISerie, IMovie, MediaRequest, IEpisode, ExternalImage, IBackupFile, ILibrary, SerieInMedia } from './interfaces';
+import { EncryptFileOptions, EncryptedFile } from './encryption';
+export interface MediaForUpdate {
+    name?: string;
+    description?: string;
+    mimetype?: string;
+    size?: number;
+    md5?: string;
+    modified?: number;
+    created?: number;
+    width?: number;
+    height?: number;
+    orientation?: number;
+    color_space?: string;
+    icc?: string;
+    mp?: number;
+    vcodecs?: string[];
+    acodecs?: string[];
+    fps?: number;
+    bitrate?: number;
+    focal?: number;
+    iso?: number;
+    model?: string;
+    sspeed?: string;
+    f_number?: number;
+    duration?: number;
+    progress?: number;
+    addTags?: {
+        id: string;
+        conf?: number;
+    }[];
+    removeTags?: string[];
+    tagsLookup?: string[];
+    addSeries?: SerieInMedia[];
+    removeSeries?: SerieInMedia[];
+    addPeople?: {
+        id: string;
+        conf?: number;
+    }[];
+    removePeople?: string[];
+    peopleLookup?: string[];
+    long?: number;
+    lat?: number;
+    gps?: string;
+    origin?: any;
+    originUrl?: string;
+    movie?: string;
+    lang?: string;
+    rating?: number;
+    thumbsize?: number;
+    iv?: string;
+    uploader?: string;
+    uploadkey?: string;
+    uploadId?: string;
+}
+export interface LibraryHttpClient {
+    get<T = unknown>(url: string, config?: any): Promise<{
+        data: T;
+    }>;
+    post<T = unknown>(url: string, data?: unknown, config?: any): Promise<{
+        data: T;
+    }>;
+    put<T = unknown>(url: string, data?: unknown, config?: any): Promise<{
+        data: T;
+    }>;
+    patch<T = unknown>(url: string, data?: unknown, config?: any): Promise<{
+        data: T;
+    }>;
+    delete<T = unknown>(url: string, config?: any): Promise<{
+        data: T;
+    }>;
+}
+export declare class LibraryApi {
+    private client;
+    private libraryId;
+    private library;
+    private key?;
+    private keyText?;
+    constructor(client: LibraryHttpClient, libraryId: string, library: ILibrary);
+    setKey(passPhrase: string): Promise<void>;
+    private getUrl;
+    getTags(): Promise<ITag[]>;
+    getPeople(): Promise<IPerson[]>;
+    getSeries(): Promise<ISerie[]>;
+    getMovies(): Promise<IMovie[]>;
+    getMedias(filter?: MediaRequest): Promise<IFile[]>;
+    createTag(tag: Partial<ITag>): Promise<ITag>;
+    removeTag(tagId: string): Promise<void>;
+    renameTag(tagId: string, newName: string): Promise<ITag>;
+    tagChangeParent(tagId: string, newParent?: string): Promise<ITag>;
+    tagMerge(fromId: string, intoId: string): Promise<ITag>;
+    tagAddAlt(tagId: string, alt: string): Promise<ITag>;
+    tagRemoveAlt(tagId: string, alt: string): Promise<ITag>;
+    mediaTransfer(formData: FormData): Promise<void>;
+    mediaTransferMany(medias: string[], deleteOriginal: boolean, toLibraryId: string): Promise<void>;
+    mediaTransferSingle(mediaId: string, toLibraryId: string, formData: FormData, params?: Map<string, string>): Promise<void>;
+    removeMedias(mediaIds: string[]): Promise<void>;
+    getMediaMetadata(mediaId: string): Promise<IFile>;
+    getMediaBackupMetadatas(mediaId: string): Promise<IBackupFile[]>;
+    clean(): Promise<string>;
+    locs(): Promise<any>;
+    createPerson(person: Partial<IPerson>): Promise<IPerson>;
+    removePerson(personId: string): Promise<void>;
+    updatePerson(personId: string, updates: Partial<IPerson>): Promise<IPerson>;
+    createSerie(serie: Partial<ISerie>): Promise<ISerie>;
+    createEpisode(episode: Partial<IEpisode>): Promise<IEpisode>;
+    serieScrap(serieId: string, date?: number): Promise<void>;
+    removeSerie(serieId: string): Promise<void>;
+    updateSerie(serieId: string, updates: Partial<ISerie>): Promise<ISerie>;
+    getSerieImages(serieId: string): Promise<ExternalImage[]>;
+    updateSeriePoster(serieId: string, poster: FormData, type: string): Promise<void>;
+    updateSerieImageFetch(serieId: string, image: ExternalImage): Promise<void>;
+    updateSeriePosterWithMediaThumb(serieId: string, mediaId: string, type: string): Promise<ISerie>;
+    createMovie(movie: Partial<IMovie>): Promise<IMovie>;
+    movieScrap(movieId: string, date?: number): Promise<void>;
+    removeMovie(movieId: string): Promise<void>;
+    updateMovie(movieId: string, updates: Partial<IMovie>): Promise<IMovie>;
+    getMovieImages(movieId: string): Promise<ExternalImage[]>;
+    setMovieWatched(movieId: string, date: number): Promise<void>;
+    searchMovies(name: string): Promise<IMovie[]>;
+    movieRename(movieId: string, newName: string): Promise<IMovie>;
+    updateMoviePoster(movieId: string, poster: FormData, type: string): Promise<void>;
+    updateMovieImageFetch(movieId: string, image: ExternalImage): Promise<void>;
+    addTagToMedia(mediaId: string, tagId: string): Promise<void>;
+    removeTagFromMedia(mediaId: string, tagId: string): Promise<void>;
+    getCryptChallenge(): Promise<string>;
+    getChannels(): Promise<any[]>;
+    personRename(personId: string, newName: string): Promise<IPerson>;
+    personUpdate(personId: string, updates: Partial<IPerson>): Promise<IPerson>;
+    personAddAlt(personId: string, alt: string): Promise<IPerson>;
+    personRemoveAlt(personId: string, alt: string): Promise<IPerson>;
+    personAddSocial(personId: string, social: any): Promise<IPerson>;
+    personRemoveSocial(personId: string, social: any): Promise<IPerson>;
+    serieRename(serieId: string, newName: string): Promise<ISerie>;
+    serieAddAlt(serieId: string, alt: string): Promise<ISerie>;
+    serieRemoveAlt(serieId: string, alt: string): Promise<ISerie>;
+    updatePersonPortrait(personId: string, portrait: FormData): Promise<void>;
+    searchSeries(name: string): Promise<ISerie[]>;
+    setEpisodeWatched(serieId: string, season: number, number: number, date: number): Promise<void>;
+    getUnassignedFaces(params?: Map<string, string>): Promise<any>;
+    getClusters(): Promise<any>;
+    assignFaces(request: any): Promise<any>;
+    createPersonFromCluster(request: any): Promise<any>;
+    splitCluster(request: any): Promise<any>;
+    unassignFace(request: any): Promise<any>;
+    deleteFace(faceId: string): Promise<any>;
+    getAssignedFaces(personId: string): Promise<any>;
+    faceClusterPerson(personId: string): Promise<void>;
+    mergePeople(request: any): Promise<any>;
+    clusterFaces(personId: string): Promise<any>;
+    getMediaPureMetadata(mediaId: string): Promise<IFile>;
+    mergeMedias(request: any): Promise<IFile>;
+    mediaUpdateMany(update: any, ids: string[]): Promise<IFile[]>;
+    mediaUpdateProgress(mediaId: string, progress: number): Promise<{
+        progress: number;
+    }>;
+    mediaUpdateChannel(mediaId: string, update: any): Promise<IFile[]>;
+    refreshMedia(mediaId: string): Promise<IFile[]>;
+    aiTagMedia(mediaId: string): Promise<IFile[]>;
+    mediaUpdate(mediaId: string, update: any): Promise<IFile[]>;
+    splitZip(mediaId: string, from: number, to: number): Promise<IFile>;
+    deleteFromZip(mediaId: string, pages: number[]): Promise<IFile>;
+    updateMediaThumb(mediaId: string, thumb: FormData): Promise<void>;
+    getMediaShares(mediaId: string): Promise<any>;
+    shareMediaToProvider(mediaId: string, provider: string, formData?: FormData): Promise<any>;
+    expandUrl(parsedUrl: any): Promise<string | undefined>;
+    parseUrl(url: string): Promise<any>;
+    listVideoConvertPlugins(): Promise<any[]>;
+    getMedia(mediaId: string, options?: {
+        type?: 'stream' | 'arraybuffer' | 'blob';
+    }): Promise<ReadableStream | ArrayBuffer | Blob>;
+    getThumb(mediaId: string, options?: {
+        type?: 'stream' | 'arraybuffer' | 'blob';
+    }): Promise<ReadableStream | ArrayBuffer | Blob>;
+    getWatermarks(): Promise<string[]>;
+    getWatermark(watermark: string, options?: {
+        type?: 'blob' | 'arraybuffer';
+    }): Promise<Blob | ArrayBuffer>;
+    /**
+     * Encrypt a text string using a passphrase
+     * Returns format: `${base64ToBase64Url(IV)}.${base64ToBase64Url(encryptedData)}`
+     */
+    encryptText(passPhrase: string, text: string): Promise<string>;
+    /**
+     * Decrypt a text string using a passphrase
+     * Expects format: `${base64ToBase64Url(IV)}.${base64ToBase64Url(encryptedData)}`
+     */
+    decryptText(passPhrase: string, encryptedText: string): Promise<string>;
+    /**
+     * Encrypt a media file buffer using a passphrase
+     */
+    encryptMedia(passPhrase: string, buffer: ArrayBuffer | Uint8Array, iv?: ArrayBuffer | Uint8Array): Promise<ArrayBuffer>;
+    /**
+     * Decrypt a media file buffer using a passphrase
+     */
+    decryptMedia(passPhrase: string, buffer: ArrayBuffer | Uint8Array, iv: ArrayBuffer | Uint8Array): Promise<ArrayBuffer>;
+    /**
+     * Encrypt a complete file with thumbnail and metadata
+     */
+    encryptFile(passPhrase: string, options: EncryptFileOptions): Promise<EncryptedFile>;
+    /**
+     * Decrypt a file buffer (extracts and decrypts file data from encrypted file structure)
+     */
+    decryptFile(passPhrase: string, buffer: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Decrypt a file thumbnail (extracts and decrypts thumbnail from encrypted file structure)
+     */
+    decryptMediaThumb(passPhrase: string, buffer: ArrayBuffer): Promise<ArrayBuffer>;
+    /**
+     * Encrypt a filename using a passphrase
+     * Returns base64url encoded encrypted filename
+     */
+    encryptFilename(passPhrase: string, filename: string, iv: ArrayBuffer | Uint8Array): Promise<string>;
+    /**
+     * Generate a random 16-byte IV (Initialization Vector)
+     */
+    getRandomIV(): Uint8Array;
+    /**
+     * Upload media file to the server
+     * @param data - The file data as ArrayBuffer or Uint8Array (clients must convert streams/buffers before calling)
+     * @param options - Upload options including thumbnail, metadata, mime types, and progress callback
+     * @returns Promise resolving to array of created IFile objects (IV will be in IFile.iv for encrypted files)
+     */
+    uploadMedia(data: ArrayBuffer | Uint8Array, options: {
+        thumb?: ArrayBuffer | Uint8Array;
+        metadata: Omit<MediaForUpdate, 'id'>;
+        fileMime: string;
+        thumbMime?: string;
+        progressCallback?: (loaded: number, total: number) => void;
+    }): Promise<IFile>;
+}