@fett/synology-api 0.0.1-beta.8 → 0.0.1

package/lib/modules/FileStation/List.js

@@ -0,0 +1,30 @@
+import { FileStationApi } from "../../types/index.js";
+import { isUndfined } from "../../utils.js";
+export async function getFileList(params = {}) {
+    const { additional = ["real_path", "size", "owner", "time"], filetype = "all" } = params;
+    if (isUndfined(params.folder_path)) {
+        throw new Error("folder_path is required");
+    }
+    const res = await this.run(FileStationApi.List, {
+        params: {
+            method: "list",
+            additional: JSON.stringify(additional),
+            filetype: filetype,
+            folder_path: params.folder_path,
+            ...params,
+        },
+    });
+    return res;
+}
+export async function getFileListShare(params = {}) {
+    const { additional = ["real_path", "size", "owner", "time"], onlywritable = false } = params;
+    const res = await this.run(FileStationApi.List, {
+        params: {
+            method: "list_share",
+            additional: JSON.stringify(additional),
+            onlywritable: onlywritable,
+            ...params,
+        },
+    });
+    return res;
+}

package/lib/{types/modules → modules}/FileStation/index.d.ts

@@ -1,8 +1,8 @@
 /**
  * reference :https://global.download.synology.com/download/Document/Software/DeveloperGuide/Package/FileStation/All/enu/Synology_File_Station_API_Guide.pdf
  */
-import { getInfo } from "./Info";
-import { getFileList, getFileListShare } from "./List";
+import { getInfo } from "./Info.js";
+import { getFileList, getFileListShare } from "./List.js";
 export declare const METHODS: {
     getInfo: typeof getInfo;
     getFileList: typeof getFileList;

package/lib/{esm/modules → modules}/FileStation/index.js

@@ -1,8 +1,8 @@
 /**
  * reference :https://global.download.synology.com/download/Document/Software/DeveloperGuide/Package/FileStation/All/enu/Synology_File_Station_API_Guide.pdf
  */
-import { getInfo } from "./Info";
-import { getFileList, getFileListShare } from "./List";
+import { getInfo } from "./Info.js";
+import { getFileList, getFileListShare } from "./List.js";
 // fs methods
 export const METHODS = {
     getInfo,

package/lib/modules/VideoStation/File.d.ts

@@ -0,0 +1,48 @@
+import { SynologyApiResponse } from "../../types/index.js";
+export type VideoStationFileSetWatchStatusParams = {
+    id: number;
+    position: number;
+};
+export declare function setWatchStatus(params: VideoStationFileSetWatchStatusParams): Promise<SynologyApiResponse<any>>;
+export type VideoStationGetTrackInfoResponse = SynologyApiResponse<{
+    audio: Array<{
+        bitrate: number;
+        channel: number;
+        channel_layout: string;
+        codec: string;
+        codec_raw: string;
+        frequency: number;
+        id: string;
+        is_default: boolean;
+        language: string;
+        profile: string;
+        sample_rate: number;
+        streamid: number;
+        track: string;
+    }>;
+    video: Array<{
+        bitrate: number;
+        codec: string;
+        codec_raw: string;
+        codec_tag: string;
+        display_x: number;
+        display_y: number;
+        framerate: number;
+        framerate_den: number;
+        framerate_num: number;
+        id: string;
+        language: string;
+        level: number;
+        pix_fmt: string;
+        profile: string;
+        resolutionx: number;
+        resolutiony: number;
+        rotate: number;
+        sample_aspect_ratio_den: number;
+        sample_aspect_ratio_num: number;
+        track: string;
+    }>;
+}>;
+export declare function getTrackInfo(params: {
+    id: number;
+}): Promise<VideoStationGetTrackInfoResponse>;

package/lib/modules/VideoStation/File.js

@@ -0,0 +1,20 @@
+import { VideoStationApi } from "../../types/index.js";
+// 设置观看进度
+export async function setWatchStatus(params) {
+    const res = await this.run(VideoStationApi.File, {
+        params: {
+            method: "set_watchstatus",
+            ...params,
+        },
+    });
+    return res;
+}
+// 获取媒体信息
+export async function getTrackInfo(params) {
+    return await this.run(VideoStationApi.File, {
+        params: {
+            method: "get_track_info",
+            ...params,
+        },
+    });
+}

package/lib/modules/VideoStation/HomeVideo.d.ts

@@ -0,0 +1,6 @@
+import { SynologyApiResponse } from "../../types/index.js";
+export type VideoStationFileSetWatchStatusParams = {
+    id: number;
+    position: number;
+};
+export declare function getFileVideoInfo(params: VideoStationFileSetWatchStatusParams): Promise<SynologyApiResponse<any>>;

package/lib/modules/VideoStation/HomeVideo.js

@@ -0,0 +1,10 @@
+import { VideoStationApi } from "../../types/index.js";
+export async function getFileVideoInfo(params) {
+    const res = await this.run(VideoStationApi.File, {
+        params: {
+            method: "set_watchstatus",
+            ...params,
+        },
+    });
+    return res;
+}

package/lib/modules/VideoStation/Info.d.ts

@@ -0,0 +1,44 @@
+import { SynologyApiResponse } from "../../types/index.js";
+export interface AmeStatus {
+    ame_major_version: number;
+    has_aac: boolean;
+    has_hevc: boolean;
+    has_license: boolean;
+    is_aac_activated: boolean;
+    is_ame_broken: boolean;
+    is_ame_install: boolean;
+    is_ame_v2: boolean;
+    is_ame_v3: boolean;
+}
+export interface Privilege {
+    dtv: boolean;
+    offline_conversion: boolean;
+    renderer: boolean;
+    sharing: boolean;
+}
+export interface TranscodingCapability {
+    dtv_transcode: boolean;
+    fhd_hardware_transcode: boolean;
+    hardware_transcode: boolean;
+    remux: boolean;
+    software_transcode: boolean;
+    transcode: boolean;
+}
+/**
+ * get filestation info
+ */
+export type VideoStationInfoResponse = SynologyApiResponse<{
+    ame_status: AmeStatus;
+    is_dtv_enabled: boolean;
+    is_manager: boolean;
+    is_subtitle_search_enabled: boolean;
+    need_aac: boolean;
+    need_hevc: boolean;
+    privilege: Privilege;
+    timezone: string;
+    timezone_offset: number;
+    transcoding_capability: TranscodingCapability;
+    version: string;
+    version_string: string;
+}>;
+export declare function getInfo(): Promise<VideoStationInfoResponse>;

package/lib/modules/VideoStation/Info.js

@@ -0,0 +1,9 @@
+import { VideoStationApi } from "../../types/index.js";
+export async function getInfo() {
+    const res = await this.run(VideoStationApi.Info, {
+        params: {
+            method: "get",
+        },
+    });
+    return res;
+}

package/lib/modules/VideoStation/Library.d.ts

@@ -0,0 +1,70 @@
+import { SynologyApiResponse } from "../../types/index.js";
+export type VideoStationAcrossLibraryParams = {
+    policy?: string;
+    limit?: number;
+    additional?: string[];
+};
+interface File {
+    audio_bitrate: number;
+    audio_codec: string;
+    channel: number;
+    container_type: string;
+    display_x: number;
+    display_y: number;
+    duration: string;
+    ff_video_profile: number;
+    filesize: number;
+    frame_bitrate: number;
+    frame_rate_den: number;
+    frame_rate_num: number;
+    frequency: number;
+    id: number;
+    path: string;
+    position: number;
+    resolutionx: number;
+    resolutiony: number;
+    rotation: number;
+    sharepath: string;
+    video_bitrate: number;
+    video_codec: string;
+    video_level: number;
+    video_profile: number;
+    watched_ratio: number;
+}
+export type Additional = {
+    file: File[];
+    watched_ratio: number;
+};
+export type VideoStationAcrossLibraryResponse = SynologyApiResponse<{
+    movie: Array<{
+        additional: Additional;
+        certificate: string;
+        create_time: number;
+        id: number;
+        last_watched: number;
+        library_id: number;
+        mapper_id: number;
+        original_available: string;
+        rating: number;
+        sort_title: string;
+        tagline: string;
+        title: string;
+    }>;
+}>;
+export declare function getAcrossLibrary(params?: VideoStationAcrossLibraryParams): Promise<VideoStationAcrossLibraryResponse>;
+export type VideoStationLibraryParams = {
+    limit?: number;
+};
+export type VideoStationLibraryResponse = SynologyApiResponse<{
+    offset: number;
+    total: number;
+    library: Array<{
+        id: number;
+        is_public: boolean;
+        title: string;
+        type: string;
+        visible: boolean;
+    }>;
+}>;
+export declare function getLibrary(params?: VideoStationLibraryParams): Promise<VideoStationLibraryResponse>;
+export {};

package/lib/modules/VideoStation/Library.js

@@ -0,0 +1,23 @@
+import { VideoStationApi } from "../../types/index.js";
+export async function getAcrossLibrary(params = {}) {
+    const { additional = ["summary", "poster_mtime", "backdrop_mtime", "file"], policy = "top_rating", limit = 20, } = params;
+    const res = await this.run(VideoStationApi.AcrossLibrary, {
+        params: {
+            method: "list_movie",
+            additional: JSON.stringify(additional),
+            policy,
+            limit,
+            ...params,
+        },
+    });
+    return res;
+}
+export async function getLibrary(params = {}) {
+    const res = await this.run(VideoStationApi.Library, {
+        params: {
+            method: "list",
+            ...params,
+        },
+    });
+    return res;
+}

package/lib/modules/VideoStation/Movie.d.ts

@@ -0,0 +1,27 @@
+import { SynologyApiResponse } from "../../types/index.js";
+import { VideoFile } from "./types.js";
+export type VideoStationGetMoiveInfoParams = {
+    id: number[];
+    additional?: string[];
+};
+export type Additional = {
+    file: VideoFile[];
+    watched_ratio: number;
+};
+export type VideoStationAcrossLibraryResponse = SynologyApiResponse<{
+    movie: Array<{
+        additional: Additional;
+        certificate: string;
+        create_time: number;
+        id: number;
+        last_watched: number;
+        library_id: number;
+        mapper_id: number;
+        original_available: string;
+        rating: number;
+        sort_title: string;
+        tagline: string;
+        title: string;
+    }>;
+}>;
+export declare function getMoiveInfo(params: VideoStationGetMoiveInfoParams): Promise<VideoStationAcrossLibraryResponse>;

package/lib/modules/VideoStation/Movie.js

@@ -0,0 +1,13 @@
+import { VideoStationApi } from "../../types/index.js";
+export async function getMoiveInfo(params) {
+    const { additional = ["file"], id } = params;
+    const res = await this.run(VideoStationApi.Movie, {
+        params: {
+            ...params,
+            method: "getinfo",
+            id: JSON.stringify(id),
+            additional: JSON.stringify(additional),
+        },
+    });
+    return res;
+}

package/lib/modules/VideoStation/Streaming.d.ts

@@ -0,0 +1,11 @@
+import { SynologyApiResponse } from "../../types/index.js";
+export type VideoStationGetStreamUrlParams = {
+    stream_id: string;
+    tid: string;
+};
+export type VideoStationGetStreamUrlResponse = SynologyApiResponse<string>;
+export declare function getStreamUrl(params: VideoStationGetStreamUrlParams): Promise<string>;
+export declare function getStreamId(id: number): Promise<SynologyApiResponse<{
+    format: string;
+    stream_id: string;
+}>>;

package/lib/modules/VideoStation/Streaming.js

@@ -0,0 +1,24 @@
+import { buildUrlWithQuery } from "../../utils.js";
+import { VideoStationApi } from "../../types/index.js";
+export async function getStreamUrl(params) {
+    const url = `${this.baseUrl}entry.cgi/1.mp4`;
+    const query = {
+        ...params,
+        api: VideoStationApi.Streaming,
+        method: "stream",
+        format: "raw",
+        version: 2,
+        _sid: this.authInfo?.sid,
+    };
+    return buildUrlWithQuery(url, query);
+}
+// 基于视频ID获取播放流ID
+export async function getStreamId(id) {
+    return await this.run(VideoStationApi.Streaming, {
+        params: {
+            method: "open",
+            raw: JSON.stringify({}),
+            file: JSON.stringify({ id }),
+        },
+    });
+}

package/lib/modules/VideoStation/index.d.ts

@@ -0,0 +1,15 @@
+import { getInfo } from "./Info.js";
+import { getAcrossLibrary, getLibrary } from "./Library.js";
+import { getStreamUrl, getStreamId } from "./Streaming.js";
+import { getMoiveInfo } from "./Movie.js";
+export declare const METHODS: {
+    getInfo: typeof getInfo;
+    getAcrossLibrary: typeof getAcrossLibrary;
+    getLibrary: typeof getLibrary;
+    getStreamUrl: typeof getStreamUrl;
+    getMoiveInfo: typeof getMoiveInfo;
+    getStreamId: typeof getStreamId;
+};
+export declare const SPELLING_KEY = "VideoStation";
+export declare const SIMPLIFY_KEY = "vs";
+export type TMethods = typeof METHODS;

package/lib/modules/VideoStation/index.js

@@ -0,0 +1,16 @@
+import { getInfo } from "./Info.js";
+import { getAcrossLibrary, getLibrary } from "./Library.js";
+import { getStreamUrl, getStreamId } from "./Streaming.js";
+import { getMoiveInfo } from "./Movie.js";
+// fs methods
+export const METHODS = {
+    getInfo,
+    getAcrossLibrary,
+    getLibrary,
+    getStreamUrl,
+    getMoiveInfo,
+    getStreamId,
+};
+// name space
+export const SPELLING_KEY = "VideoStation";
+export const SIMPLIFY_KEY = "vs";

package/lib/modules/VideoStation/types.d.ts

@@ -0,0 +1,27 @@
+export type VideoFile = {
+    audio_bitrate: number;
+    audio_codec: string;
+    channel: number;
+    container_type: string;
+    display_x: number;
+    display_y: number;
+    duration: string;
+    ff_video_profile: number;
+    filesize: number;
+    frame_bitrate: number;
+    frame_rate_den: number;
+    frame_rate_num: number;
+    frequency: number;
+    id: number;
+    path: string;
+    position: number;
+    resolutionx: number;
+    resolutiony: number;
+    rotation: number;
+    sharepath: string;
+    video_bitrate: number;
+    video_codec: string;
+    video_level: number;
+    video_profile: number;
+    watched_ratio: number;
+};

package/lib/modules/VideoStation/types.js

@@ -0,0 +1 @@
+export {};

package/lib/modules/index.d.ts

@@ -0,0 +1,26 @@
+import * as AudioStation from "./AudioStation/index.js";
+import * as FileStation from "./FileStation/index.js";
+import * as VideoStation from "./VideoStation/index.js";
+import * as Auth from "./Auth/index.js";
+export declare const SynologyApiKeys: {
+    FileStation: string;
+    fs: string;
+    AudioStation: string;
+    as: string;
+    VideoStation: string;
+    vs: string;
+    Auth: string;
+    au: string;
+};
+export type SynologyApiMethods = FileStation.TMethods | AudioStation.TMethods | VideoStation.TMethods | Auth.TMethods;
+export declare class BaseSynologyApi {
+    [AudioStation.SPELLING_KEY]: AudioStation.TMethods;
+    [AudioStation.SIMPLIFY_KEY]: AudioStation.TMethods;
+    [FileStation.SPELLING_KEY]: FileStation.TMethods;
+    [FileStation.SIMPLIFY_KEY]: FileStation.TMethods;
+    [VideoStation.SPELLING_KEY]: VideoStation.TMethods;
+    [VideoStation.SIMPLIFY_KEY]: VideoStation.TMethods;
+    [Auth.SPELLING_KEY]: Auth.TMethods;
+    [Auth.SIMPLIFY_KEY]: Auth.TMethods;
+    constructor();
+}

package/lib/{esm/modules → modules}/index.js

@@ -1,16 +1,22 @@
-import * as AudioStation from "./AudioStation";
-import * as FileStation from "./FileStation";
+import * as AudioStation from "./AudioStation/index.js";
+import * as FileStation from "./FileStation/index.js";
+import * as VideoStation from "./VideoStation/index.js";
+import * as Auth from "./Auth/index.js";
 export const SynologyApiKeys = {
     FileStation: FileStation.SPELLING_KEY,
     fs: FileStation.SIMPLIFY_KEY,
     AudioStation: AudioStation.SPELLING_KEY,
     as: AudioStation.SIMPLIFY_KEY,
+    VideoStation: VideoStation.SPELLING_KEY,
+    vs: VideoStation.SIMPLIFY_KEY,
+    Auth: Auth.SPELLING_KEY,
+    au: Auth.SIMPLIFY_KEY,
 };
 // export type BaseSynologyApiKeyMethods = FileStation.IKeyMethods
 export class BaseSynologyApi {
+    static { AudioStation.SPELLING_KEY, AudioStation.SIMPLIFY_KEY, FileStation.SPELLING_KEY, FileStation.SIMPLIFY_KEY, VideoStation.SPELLING_KEY, VideoStation.SIMPLIFY_KEY, Auth.SPELLING_KEY, Auth.SIMPLIFY_KEY; }
     constructor() { }
 }
-AudioStation.SPELLING_KEY, AudioStation.SIMPLIFY_KEY, FileStation.SPELLING_KEY, FileStation.SIMPLIFY_KEY;
 // bind methods to BaseSynologyApi instance
 function methodsBundler(instance, methods) {
     const output = {};
@@ -43,4 +49,26 @@ Object.defineProperties(BaseSynologyApi.prototype, {
             return methodsBundler(this, AudioStation.METHODS);
         },
     },
+    // VideoStation
+    [SynologyApiKeys.VideoStation]: {
+        get() {
+            return methodsBundler(this, VideoStation.METHODS);
+        },
+    },
+    [SynologyApiKeys.vs]: {
+        get() {
+            return methodsBundler(this, VideoStation.METHODS);
+        },
+    },
+    // Auth
+    [SynologyApiKeys.Auth]: {
+        get() {
+            return methodsBundler(this, Auth.METHODS);
+        },
+    },
+    [SynologyApiKeys.au]: {
+        get() {
+            return methodsBundler(this, Auth.METHODS);
+        },
+    },
 });

package/lib/types/{types/apiInfo.d.ts → apiInfo.d.ts}

@@ -4,7 +4,8 @@
 export declare enum SynologyApiInfo {
     Auth = "SYNO.API.Auth",
     Info = "SYNO.API.Info",
-    OTP = "SYNO.API.OTP"
+    OTP = "SYNO.API.OTP",
+    AuthKey = "SYNO.API.Auth.Key"
 }
 /**
  * AudioStation
@@ -13,7 +14,7 @@ export declare enum AudioStationApi {
     Song = "SYNO.AudioStation.Song",
     Album = "SYNO.AudioStation.Album",
     Artist = "SYNO.AudioStation.Artist",
-    Genre = "SYNO.AudioStation.Genre",
+    Search = "SYNO.AudioStation.Search",
     Playlist = "SYNO.AudioStation.Playlist",
     Folder = "SYNO.AudioStation.Folder",
     Cover = "SYNO.AudioStation.Cover",
@@ -37,3 +38,15 @@ export declare enum FileStationApi {
     Thumb = "SYNO.FileStation.Thumb",
     Upload = "SYNO.FileStation.Upload"
 }
+/**
+ * VideoStation API
+ */
+export declare enum VideoStationApi {
+    Info = "SYNO.VideoStation2.Info",
+    Library = "SYNO.VideoStation2.Library",
+    AcrossLibrary = "SYNO.VideoStation2.AcrossLibrary",
+    HomeVideo = "SYNO.VideoStation2.HomeVideo",
+    File = "SYNO.VideoStation2.File",
+    Streaming = "SYNO.VideoStation2.Streaming",
+    Movie = "SYNO.VideoStation2.Movie"
+}

package/lib/{esm/types → types}/apiInfo.js

@@ -6,6 +6,7 @@ export var SynologyApiInfo;
     SynologyApiInfo["Auth"] = "SYNO.API.Auth";
     SynologyApiInfo["Info"] = "SYNO.API.Info";
     SynologyApiInfo["OTP"] = "SYNO.API.OTP";
+    SynologyApiInfo["AuthKey"] = "SYNO.API.Auth.Key";
 })(SynologyApiInfo || (SynologyApiInfo = {}));
 /**
  * AudioStation
@@ -15,7 +16,7 @@ export var AudioStationApi;
     AudioStationApi["Song"] = "SYNO.AudioStation.Song";
     AudioStationApi["Album"] = "SYNO.AudioStation.Album";
     AudioStationApi["Artist"] = "SYNO.AudioStation.Artist";
-    AudioStationApi["Genre"] = "SYNO.AudioStation.Genre";
+    AudioStationApi["Search"] = "SYNO.AudioStation.Search";
     AudioStationApi["Playlist"] = "SYNO.AudioStation.Playlist";
     AudioStationApi["Folder"] = "SYNO.AudioStation.Folder";
     AudioStationApi["Cover"] = "SYNO.AudioStation.Cover";
@@ -40,3 +41,16 @@ export var FileStationApi;
     FileStationApi["Thumb"] = "SYNO.FileStation.Thumb";
     FileStationApi["Upload"] = "SYNO.FileStation.Upload";
 })(FileStationApi || (FileStationApi = {}));
+/**
+ * VideoStation API
+ */
+export var VideoStationApi;
+(function (VideoStationApi) {
+    VideoStationApi["Info"] = "SYNO.VideoStation2.Info";
+    VideoStationApi["Library"] = "SYNO.VideoStation2.Library";
+    VideoStationApi["AcrossLibrary"] = "SYNO.VideoStation2.AcrossLibrary";
+    VideoStationApi["HomeVideo"] = "SYNO.VideoStation2.HomeVideo";
+    VideoStationApi["File"] = "SYNO.VideoStation2.File";
+    VideoStationApi["Streaming"] = "SYNO.VideoStation2.Streaming";
+    VideoStationApi["Movie"] = "SYNO.VideoStation2.Movie";
+})(VideoStationApi || (VideoStationApi = {}));

package/lib/types/index.d.ts

@@ -1,5 +1,2 @@
-import { SynologyApi } from "./core";
-export * from "./types";
-export * from "./core";
-export * from "./cli";
-export default SynologyApi;
+export * from "./request.js";
+export * from "./apiInfo.js";

package/lib/types/index.js

@@ -0,0 +1,2 @@
+export * from "./request.js";
+export * from "./apiInfo.js";

package/lib/{types/utils.d.ts → utils.d.ts}

@@ -3,3 +3,4 @@ export declare function queryObjToString(params: Record<string, any>): string;
 export declare function isHttpUrl(url: string): boolean;
 export declare function isUndfined(value: any): boolean;
 export declare function getApiKey(apiName: string): string;
+export declare function buildUrlWithQuery(url: string, query: Record<string, any>): string;

package/lib/{esm/utils.js → utils.js}

@@ -18,3 +18,6 @@ export function isUndfined(value) {
 export function getApiKey(apiName) {
     return apiName.split('.')[1];
 }
+export function buildUrlWithQuery(url, query) {
+    return `${url}?${queryObjToString(query)}`;
+}