@redseat/api 0.2.6 → 0.2.8

package/libraries.md

@@ -66,6 +66,172 @@ if (library.crypt) {
 
 **Note:** This method verifies the key by attempting to decrypt a media thumbnail. If decryption fails, it throws an error.
 
+### `dispose(): void`
+
+Marks the LibraryApi as disposed. After calling dispose(), the filtered event streams will stop emitting events.
+
+**Example:**
+
+```typescript
+libraryApi.dispose();
+```
+
+---
+
+## Real-Time Events (SSE)
+
+`LibraryApi` provides library-filtered event streams that automatically filter events to only include those relevant to the library. These streams require the `RedseatClient` to be connected to SSE.
+
+### Event Streams
+
+All event streams are RxJS Observables that emit events only for this library.
+
+#### `medias$: Observable<SSEMediasEvent>`
+
+Emits when media files in this library are added, updated, or deleted.
+
+```typescript
+libraryApi.medias$.subscribe(event => {
+    for (const { action, media } of event.medias) {
+        console.log(`Media ${action}: ${media.name}`);
+    }
+});
+```
+
+#### `mediasProgress$: Observable<SSEMediasProgressEvent>`
+
+Emits media processing progress updates for this library.
+
+```typescript
+libraryApi.mediasProgress$.subscribe(event => {
+    console.log(`Media ${event.mediaId}: ${event.progress}%`);
+});
+```
+
+#### `convertProgress$: Observable<SSEConvertProgressEvent>`
+
+Emits video conversion progress updates for this library.
+
+```typescript
+libraryApi.convertProgress$.subscribe(event => {
+    console.log(`Converting ${event.mediaId}: ${event.progress}% - ${event.status}`);
+});
+```
+
+#### `episodes$: Observable<SSEEpisodesEvent>`
+
+Emits when episodes in this library are added, updated, or deleted.
+
+```typescript
+libraryApi.episodes$.subscribe(event => {
+    for (const { action, episode } of event.episodes) {
+        console.log(`Episode ${action}: ${episode.name}`);
+    }
+});
+```
+
+#### `series$: Observable<SSESeriesEvent>`
+
+Emits when series in this library are added, updated, or deleted.
+
+```typescript
+libraryApi.series$.subscribe(event => {
+    for (const { action, serie } of event.series) {
+        console.log(`Series ${action}: ${serie.name}`);
+    }
+});
+```
+
+#### `movies$: Observable<SSEMoviesEvent>`
+
+Emits when movies in this library are added, updated, or deleted.
+
+```typescript
+libraryApi.movies$.subscribe(event => {
+    for (const { action, movie } of event.movies) {
+        console.log(`Movie ${action}: ${movie.name}`);
+    }
+});
+```
+
+#### `people$: Observable<SSEPeopleEvent>`
+
+Emits when people in this library are added, updated, or deleted.
+
+```typescript
+libraryApi.people$.subscribe(event => {
+    for (const { action, person } of event.people) {
+        console.log(`Person ${action}: ${person.name}`);
+    }
+});
+```
+
+#### `tags$: Observable<SSETagsEvent>`
+
+Emits when tags in this library are added, updated, or deleted.
+
+```typescript
+libraryApi.tags$.subscribe(event => {
+    for (const { action, tag } of event.tags) {
+        console.log(`Tag ${action}: ${tag.name}`);
+    }
+});
+```
+
+#### `libraryStatus$: Observable<SSELibraryStatusEvent>`
+
+Emits status updates for this library (e.g., scanning progress).
+
+```typescript
+libraryApi.libraryStatus$.subscribe(event => {
+    console.log(`Status: ${event.message} (${event.progress}%)`);
+});
+```
+
+### Complete SSE Example with LibraryApi
+
+```typescript
+import { RedseatClient, LibraryApi, ServerApi } from '@redseat/api';
+import { Subscription } from 'rxjs';
+
+const client = new RedseatClient({
+    server: { id: 'server-123', url: 'example.com' },
+    getIdToken: async () => await getFirebaseToken()
+});
+
+// Connect to SSE first
+await client.connectSSE();
+
+// Get library and create LibraryApi
+const serverApi = new ServerApi(client);
+const libraries = await serverApi.getLibraries();
+const library = libraries[0];
+const libraryApi = new LibraryApi(client, library.id!, library);
+
+// Track subscriptions
+const subscriptions: Subscription[] = [];
+
+// Subscribe to library-specific events
+subscriptions.push(
+    libraryApi.medias$.subscribe(event => {
+        for (const { action, media } of event.medias) {
+            console.log(`[${library.name}] Media ${action}: ${media.name}`);
+        }
+    })
+);
+
+subscriptions.push(
+    libraryApi.libraryStatus$.subscribe(event => {
+        console.log(`[${library.name}] ${event.message}`);
+    })
+);
+
+// ... later, cleanup
+subscriptions.forEach(sub => sub.unsubscribe());
+libraryApi.dispose();
+client.disconnectSSE();
+```
+
 ---
 
 ## Tags
@@ -1064,6 +1230,90 @@ if (library.crypt) {
 }
 ```
 
+### `uploadGroup(download: RsGroupDownload, options?: { spawn?: boolean }): Promise<IFile[] | { downloading: boolean }>`
+
+Uploads a group of media files from URLs.
+
+**Parameters:**
+
+- `download`: The group download request containing:
+  - `group`: Boolean indicating if files should be grouped
+  - `groupThumbnailUrl?`: Optional thumbnail URL for the group
+  - `groupFilename?`: Optional filename for the group
+  - `groupMime?`: Optional MIME type for the group
+  - `requests`: Array of `RsRequest` objects, each containing:
+    - `url`: The URL to download from
+    - `status`: `RsRequestStatus` (e.g., `NeedParsing`, `Unprocessed`)
+    - `permanent`: Boolean for permanent storage
+    - `method`: `RsRequestMethod` (e.g., `Get`, `Post`)
+    - `ignoreOriginDuplicate`: Boolean to ignore duplicate origins
+    - Optional fields: `headers`, `cookies`, `referer`, `filename`, `mime`, `thumbnailUrl`, `tagsLookup`, `peopleLookup`, `albumsLookup`, etc.
+- `options`: Optional settings object:
+  - `spawn?`: If true, runs download in background and returns `{ downloading: true }`
+
+**Returns:** Promise resolving to an array of `IFile` objects when `spawn=false`, or `{ downloading: boolean }` when `spawn=true`
+
+**Example:**
+
+```typescript
+import { RsRequestStatus, RsRequestMethod } from '@redseat/api';
+
+// Download a single URL
+const files = await libraryApi.uploadGroup({
+	group: false,
+	requests: [
+		{
+			url: 'https://example.com/video.mp4',
+			status: RsRequestStatus.Unprocessed,
+			permanent: false,
+			method: RsRequestMethod.Get,
+			ignoreOriginDuplicate: false
+		}
+	]
+});
+
+// Download multiple URLs as a group with parsing
+const groupedFiles = await libraryApi.uploadGroup({
+	group: true,
+	groupFilename: 'my-collection',
+	requests: [
+		{
+			url: 'https://example.com/video1.mp4',
+			status: RsRequestStatus.NeedParsing,
+			permanent: false,
+			method: RsRequestMethod.Get,
+			ignoreOriginDuplicate: false,
+			tagsLookup: ['vacation', 'beach']
+		},
+		{
+			url: 'https://example.com/video2.mp4',
+			status: RsRequestStatus.NeedParsing,
+			permanent: false,
+			method: RsRequestMethod.Get,
+			ignoreOriginDuplicate: false
+		}
+	]
+});
+
+// Run download in background
+const result = await libraryApi.uploadGroup(
+	{
+		group: false,
+		requests: [
+			{
+				url: 'https://example.com/large-video.mp4',
+				status: RsRequestStatus.Unprocessed,
+				permanent: false,
+				method: RsRequestMethod.Get,
+				ignoreOriginDuplicate: false
+			}
+		]
+	},
+	{ spawn: true }
+);
+// result = { downloading: true }
+```
+
 ### `removeMedias(mediaIds: string[]): Promise<void>`
 
 Deletes multiple media files.

package/package.json

@@ -1,50 +1,50 @@
-{
-    "name": "@redseat/api",
-    "version": "0.2.6",
-    "description": "TypeScript API client library for interacting with Redseat servers",
-    "type": "module",
-    "main": "./dist/index.js",
-    "module": "./dist/index.js",
-    "types": "./dist/index.d.ts",
-    "exports": {
-        ".": {
-            "import": "./dist/index.js",
-            "types": "./dist/index.d.ts"
-        }
-    },
-    "files": [
-        "dist/**/*",
-        "README.md",
-        "*.md"
-    ],
-    "keywords": [
-        "redseat",
-        "api",
-        "client",
-        "typescript"
-    ],
-    "author": "Arnaud JEZEQUEL <arnaud.jezequel@gmail.com>",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/yourusername/redseat-svelte.git",
-        "directory": "packages/api"
-    },
-    "scripts": {
-        "build": "tsc",
-        "test": "vitest run",
-        "test:watch": "vitest"
-    },
-    "dependencies": {
-        "axios": "^1.11.0",
-        "rxjs": "^7.8.2"
-    },
-    "devDependencies": {
-        "typescript": "^5.8.3",
-        "vite": "^7.3.0",
-        "vitest": "^4.0.16"
-    },
-    "publishConfig": {
-        "access": "public"
-    }
+{
+    "name": "@redseat/api",
+    "version": "0.2.8",
+    "description": "TypeScript API client library for interacting with Redseat servers",
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "files": [
+        "dist/**/*",
+        "README.md",
+        "*.md"
+    ],
+    "keywords": [
+        "redseat",
+        "api",
+        "client",
+        "typescript"
+    ],
+    "author": "Arnaud JEZEQUEL <arnaud.jezequel@gmail.com>",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/yourusername/redseat-svelte.git",
+        "directory": "packages/api"
+    },
+    "scripts": {
+        "build": "tsc",
+        "test": "vitest run",
+        "test:watch": "vitest"
+    },
+    "dependencies": {
+        "axios": "^1.11.0",
+        "rxjs": "^7.8.2"
+    },
+    "devDependencies": {
+        "typescript": "^5.8.3",
+        "vite": "^7.3.0",
+        "vitest": "^4.0.16"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
 }