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

package/lib/esm/cli/apis.js

@@ -1,53 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { program } from "commander";
-import { loadConfig } from "./config";
-import { SynologyApi } from "../core";
-import { SynologyApiKeys } from "../modules";
-export const onMethodsCall = (module) => (method, options) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    const config = yield loadConfig();
-    const params = JSON.parse(options.params || "{}");
-    const pretty = options.pretty;
-    const synologyApi = new SynologyApi(config.connections[config.used]);
-    if ((_a = synologyApi[module]) === null || _a === void 0 ? void 0 : _a[method]) {
-        const result = yield ((_b = synologyApi[module]) === null || _b === void 0 ? void 0 : _b[method](params));
-        if (pretty) {
-            console.log(JSON.stringify(result, null, 2));
-        }
-        else {
-            console.log(JSON.stringify(result));
-        }
-    }
-    synologyApi.disconnect();
-    process.exit(0);
-});
-// register all modules
-const apisCmdRegisterInfo = [
-    {
-        cmd: SynologyApiKeys.FileStation,
-        alias: SynologyApiKeys.fs,
-    },
-    {
-        cmd: SynologyApiKeys.AudioStation,
-        alias: SynologyApiKeys.as,
-    },
-];
-export const apiCmdRegister = () => {
-    apisCmdRegisterInfo.forEach((info) => {
-        program
-            .command(`${info.cmd} [methods]`)
-            .alias(info.alias)
-            .option("-p,--params <params>", `${info.cmd} methods params`)
-            .option("--pretty", "Prettyprint JSON Output")
-            .description(`Synology ${info.cmd} method call`)
-            .action(onMethodsCall(info.cmd));
-    });
-};

package/lib/esm/cli/index.js

@@ -1,30 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import fse from "fs-extra";
-import path from "path";
-import { program } from "commander";
-import { configCmdRegister } from "./config";
-import { apiCmdRegister } from "./apis";
-export function loadCli() {
-    return __awaiter(this, void 0, void 0, function* () {
-        // git program info
-        const pkg = yield fse.readJSON(path.join(__dirname, "../../package.json"));
-        // command
-        program
-            .name("synology")
-            .usage("<command> [options]")
-            .description("synology api cli tool")
-            .version(pkg.version, "-v, --version", "output the version number");
-        // register commands
-        configCmdRegister();
-        apiCmdRegister();
-        program.parse(process.argv);
-    });
-}

package/lib/esm/core.js

@@ -1,111 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-// reference: https://kb.synology.com/zh-tw/DSM/tutorial/What_websites_does_Synology_NAS_connect_to_when_running_services_or_updating_software
-import ky from "ky";
-import { BaseSynologyApi } from "./modules";
-import { isHttpUrl, getApiKey, isUndfined } from "./utils";
-import { getServerInfo } from "./helpers";
-import { login, logout, getApiInfo } from "./modules/Api";
-import { resWithErrorCode } from "./errorcodes";
-export class SynologyApi extends BaseSynologyApi {
-    constructor(options) {
-        super();
-        this.isConnecting = false;
-        this.authInfo = null;
-        this.apiInfo = {};
-        this.server = options.server;
-        this.username = options.username;
-        this.password = options.password;
-        this.baseUrl = `${this.server}/webapi/`;
-    }
-    connect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // if quickconnect id
-            if (!isHttpUrl(this.server)) {
-                this.server = yield getServerInfo(this.server);
-                // reset base url
-                this.baseUrl = `${this.server}/webapi/`;
-            }
-            try {
-                const result = yield login(this);
-                this.authInfo = result.data;
-                this.isConnecting = true;
-                yield this._getApiInfo();
-                return true;
-            }
-            catch (err) {
-                console.error(err);
-                return false;
-            }
-        });
-    }
-    disconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                yield logout(this);
-                this.authInfo = null;
-                this.apiInfo = {};
-                this.isConnecting = false;
-                return true;
-            }
-            catch (err) {
-                console.error(err);
-                return false;
-            }
-        });
-    }
-    _getApiInfo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const result = yield getApiInfo(this);
-                this.apiInfo = result.data;
-            }
-            catch (err) {
-                console.error(err);
-            }
-        });
-    }
-    hasApi(apiName) {
-        if (!this.isConnecting) {
-            throw new Error("Not connected");
-        }
-        return Object.prototype.hasOwnProperty.call(this.apiInfo, apiName);
-    }
-    run(apiName, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.isConnecting) {
-                const res = yield this.connect();
-                if (!res) {
-                    throw new Error("Not connected");
-                }
-            }
-            if (!this.hasApi(apiName)) {
-                throw new Error(`${apiName} not found`);
-            }
-            const { method = "get", params, data, headers } = options;
-            const api = this.apiInfo[apiName];
-            const url = `${this.baseUrl}${api.path}`;
-            const externalParams = Object.assign({ api: apiName, version: api.maxVersion, _sid: this.authInfo.sid }, params);
-            let result = null;
-            if (method === "get") {
-                result = yield ky.get(url, { searchParams: externalParams, headers }).json();
-            }
-            if (method === "post") {
-                result = yield ky.post(url, { searchParams: externalParams, json: data, headers }).json();
-            }
-            // match error code msg
-            const apiKey = getApiKey(apiName);
-            if (!isUndfined(apiKey)) {
-                result = resWithErrorCode(apiKey, result);
-            }
-            return result;
-        });
-    }
-}

package/lib/esm/helpers.js

@@ -1,81 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import ky from "ky";
-import { GLOBAL_QUICK_CONNECT_URL, QUICK_CONNECT_PINGPANG_API } from "./constants";
-const getServersFromServerInfo = (serverInfo) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b, _c, _d, _e, _f;
-    // proxy server
-    if ((_a = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.service) === null || _a === void 0 ? void 0 : _a.relay_ip) {
-        const server = `http://${serverInfo.service.relay_ip}:${serverInfo.service.relay_port}`;
-        const res = yield pingpang(server);
-        if (res) {
-            return server;
-        }
-    }
-    // WAN IP
-    if ((_c = (_b = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.server) === null || _b === void 0 ? void 0 : _b.external) === null || _c === void 0 ? void 0 : _c.ip) {
-        const server = `http://${serverInfo.server.external.ip}:${serverInfo.service.port}`;
-        if (yield pingpang(server)) {
-            return server;
-        }
-    }
-    // lan ip
-    if ((_e = (_d = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.server) === null || _d === void 0 ? void 0 : _d.interface) === null || _e === void 0 ? void 0 : _e[0]) {
-        const server = `http://${(_f = serverInfo.server.interface) === null || _f === void 0 ? void 0 : _f[0].ip}:${serverInfo.service.port}`;
-        if (yield pingpang(server)) {
-            return server;
-        }
-    }
-});
-export const getServerInfo = (quickConnectId) => __awaiter(void 0, void 0, void 0, function* () {
-    var _a, _b;
-    const params = {
-        version: 1,
-        id: "dsm",
-        serverID: quickConnectId,
-        get_ca_fingerprints: true,
-        command: "get_server_info",
-    };
-    const serverInfo = yield ky.post(GLOBAL_QUICK_CONNECT_URL, { json: params }).json();
-    if (!((_a = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.service) === null || _a === void 0 ? void 0 : _a.relay_ip) && !((_b = serverInfo === null || serverInfo === void 0 ? void 0 : serverInfo.service) === null || _b === void 0 ? void 0 : _b.relay_port)) {
-        const relayRequestParams = {
-            version: 1,
-            id: "dsm",
-            serverID: quickConnectId,
-            platform: "web",
-            command: "request_tunnel",
-        };
-        const result = yield ky
-            .post(`https://${serverInfo.env.control_host}/Serv.php`, { json: relayRequestParams })
-            .json();
-        return getServersFromServerInfo(result);
-    }
-    else {
-        return getServersFromServerInfo(serverInfo);
-    }
-});
-// pingpang
-export const pingpang = (server) => __awaiter(void 0, void 0, void 0, function* () {
-    try {
-        const result = yield ky
-            .get(`${server}/${QUICK_CONNECT_PINGPANG_API}`)
-            .json();
-        if (result.success) {
-            return true;
-        }
-        else {
-            return false;
-        }
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    }
-    catch (_err) {
-        return false;
-    }
-});

package/lib/esm/index.js

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

package/lib/esm/modules/Api/Auth.js

@@ -1,43 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import ky from "ky";
-import { SynologyApiInfo } from "../../types";
-export function login(core) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const params = {
-            api: SynologyApiInfo.Auth,
-            version: 6,
-            method: "login",
-            account: core.username,
-            passwd: core.password,
-            format: "sid",
-        };
-        const url = `${core.baseUrl}entry.cgi`;
-        const result = yield ky.get(url, { searchParams: params }).json();
-        if (!result.success) {
-            throw new Error(result.error.message);
-        }
-        return result;
-    });
-}
-export function logout(core) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const params = {
-            api: SynologyApiInfo.Auth,
-            version: 6,
-            method: "logout",
-        };
-        const url = `${core.baseUrl}entry.cgi`;
-        const result = yield ky.get(url, { searchParams: params }).json();
-        if (!result.success) {
-            throw new Error(result.error.message);
-        }
-    });
-}

package/lib/esm/modules/Api/Info.js

@@ -1,26 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import ky from "ky";
-import { SynologyApiInfo } from "../../types";
-export function getApiInfo(core) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const params = {
-            api: SynologyApiInfo.Info,
-            version: 1,
-            method: "query",
-        };
-        const url = `${core.baseUrl}entry.cgi`;
-        const result = yield ky.get(url, { searchParams: params }).json();
-        if (!result.success) {
-            throw new Error(result.error.message);
-        }
-        return result;
-    });
-}

package/lib/esm/modules/Api/index.js

@@ -1,2 +0,0 @@
-export * from "./Auth";
-export * from "./Info";

package/lib/esm/modules/AudioStation/Song.js

@@ -1,18 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { AudioStationApi } from "../../types";
-export function getSongList(params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const res = yield this.run(AudioStationApi.Song, {
-            params: Object.assign({ method: "list", library: "all" }, params),
-        });
-        return res;
-    });
-}

package/lib/esm/modules/AudioStation/index.js

@@ -1,7 +0,0 @@
-import { getSongList } from "./Song";
-export const METHODS = {
-    getSongList,
-};
-// name space
-export const SPELLING_KEY = "AudioStation";
-export const SIMPLIFY_KEY = "as";

package/lib/esm/modules/FileStation/Info.js

@@ -1,20 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { FileStationApi } from "../../types";
-export function getInfo() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const res = yield this.run(FileStationApi.Info, {
-            params: {
-                method: "get",
-            },
-        });
-        return res;
-    });
-}

package/lib/esm/modules/FileStation/List.js

@@ -1,32 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { FileStationApi } from "../../types";
-import { isUndfined } from "../../utils";
-export function getFileList() {
-    return __awaiter(this, arguments, void 0, function* (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 = yield this.run(FileStationApi.List, {
-            params: Object.assign({ method: "list", additional: JSON.stringify(additional), filetype: filetype, folder_path: params.folder_path }, params),
-        });
-        return res;
-    });
-}
-export function getFileListShare() {
-    return __awaiter(this, arguments, void 0, function* (params = {}) {
-        const { additional = ["real_path", "size", "owner", "time"], onlywritable = false } = params;
-        const res = yield this.run(FileStationApi.List, {
-            params: Object.assign({ method: "list_share", additional: JSON.stringify(additional), onlywritable: onlywritable }, params),
-        });
-        return res;
-    });
-}

package/lib/esm/types/index.js

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

package/lib/types/modules/Api/Info.d.ts

@@ -1,3 +0,0 @@
-import { SynologyApiResponse } from "../../types";
-import { SynologyApi } from "../../core";
-export declare function getApiInfo(core: SynologyApi): Promise<SynologyApiResponse>;

package/lib/types/modules/Api/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./Auth";
-export * from "./Info";

package/lib/types/modules/AudioStation/Song.d.ts

@@ -1,22 +0,0 @@
-import { SynologyApiResponse } from "../../types";
-/**
- * fetch song list
- * */
-export type AudioStationSongListRequest = {
-    limit?: number;
-    offset?: number;
-    method?: string;
-    library?: string;
-    additional?: string;
-    version?: number;
-    sort_by?: string;
-    sort_direction?: string;
-};
-export type AudioStationSongListResponse = SynologyApiResponse<{
-    offset: number;
-    total: number;
-    songs: {
-        [key: string]: any;
-    };
-}>;
-export declare function getSongList(params: AudioStationSongListRequest): Promise<AudioStationSongListResponse>;

package/lib/types/modules/AudioStation/index.d.ts

@@ -1,7 +0,0 @@
-import { getSongList } from "./Song";
-export declare const METHODS: {
-    getSongList: typeof getSongList;
-};
-export declare const SPELLING_KEY = "AudioStation";
-export declare const SIMPLIFY_KEY = "as";
-export type TMethods = typeof METHODS;

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

@@ -1,16 +0,0 @@
-import * as AudioStation from "./AudioStation";
-import * as FileStation from "./FileStation";
-export declare const SynologyApiKeys: {
-    FileStation: string;
-    fs: string;
-    AudioStation: string;
-    as: string;
-};
-export type SynologyApiMethods = FileStation.TMethods | AudioStation.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;
-    constructor();
-}

package/lib/types/types/index.d.ts

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