@redseat/api 0.1.8 → 0.1.10

package/dist/library.d.ts

@@ -79,7 +79,9 @@ export declare class LibraryApi {
     private library;
     private key?;
     private keyText?;
-    constructor(client: LibraryHttpClient, libraryId: string, library: ILibrary);
+    private baseUrl?;
+    constructor(client: LibraryHttpClient, libraryId: string, library: ILibrary, baseUrl?: string);
+    setBaseUrl(baseUrl: string): void;
     setKey(passPhrase: string): Promise<void>;
     private getUrl;
     getTags(query?: {
@@ -176,7 +178,61 @@ export declare class LibraryApi {
     updatePersonPortrait(personId: string, portrait: FormData): Promise<void>;
     searchSeries(name: string): Promise<ISerie[]>;
     setEpisodeWatched(serieId: string, season: number, number: number, date: number): Promise<void>;
+    /**
+     * Searches for available media sources for a specific episode.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @returns Array of available media requests that can be used to download/stream the episode
+     */
     searchEpisodeMedias(serieId: string, season: number, episode: number): Promise<RsRequest[]>;
+    /**
+     * Adds a searched episode media to the database for download/storage.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @param request - The media request to add (typically from searchEpisodeMedias results)
+     * @returns The created media file entry
+     */
+    addSearchedEpisodeMedia(serieId: string, season: number, episode: number, request: RsRequest): Promise<IFile>;
+    /**
+     * Checks if a request can be made permanent (saved for later use).
+     * Tests the availability of the URL and returns a permanent version if valid.
+     * @param request - The request to check for permanence
+     * @returns The request with `permanent: true` if the URL is valid and can be saved
+     * @throws Error if the URL is not available or cannot be made permanent
+     */
+    checkRequestPermanent(request: RsRequest): Promise<RsRequest>;
+    /**
+     * Get a share token for a request URL.
+     * The token can be used to stream/download the resource without authentication.
+     * @param url - The request URL to get a share token for
+     * @returns A temporary share token valid for 6 hours
+     */
+    getRequestShareToken(url: string): Promise<string>;
+    /**
+     * Get a share token for a media file.
+     * The token can be used to access the media without authentication.
+     * @param mediaId - The media ID to get a share token for
+     * @returns A temporary share token valid for 6 hours
+     */
+    getMediaShareToken(mediaId: string): Promise<string>;
+    /**
+     * Get a shareable URL for streaming a request.
+     * Fetches a share token and returns a complete URL that can be used without authentication.
+     * @param url - The request URL to create a share link for
+     * @returns A complete URL with sharetoken that can be used to stream the content
+     * @throws Error if baseUrl is not set
+     */
+    getRequestShareUrl(url: string): Promise<string>;
+    /**
+     * Get a shareable URL for a media file.
+     * Fetches a share token and returns a complete URL that can be used without authentication.
+     * @param mediaId - The media ID to create a share link for
+     * @returns A complete URL with sharetoken that can be used to access the media
+     * @throws Error if baseUrl is not set
+     */
+    getMediaShareUrl(mediaId: string): Promise<string>;
     getUnassignedFaces(params?: Map<string, string>): Promise<any>;
     getClusters(): Promise<any>;
     assignFaces(request: any): Promise<any>;

package/dist/library.js

@@ -1,10 +1,14 @@
 import { deriveKey, encryptText as encryptTextUtil, decryptText as decryptTextUtil, encryptBuffer, decryptBuffer, encryptFile as encryptFileUtil, decryptFile as decryptFileUtil, decryptFileThumb, encryptFilename as encryptFilenameUtil, getRandomIV as getRandomIVUtil } from './encryption.js';
 import { uint8ArrayFromBase64 } from './crypto.js';
 export class LibraryApi {
-    constructor(client, libraryId, library) {
+    constructor(client, libraryId, library, baseUrl) {
         this.client = client;
         this.libraryId = libraryId;
         this.library = library;
+        this.baseUrl = baseUrl;
+    }
+    setBaseUrl(baseUrl) {
+        this.baseUrl = baseUrl;
     }
     async setKey(passPhrase) {
         // Derive keys
@@ -425,10 +429,92 @@ export class LibraryApi {
     async setEpisodeWatched(serieId, season, number, date) {
         await this.client.post(this.getUrl(`/series/${serieId}/seasons/${season}/episodes/${number}/watched`), { date });
     }
+    /**
+     * Searches for available media sources for a specific episode.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @returns Array of available media requests that can be used to download/stream the episode
+     */
     async searchEpisodeMedias(serieId, season, episode) {
         const res = await this.client.get(this.getUrl(`/series/${serieId}/seasons/${season}/episodes/${episode}/search`));
         return res.data;
     }
+    /**
+     * Adds a searched episode media to the database for download/storage.
+     * @param serieId - The series identifier
+     * @param season - The season number
+     * @param episode - The episode number
+     * @param request - The media request to add (typically from searchEpisodeMedias results)
+     * @returns The created media file entry
+     */
+    async addSearchedEpisodeMedia(serieId, season, episode, request) {
+        const res = await this.client.post(this.getUrl(`/series/${serieId}/seasons/${season}/episodes/${episode}/search`), request);
+        return res.data;
+    }
+    /**
+     * Checks if a request can be made permanent (saved for later use).
+     * Tests the availability of the URL and returns a permanent version if valid.
+     * @param request - The request to check for permanence
+     * @returns The request with `permanent: true` if the URL is valid and can be saved
+     * @throws Error if the URL is not available or cannot be made permanent
+     */
+    async checkRequestPermanent(request) {
+        const res = await this.client.post(this.getUrl('/plugins/requests/permanent'), request);
+        return res.data;
+    }
+    /**
+     * Get a share token for a request URL.
+     * The token can be used to stream/download the resource without authentication.
+     * @param url - The request URL to get a share token for
+     * @returns A temporary share token valid for 6 hours
+     */
+    async getRequestShareToken(url) {
+        const res = await this.client.get(this.getUrl('/plugins/requests/url/sharetoken'), {
+            params: { url }
+        });
+        return res.data;
+    }
+    /**
+     * Get a share token for a media file.
+     * The token can be used to access the media without authentication.
+     * @param mediaId - The media ID to get a share token for
+     * @returns A temporary share token valid for 6 hours
+     */
+    async getMediaShareToken(mediaId) {
+        const res = await this.client.get(this.getUrl(`/medias/${mediaId}/sharetoken`));
+        return res.data;
+    }
+    /**
+     * Get a shareable URL for streaming a request.
+     * Fetches a share token and returns a complete URL that can be used without authentication.
+     * @param url - The request URL to create a share link for
+     * @returns A complete URL with sharetoken that can be used to stream the content
+     * @throws Error if baseUrl is not set
+     */
+    async getRequestShareUrl(url) {
+        if (!this.baseUrl) {
+            throw new Error('baseUrl must be set to generate share URLs. Call setBaseUrl() first.');
+        }
+        const shareToken = await this.getRequestShareToken(url);
+        const params = new URLSearchParams({ sharetoken: shareToken, url });
+        return `${this.baseUrl}${this.getUrl('/plugins/requests/url/stream')}?${params.toString()}`;
+    }
+    /**
+     * Get a shareable URL for a media file.
+     * Fetches a share token and returns a complete URL that can be used without authentication.
+     * @param mediaId - The media ID to create a share link for
+     * @returns A complete URL with sharetoken that can be used to access the media
+     * @throws Error if baseUrl is not set
+     */
+    async getMediaShareUrl(mediaId) {
+        if (!this.baseUrl) {
+            throw new Error('baseUrl must be set to generate share URLs. Call setBaseUrl() first.');
+        }
+        const shareToken = await this.getMediaShareToken(mediaId);
+        const params = new URLSearchParams({ sharetoken: shareToken });
+        return `${this.baseUrl}${this.getUrl(`/medias/${mediaId}`)}?${params.toString()}`;
+    }
     async getUnassignedFaces(params) {
         const queryParams = {};
         if (params) {

package/package.json

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