@redseat/api 0.2.5 → 0.2.7

package/libraries.md

@@ -1064,6 +1064,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.5",
-    "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.7",
+    "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"
+    }
 }

package/server.md

@@ -1,196 +1,196 @@
-# ServerApi
-
-The `ServerApi` class provides server-level operations for managing libraries, settings, plugins, and credentials.
-
-## Overview
-
-`ServerApi` handles operations that are not specific to a single library, such as:
-- Listing and creating libraries
-- Getting current user information
-- Managing server settings
-- Listing plugins and credentials
-- Adding credentials to libraries
-
-## Constructor
-
-```typescript
-new ServerApi(client: RedseatClient)
-```
-
-**Parameters:**
-- `client`: An initialized `RedseatClient` instance
-
-**Example:**
-```typescript
-import { RedseatClient, ServerApi } from '@redseat/api';
-
-const client = new RedseatClient({ /* ... */ });
-const serverApi = new ServerApi(client);
-```
-
-## Methods
-
-### `getLibraries(): Promise<ILibrary[]>`
-
-Retrieves all libraries available to the current user.
-
-**Returns:** Promise resolving to an array of `ILibrary` objects
-
-**Example:**
-```typescript
-const libraries = await serverApi.getLibraries();
-libraries.forEach(library => {
-    console.log(`Library: ${library.name} (${library.type})`);
-});
-```
-
-### `getMe(): Promise<any>`
-
-Gets information about the current authenticated user.
-
-**Returns:** Promise resolving to user information object
-
-**Example:**
-```typescript
-const user = await serverApi.getMe();
-console.log(`Logged in as: ${user.name}`);
-```
-
-### `addLibrary(library: Partial<ILibrary>): Promise<ILibrary>`
-
-Creates a new library.
-
-**Parameters:**
-- `library`: Partial library object with required fields:
-  - `name`: Library name (required)
-  - `type`: Library type - `'photos'`, `'shows'`, `'movies'`, or `'iptv'` (required)
-  - `source`: Optional source type
-  - `crypt`: Optional boolean to enable encryption
-  - `hidden`: Optional boolean to hide library
-
-**Returns:** Promise resolving to the created `ILibrary` object with generated `id`
-
-**Example:**
-```typescript
-const newLibrary = await serverApi.addLibrary({
-    name: 'My Photos',
-    type: 'photos',
-    crypt: true // Enable encryption
-});
-console.log(`Created library with ID: ${newLibrary.id}`);
-```
-
-### `getSetting(key: string): Promise<string>`
-
-Retrieves a server setting value by key.
-
-**Parameters:**
-- `key`: The setting key to retrieve
-
-**Returns:** Promise resolving to the setting value as a string
-
-**Example:**
-```typescript
-const maxUploadSize = await serverApi.getSetting('max_upload_size');
-console.log(`Max upload size: ${maxUploadSize}`);
-```
-
-### `getPlugins(): Promise<any[]>`
-
-Retrieves all available plugins on the server.
-
-**Returns:** Promise resolving to an array of plugin objects
-
-**Example:**
-```typescript
-const plugins = await serverApi.getPlugins();
-plugins.forEach(plugin => {
-    console.log(`Plugin: ${plugin.name} - ${plugin.description}`);
-});
-```
-
-### `getCredentials(): Promise<any[]>`
-
-Retrieves all available credentials configured on the server.
-
-**Returns:** Promise resolving to an array of credential objects
-
-**Example:**
-```typescript
-const credentials = await serverApi.getCredentials();
-credentials.forEach(cred => {
-    console.log(`Credential: ${cred.name} (${cred.type})`);
-});
-```
-
-### `addLibraryCredential(credential: any): Promise<ILibrary>`
-
-Adds a credential to a library. This is used to configure external service access for libraries.
-
-**Parameters:**
-- `credential`: Credential configuration object (structure depends on credential type)
-
-**Returns:** Promise resolving to the updated `ILibrary` object
-
-**Example:**
-```typescript
-const library = await serverApi.addLibraryCredential({
-    libraryId: 'library-123',
-    credentialId: 'credential-456',
-    // Additional credential-specific configuration
-});
-```
-
-## Usage Examples
-
-### Complete Workflow: Create Library and Get Info
-
-```typescript
-import { RedseatClient, ServerApi } from '@redseat/api';
-
-// Initialize
-const client = new RedseatClient({ /* ... */ });
-const serverApi = new ServerApi(client);
-
-// Get current user
-const user = await serverApi.getMe();
-console.log(`User: ${user.name}`);
-
-// List existing libraries
-const libraries = await serverApi.getLibraries();
-console.log(`Found ${libraries.length} libraries`);
-
-// Create a new encrypted photo library
-const newLibrary = await serverApi.addLibrary({
-    name: 'Encrypted Photos',
-    type: 'photos',
-    crypt: true
-});
-
-// Get server settings
-const maxUpload = await serverApi.getSetting('max_upload_size');
-console.log(`Max upload size: ${maxUpload}`);
-```
-
-### Error Handling
-
-```typescript
-try {
-    const libraries = await serverApi.getLibraries();
-} catch (error) {
-    if (error.response?.status === 401) {
-        console.error('Authentication failed');
-    } else if (error.response?.status === 403) {
-        console.error('Insufficient permissions');
-    } else {
-        console.error('Failed to get libraries:', error.message);
-    }
-}
-```
-
-## Related Documentation
-
-- [RedseatClient Documentation](client.md) - HTTP client used by ServerApi
-- [LibraryApi Documentation](libraries.md) - Library-specific operations
-- [README](README.md) - Package overview
-
+# ServerApi
+
+The `ServerApi` class provides server-level operations for managing libraries, settings, plugins, and credentials.
+
+## Overview
+
+`ServerApi` handles operations that are not specific to a single library, such as:
+- Listing and creating libraries
+- Getting current user information
+- Managing server settings
+- Listing plugins and credentials
+- Adding credentials to libraries
+
+## Constructor
+
+```typescript
+new ServerApi(client: RedseatClient)
+```
+
+**Parameters:**
+- `client`: An initialized `RedseatClient` instance
+
+**Example:**
+```typescript
+import { RedseatClient, ServerApi } from '@redseat/api';
+
+const client = new RedseatClient({ /* ... */ });
+const serverApi = new ServerApi(client);
+```
+
+## Methods
+
+### `getLibraries(): Promise<ILibrary[]>`
+
+Retrieves all libraries available to the current user.
+
+**Returns:** Promise resolving to an array of `ILibrary` objects
+
+**Example:**
+```typescript
+const libraries = await serverApi.getLibraries();
+libraries.forEach(library => {
+    console.log(`Library: ${library.name} (${library.type})`);
+});
+```
+
+### `getMe(): Promise<any>`
+
+Gets information about the current authenticated user.
+
+**Returns:** Promise resolving to user information object
+
+**Example:**
+```typescript
+const user = await serverApi.getMe();
+console.log(`Logged in as: ${user.name}`);
+```
+
+### `addLibrary(library: Partial<ILibrary>): Promise<ILibrary>`
+
+Creates a new library.
+
+**Parameters:**
+- `library`: Partial library object with required fields:
+  - `name`: Library name (required)
+  - `type`: Library type - `'photos'`, `'shows'`, `'movies'`, or `'iptv'` (required)
+  - `source`: Optional source type
+  - `crypt`: Optional boolean to enable encryption
+  - `hidden`: Optional boolean to hide library
+
+**Returns:** Promise resolving to the created `ILibrary` object with generated `id`
+
+**Example:**
+```typescript
+const newLibrary = await serverApi.addLibrary({
+    name: 'My Photos',
+    type: 'photos',
+    crypt: true // Enable encryption
+});
+console.log(`Created library with ID: ${newLibrary.id}`);
+```
+
+### `getSetting(key: string): Promise<string>`
+
+Retrieves a server setting value by key.
+
+**Parameters:**
+- `key`: The setting key to retrieve
+
+**Returns:** Promise resolving to the setting value as a string
+
+**Example:**
+```typescript
+const maxUploadSize = await serverApi.getSetting('max_upload_size');
+console.log(`Max upload size: ${maxUploadSize}`);
+```
+
+### `getPlugins(): Promise<any[]>`
+
+Retrieves all available plugins on the server.
+
+**Returns:** Promise resolving to an array of plugin objects
+
+**Example:**
+```typescript
+const plugins = await serverApi.getPlugins();
+plugins.forEach(plugin => {
+    console.log(`Plugin: ${plugin.name} - ${plugin.description}`);
+});
+```
+
+### `getCredentials(): Promise<any[]>`
+
+Retrieves all available credentials configured on the server.
+
+**Returns:** Promise resolving to an array of credential objects
+
+**Example:**
+```typescript
+const credentials = await serverApi.getCredentials();
+credentials.forEach(cred => {
+    console.log(`Credential: ${cred.name} (${cred.type})`);
+});
+```
+
+### `addLibraryCredential(credential: any): Promise<ILibrary>`
+
+Adds a credential to a library. This is used to configure external service access for libraries.
+
+**Parameters:**
+- `credential`: Credential configuration object (structure depends on credential type)
+
+**Returns:** Promise resolving to the updated `ILibrary` object
+
+**Example:**
+```typescript
+const library = await serverApi.addLibraryCredential({
+    libraryId: 'library-123',
+    credentialId: 'credential-456',
+    // Additional credential-specific configuration
+});
+```
+
+## Usage Examples
+
+### Complete Workflow: Create Library and Get Info
+
+```typescript
+import { RedseatClient, ServerApi } from '@redseat/api';
+
+// Initialize
+const client = new RedseatClient({ /* ... */ });
+const serverApi = new ServerApi(client);
+
+// Get current user
+const user = await serverApi.getMe();
+console.log(`User: ${user.name}`);
+
+// List existing libraries
+const libraries = await serverApi.getLibraries();
+console.log(`Found ${libraries.length} libraries`);
+
+// Create a new encrypted photo library
+const newLibrary = await serverApi.addLibrary({
+    name: 'Encrypted Photos',
+    type: 'photos',
+    crypt: true
+});
+
+// Get server settings
+const maxUpload = await serverApi.getSetting('max_upload_size');
+console.log(`Max upload size: ${maxUpload}`);
+```
+
+### Error Handling
+
+```typescript
+try {
+    const libraries = await serverApi.getLibraries();
+} catch (error) {
+    if (error.response?.status === 401) {
+        console.error('Authentication failed');
+    } else if (error.response?.status === 403) {
+        console.error('Insufficient permissions');
+    } else {
+        console.error('Failed to get libraries:', error.message);
+    }
+}
+```
+
+## Related Documentation
+
+- [RedseatClient Documentation](client.md) - HTTP client used by ServerApi
+- [LibraryApi Documentation](libraries.md) - Library-specific operations
+- [README](README.md) - Package overview
+