@redseat/api 0.0.17 → 0.1.0

package/dist/interfaces.d.ts

@@ -13,57 +13,98 @@ export interface SerieInMedia {
     episode?: number;
     episodeTo?: number;
 }
+export declare enum FileType {
+    Directory = "Directory",
+    Photo = "Photo",
+    Video = "Video",
+    Archive = "Archive",
+    Album = "Album",
+    Other = "Other"
+}
+export interface MediaItemReference {
+    id: string;
+    conf?: number;
+}
+export interface FaceEmbedding {
+    id: string;
+    embedding?: number[];
+    mediaRef?: string;
+    bbox?: any;
+    confidence?: number;
+    pose?: [number, number, number];
+    personId?: string;
+}
+export interface BackupFile {
+    backup: string;
+    library?: string;
+    file: string;
+    id: string;
+    path: string;
+    hash: string;
+    sourcehash: string;
+    size: number;
+    modified: number;
+    added: number;
+    iv?: string;
+    thumbSize?: number;
+    infoSize?: number;
+    error?: string;
+}
 export interface IFile {
     id: string;
     name: string;
+    source?: string;
     description?: string;
-    size: number;
-    type: FileTypes;
+    type: FileType;
     mimetype: string;
-    modified: number;
-    created: number;
-    added: number;
-    starred?: any;
-    width: number;
-    height: number;
+    size?: number;
+    params?: any;
+    added?: number;
+    modified?: number;
+    created?: number;
+    rating?: number;
+    avgRating?: number;
+    md5?: string;
     phash?: string;
     thumbhash?: string;
-    acodecs?: string[];
-    achan?: number[];
-    vcodecs?: string[];
-    fps?: number;
-    bitrate?: number;
+    originalHash?: string;
+    originalId?: string;
+    width?: number;
+    height?: number;
+    focal?: number;
+    iso?: number;
     colorSpace?: string;
     icc?: string;
     mp?: number;
-    focal?: number;
-    iso?: number;
-    fNumber?: number;
     sspeed?: string;
+    fNumber?: number;
     orientation?: number;
     duration?: number;
-    progress?: number;
-    thumb?: any;
-    rating?: number;
-    tags?: {
-        id: string;
-        conf?: number;
-    }[];
-    people?: {
-        id: string;
-        conf?: number;
-    }[];
-    series?: SerieInMedia[];
-    movie?: string;
+    acodecs?: string[];
+    achan?: number[];
+    vcodecs?: string[];
+    fps?: number;
+    bitrate?: number;
     long?: number;
     lat?: number;
-    params?: any;
-    iv?: string;
+    model?: string;
     pages?: number;
+    progress?: number;
+    lang?: string;
+    tags?: MediaItemReference[];
+    series?: SerieInMedia[];
+    people?: MediaItemReference[];
+    faces?: FaceEmbedding[];
+    backups?: BackupFile[];
+    thumb?: string;
     thumbv?: number;
     thumbsize?: number;
-    model?: string;
-    originalId?: string;
+    iv?: string;
+    origin?: RsLink;
+    movie?: string;
+    uploader?: string;
+    uploadkey?: string;
+    faceRecognitionError?: string;
 }
 export declare enum LibraryTypes {
     'Photos' = "photos",
@@ -95,62 +136,84 @@ export interface ILibrary {
     status?: string;
 }
 export interface ITag {
-    id?: string;
+    id: string;
     name: string;
+    path: string;
     parent?: string;
-    path?: string;
-    count?: number;
-    starred?: boolean;
-    hidden?: boolean;
+    type?: string;
+    modified: number;
+    added: number;
+    generated: boolean;
     alt?: string[];
-    generated?: boolean;
-    waiting?: boolean;
+    thumb?: string;
+    params?: any;
 }
 export declare enum LinkType {
     'profile' = "profile",
     'post' = "post",
     'other' = "other"
 }
+export interface RsLink {
+    platform: string;
+    type?: LinkType;
+    id: string;
+    file?: string;
+    user?: string;
+    plugin?: string;
+}
+export type Gender = 'Male' | 'Female' | 'Animal' | 'Other' | 'Unknown' | {
+    Custom: string;
+};
 export interface IPerson {
-    id?: string;
+    id: string;
     name: string;
+    modified: number;
+    added: number;
+    posterv: number;
+    generated: boolean;
     alt?: string[];
-    socials?: {
-        id: string;
-        type: LinkType | undefined;
-        platform: string;
-    }[];
-    posterv?: number;
-    portrait?: boolean;
+    type?: string;
+    portrait?: string;
     birthday?: number;
-    waiting?: boolean;
-    generated?: boolean;
+    death?: number;
+    imdb?: string;
+    slug?: string;
+    tmdb?: number;
+    trakt?: number;
+    socials?: RsLink[];
+    gender?: Gender;
+    country?: string;
+    bio?: string;
+    params?: any;
 }
+export type SerieStatus = 'returning' | 'inProduction' | 'postProduction' | 'planned' | 'rumored' | 'ended' | 'released' | 'canceled' | 'pilot' | 'unknown' | {
+    other: string;
+};
 export interface ISerie {
-    id?: string;
+    id: string;
     name: string;
+    type?: string;
     alt?: string[];
-    tags?: string[];
-    people?: string[];
+    status?: SerieStatus;
+    params?: any;
     year?: number;
-    poster?: boolean;
     imdb?: string;
     slug?: string;
     tmdb?: number;
     trakt?: number;
     tvdb?: number;
     otherids?: string;
-    status?: string;
     imdbRating?: number;
     imdbVotes?: number;
-    images?: {
-        poster?: string;
-        background?: string;
-    };
-    posterv?: number;
-    backgroundv?: number;
-    cardv?: number;
-    waiting?: boolean;
+    traktRating?: number;
+    traktVotes?: number;
+    trailer?: string;
+    maxCreated?: number;
+    modified: number;
+    added: number;
+    posterv: number;
+    backgroundv: number;
+    cardv: number;
 }
 export interface IEpisode {
     id?: string;
@@ -177,10 +240,39 @@ export interface IEpisode {
         background?: string;
     };
 }
+export type MovieStatus = 'returning' | 'released' | 'inProduction' | 'postProduction' | 'planned' | 'rumored' | 'canceled' | 'unknown' | {
+    other: string;
+};
 export interface IMovie {
-    id?: string;
+    id: string;
     name: string;
+    type?: any;
     year?: number;
+    airdate?: number;
+    digitalairdate?: number;
+    duration?: number;
+    overview?: string;
+    country?: string;
+    status?: MovieStatus;
+    imdb?: string;
+    slug?: string;
+    tmdb?: number;
+    trakt?: number;
+    otherids?: string;
+    lang?: string;
+    original?: string;
+    imdbRating?: number;
+    imdbVotes?: number;
+    traktRating?: number;
+    traktVotes?: number;
+    trailer?: RsLink;
+    modified: number;
+    added: number;
+    watched?: number;
+    progress?: number;
+    posterv: number;
+    backgroundv: number;
+    cardv: number;
 }
 export interface IServer {
     id: string;

package/dist/interfaces.js

@@ -8,6 +8,15 @@ export var FileTypes;
     FileTypes["channel"] = "channel";
     FileTypes["other"] = "other";
 })(FileTypes || (FileTypes = {}));
+export var FileType;
+(function (FileType) {
+    FileType["Directory"] = "Directory";
+    FileType["Photo"] = "Photo";
+    FileType["Video"] = "Video";
+    FileType["Archive"] = "Archive";
+    FileType["Album"] = "Album";
+    FileType["Other"] = "Other";
+})(FileType || (FileType = {}));
 export var LibraryTypes;
 (function (LibraryTypes) {
     LibraryTypes["Photos"] = "photos";

package/libraries.md

@@ -360,16 +360,33 @@ await libraryApi.updatePersonPortrait('person-id', formData);
 
 ## Series
 
-### `getSeries(): Promise<ISerie[]>`
+### `getSeries(query?: { after?: number; name?: string; watched?: boolean; sort?: RsSort; order?: 'ASC' | 'DESC' }): Promise<ISerie[]>`
 
-Retrieves all series in the library, sorted by name.
+Retrieves series in the library with optional filtering.
+
+**Parameters:**
+- `query`: Optional query object with filtering parameters:
+  - `after`: Filter series modified after this timestamp (integer unix milliseconds)
+  - `name`: Filter series by name
+  - `watched`: Filter by watched status
+  - `sort`: Sort key using `RsSort` enum (`Modified`, `Added`, `Created`, `Rating`, `Name`, `Size`)
+  - `order`: Sort direction (`'ASC'` or `'DESC'`)
 
 **Returns:** Promise resolving to an array of `ISerie` objects
 
 **Example:**
 ```typescript
+// Get all series
 const series = await libraryApi.getSeries();
-```
+
+// Get series with filters and sorting
+const filteredSeries = await libraryApi.getSeries({
+    watched: false,
+    sort: RsSort.Rating,
+    order: 'DESC',
+    after: Date.now() - 86400000 // Last 24 hours
+});
+
 
 ### `createSerie(serie: Partial<ISerie>): Promise<ISerie>`
 
@@ -581,16 +598,30 @@ await libraryApi.setEpisodeWatched('serie-id', 1, 1, Date.now());
 
 ## Movies
 
-### `getMovies(): Promise<IMovie[]>`
+### `getMovies(query?: { after?: number; inDigital?: boolean; watched?: boolean; sort?: MovieSort }): Promise<IMovie[]>`
 
-Retrieves all movies in the library.
+Retrieves movies in the library with optional filtering.
+
+**Parameters:**
+- `query`: Optional query object with filtering parameters:
+  - `after`: Filter movies modified after this timestamp (integer unix milliseconds)
+  - `inDigital`: Filter by digital release availability
+  - `watched`: Filter by watched status
+  - `sort`: Sort key (`'modified'`, `'added'`, `'created'`, `'name'`, or `'digitalairdate'`)
 
 **Returns:** Promise resolving to an array of `IMovie` objects
 
 **Example:**
 ```typescript
+// Get all movies
 const movies = await libraryApi.getMovies();
-```
+
+// Get movies with filters
+const filteredMovies = await libraryApi.getMovies({
+    inDigital: true,
+    sort: 'digitalairdate',
+    after: Date.now() - 86400000 // Last 24 hours
+});
 
 ### `createMovie(movie: Partial<IMovie>): Promise<IMovie>`
 

package/package.json

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