@redseat/api 0.0.15 → 0.0.17

package/dist/interfaces.d.ts

@@ -324,6 +324,15 @@ export declare enum SqlOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
+export declare enum RsSort {
+    Modified = "modified",
+    Added = "added",
+    Created = "created",
+    Rating = "rating",
+    Name = "name",
+    Size = "size"
+}
+export type MovieSort = 'modified' | 'added' | 'created' | 'name' | 'digitalairdate';
 export interface DeletedQuery {
     after?: number;
     kind?: ElementType;

package/dist/interfaces.js

@@ -53,3 +53,12 @@ export var SqlOrder;
     SqlOrder["ASC"] = "ASC";
     SqlOrder["DESC"] = "DESC";
 })(SqlOrder || (SqlOrder = {}));
+export var RsSort;
+(function (RsSort) {
+    RsSort["Modified"] = "modified";
+    RsSort["Added"] = "added";
+    RsSort["Created"] = "created";
+    RsSort["Rating"] = "rating";
+    RsSort["Name"] = "name";
+    RsSort["Size"] = "size";
+})(RsSort || (RsSort = {}));

package/dist/library.d.ts

@@ -1,4 +1,4 @@
-import { IFile, ITag, IPerson, ISerie, IMovie, MediaRequest, IEpisode, ExternalImage, IBackupFile, ILibrary, SerieInMedia, DeletedQuery, RsDeleted } from './interfaces.js';
+import { IFile, ITag, IPerson, ISerie, IMovie, MediaRequest, IEpisode, ExternalImage, IBackupFile, ILibrary, SerieInMedia, DeletedQuery, RsDeleted, MovieSort, RsSort, SqlOrder } from './interfaces.js';
 import { EncryptFileOptions, EncryptedFile } from './encryption.js';
 export interface MediaForUpdate {
     name?: string;
@@ -82,10 +82,29 @@ export declare class LibraryApi {
     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[]>;
+    getTags(query?: {
+        name?: string;
+        parent?: string;
+        path?: string;
+        after?: number;
+    }): Promise<ITag[]>;
+    getPeople(query?: {
+        name?: string;
+        after?: number;
+    }): Promise<IPerson[]>;
+    getSeries(query?: {
+        after?: number;
+        name?: string;
+        watched?: boolean;
+        sort?: RsSort;
+        order?: SqlOrder;
+    }): Promise<ISerie[]>;
+    getMovies(query?: {
+        after?: number;
+        inDigital?: boolean;
+        watched?: boolean;
+        sort?: MovieSort;
+    }): Promise<IMovie[]>;
     getMedias(filter?: MediaRequest): Promise<IFile[]>;
     countMedias(filter?: MediaRequest): Promise<{
         count: number;

package/dist/library.js

@@ -63,22 +63,78 @@ export class LibraryApi {
     getUrl(path) {
         return `/libraries/${this.libraryId}${path}`;
     }
-    async getTags() {
-        const res = await this.client.get(this.getUrl('/tags'));
+    async getTags(query) {
+        const params = {};
+        if (query) {
+            if (query.name !== undefined) {
+                params.name = query.name;
+            }
+            if (query.parent !== undefined) {
+                params.parent = query.parent;
+            }
+            if (query.path !== undefined) {
+                params.path = query.path;
+            }
+            if (query.after !== undefined) {
+                params.after = query.after;
+            }
+        }
+        const res = await this.client.get(this.getUrl('/tags'), { params });
         return res.data;
     }
-    async getPeople() {
-        const res = await this.client.get(this.getUrl('/people'));
+    async getPeople(query) {
+        const params = {};
+        if (query) {
+            if (query.name !== undefined) {
+                params.name = query.name;
+            }
+            if (query.after !== undefined) {
+                params.after = query.after;
+            }
+        }
+        const res = await this.client.get(this.getUrl('/people'), { params });
         return res.data;
     }
-    async getSeries() {
-        const res = await this.client.get(this.getUrl('/series'), {
-            params: { sort: 'name', order: 'ASC' }
-        });
+    async getSeries(query) {
+        const params = {};
+        if (query) {
+            if (query.after !== undefined) {
+                params.after = query.after;
+            }
+            if (query.name !== undefined) {
+                params.name = query.name;
+            }
+            if (query.watched !== undefined) {
+                params.watched = query.watched;
+            }
+            if (query.sort !== undefined) {
+                params.sort = query.sort;
+            }
+            if (query.order !== undefined) {
+                params.order = query.order;
+            }
+        }
+        // Defaults { sort: 'name', order: 'ASC' } have been removed
+        const res = await this.client.get(this.getUrl('/series'), { params });
         return res.data;
     }
-    async getMovies() {
-        const res = await this.client.get(this.getUrl('/movies'));
+    async getMovies(query) {
+        const params = {};
+        if (query) {
+            if (query.after !== undefined) {
+                params.after = query.after;
+            }
+            if (query.inDigital !== undefined) {
+                params.inDigital = query.inDigital;
+            }
+            if (query.watched !== undefined) {
+                params.watched = query.watched;
+            }
+            if (query.sort !== undefined) {
+                params.sort = query.sort;
+            }
+        }
+        const res = await this.client.get(this.getUrl('/movies'), { params });
         return res.data;
     }
     async getMedias(filter) {

package/libraries.md

@@ -63,16 +63,30 @@ if (library.crypt) {
 
 ## Tags
 
-### `getTags(): Promise<ITag[]>`
+### `getTags(query?: { name?: string; parent?: string; path?: string; after?: number }): Promise<ITag[]>`
 
-Retrieves all tags in the library.
+Retrieves tags in the library with optional filtering.
+
+**Parameters:**
+- `query`: Optional query object with filtering parameters:
+  - `name`: Filter tags by name
+  - `parent`: Filter tags by parent tag ID
+  - `path`: Filter tags by path
+  - `after`: Filter tags modified after this timestamp (integer unix milliseconds)
 
 **Returns:** Promise resolving to an array of `ITag` objects
 
 **Example:**
 ```typescript
+// Get all tags
 const tags = await libraryApi.getTags();
 tags.forEach(tag => console.log(tag.name));
+
+// Get tags with filters
+const filteredTags = await libraryApi.getTags({
+    name: 'Vacation',
+    after: Date.now() - 86400000 // Last 24 hours
+});
 ```
 
 ### `createTag(tag: Partial<ITag>): Promise<ITag>`
@@ -184,15 +198,27 @@ await libraryApi.tagRemoveAlt('tag-id', 'alternative-name');
 
 ## People
 
-### `getPeople(): Promise<IPerson[]>`
+### `getPeople(query?: { name?: string; after?: number }): Promise<IPerson[]>`
 
-Retrieves all people in the library.
+Retrieves people in the library with optional filtering.
+
+**Parameters:**
+- `query`: Optional query object with filtering parameters:
+  - `name`: Filter people by name
+  - `after`: Filter people modified after this timestamp (integer unix milliseconds)
 
 **Returns:** Promise resolving to an array of `IPerson` objects
 
 **Example:**
 ```typescript
+// Get all people
 const people = await libraryApi.getPeople();
+
+// Get people with filters
+const filteredPeople = await libraryApi.getPeople({
+    name: 'John',
+    after: Date.now() - 86400000 // Last 24 hours
+});
 ```
 
 ### `createPerson(person: Partial<IPerson>): Promise<IPerson>`

package/package.json

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