@aigne/afs-synology 1.11.0-beta.12

package/LICENSE.md

@@ -0,0 +1,26 @@
+# Proprietary License
+
+Copyright (c) 2024-2025 ArcBlock, Inc. All Rights Reserved.
+
+This software and associated documentation files (the "Software") are proprietary
+and confidential. Unauthorized copying, modification, distribution, or use of
+this Software, via any medium, is strictly prohibited.
+
+The Software is provided for internal use only within ArcBlock, Inc. and its
+authorized affiliates.
+
+## No License Granted
+
+No license, express or implied, is granted to any party for any purpose.
+All rights are reserved by ArcBlock, Inc.
+
+## Public Artifact Distribution
+
+Portions of this Software may be released publicly under separate open-source
+licenses (such as MIT License) through designated public repositories. Such
+public releases are governed by their respective licenses and do not affect
+the proprietary nature of this repository.
+
+## Contact
+
+For licensing inquiries, contact: legal@arcblock.io

package/dist/_virtual/_@oxc-project_runtime@0.108.0/helpers/decorate.cjs

@@ -0,0 +1,11 @@
+
+//#region \0@oxc-project+runtime@0.108.0/helpers/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+
+//#endregion
+exports.__decorate = __decorate;

package/dist/_virtual/_@oxc-project_runtime@0.108.0/helpers/decorate.mjs

@@ -0,0 +1,10 @@
+//#region \0@oxc-project+runtime@0.108.0/helpers/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+
+//#endregion
+export { __decorate };

package/dist/client.cjs

@@ -0,0 +1,252 @@
+const require_errors = require('./errors.cjs');
+const require_types = require('./types.cjs');
+let _aigne_afs = require("@aigne/afs");
+
+//#region src/client.ts
+/**
+* Synology HTTP Client
+*
+* Handles authentication, session management, and API dispatch.
+* All Synology DSM 7 APIs go through /webapi/entry.cgi with
+* api=SYNO.XXX&version=N&method=yyy parameters.
+*
+* Features:
+* - Auto-login on first request
+* - Session auto-renewal on error 105/106/107/119
+* - Thundering herd protection (mutex via promise lock)
+* - 2FA with device_id caching
+* - API version discovery via SYNO.API.Info
+*/
+/**
+* Synology HTTP Client with session management and API discovery.
+*/
+var SynologyClient = class {
+	config;
+	sid = null;
+	apiInfo = /* @__PURE__ */ new Map();
+	apiInfoLoaded = false;
+	apiInfoPromise = null;
+	reAuthPromise = null;
+	destroyed = false;
+	/** Cached container name -> ID mapping */
+	containerNameToId = /* @__PURE__ */ new Map();
+	constructor(config) {
+		this.config = config;
+	}
+	/**
+	* Make an authenticated API request.
+	* Handles auto-login and session renewal.
+	*/
+	async request(params) {
+		if (this.destroyed) throw new _aigne_afs.AFSError("Client has been destroyed", "AFS_PROVIDER_ERROR");
+		await this.ensureApiInfo();
+		await this.ensureSession();
+		return this.doRequest(params, true);
+	}
+	/**
+	* Perform the actual API request with optional re-auth retry.
+	*/
+	async doRequest(params, allowRetry) {
+		const { api, method, extra } = params;
+		const apiEntry = this.apiInfo.get(api);
+		const requestedVersion = params.version ?? (apiEntry ? apiEntry.maxVersion : 1);
+		const version = apiEntry ? Math.min(requestedVersion, apiEntry.maxVersion) : requestedVersion;
+		const body = new URLSearchParams();
+		body.set("api", api);
+		body.set("version", String(version));
+		body.set("method", method);
+		if (this.sid) body.set("_sid", this.sid);
+		if (extra) {
+			for (const [key, value] of Object.entries(extra)) if (value !== void 0 && value !== null) body.set(key, typeof value === "object" ? JSON.stringify(value) : String(value));
+		}
+		const url = `${this.config.url}${require_types.API_BASE_PATH}`;
+		let response;
+		try {
+			response = await fetch(url, {
+				method: "POST",
+				headers: { "Content-Type": "application/x-www-form-urlencoded" },
+				body: body.toString(),
+				tls: this.config.verifySsl === false ? { rejectUnauthorized: false } : void 0
+			});
+		} catch (error) {
+			throw new _aigne_afs.AFSError(`Connection failed: ${error.message}`, "AFS_PROVIDER_ERROR");
+		}
+		if (!response.ok) throw new _aigne_afs.AFSError(`HTTP error ${response.status}`, "AFS_PROVIDER_ERROR");
+		let json;
+		try {
+			json = await response.json();
+		} catch {
+			throw new _aigne_afs.AFSError("Malformed JSON response from Synology API", "AFS_PROVIDER_ERROR");
+		}
+		if (!json.success) {
+			const errorCode = json.error?.code ?? 0;
+			if (allowRetry && require_errors.SESSION_EXPIRED_CODES.has(errorCode)) {
+				await this.reAuth();
+				return this.doRequest(params, false);
+			}
+			throw require_errors.mapSynoError(errorCode, api);
+		}
+		return json.data;
+	}
+	/**
+	* Load API info from SYNO.API.Info query.
+	* Uses promise lock to prevent concurrent discovery.
+	*/
+	async ensureApiInfo() {
+		if (this.apiInfoLoaded) return;
+		if (this.apiInfoPromise) {
+			await this.apiInfoPromise;
+			return;
+		}
+		this.apiInfoPromise = this.loadApiInfo().finally(() => {
+			this.apiInfoPromise = null;
+		});
+		await this.apiInfoPromise;
+	}
+	async loadApiInfo() {
+		if (this.apiInfoLoaded) return;
+		const url = `${this.config.url}${require_types.API_BASE_PATH}`;
+		const body = new URLSearchParams();
+		body.set("api", "SYNO.API.Info");
+		body.set("version", "1");
+		body.set("method", "query");
+		body.set("query", "all");
+		let response;
+		try {
+			response = await fetch(url, {
+				method: "POST",
+				headers: { "Content-Type": "application/x-www-form-urlencoded" },
+				body: body.toString(),
+				tls: this.config.verifySsl === false ? { rejectUnauthorized: false } : void 0
+			});
+		} catch (error) {
+			throw new _aigne_afs.AFSError(`Connection failed during API discovery: ${error.message}`, "AFS_PROVIDER_ERROR");
+		}
+		if (!response.ok) throw new _aigne_afs.AFSError(`API discovery failed: HTTP ${response.status}`, "AFS_PROVIDER_ERROR");
+		let json;
+		try {
+			json = await response.json();
+		} catch {
+			throw new _aigne_afs.AFSError("Malformed JSON during API discovery", "AFS_PROVIDER_ERROR");
+		}
+		if (json.success && json.data) for (const [apiName, info] of Object.entries(json.data)) this.apiInfo.set(apiName, info);
+		this.apiInfoLoaded = true;
+	}
+	/**
+	* Ensure we have a valid session. Login if needed.
+	*/
+	async ensureSession() {
+		if (this.sid) return;
+		await this.login();
+	}
+	/**
+	* Re-authenticate (session expired). Uses promise lock for thundering herd protection.
+	* Only one re-auth fires at a time; concurrent callers await the same promise.
+	*/
+	async reAuth() {
+		if (this.reAuthPromise) {
+			await this.reAuthPromise;
+			return;
+		}
+		this.sid = null;
+		this.reAuthPromise = this.login().finally(() => {
+			this.reAuthPromise = null;
+		});
+		await this.reAuthPromise;
+	}
+	/**
+	* Login to Synology DSM.
+	* Supports 2FA with OTP code and device_id caching.
+	*/
+	async login() {
+		const url = `${this.config.url}${require_types.API_BASE_PATH}`;
+		const body = new URLSearchParams();
+		body.set("api", "SYNO.API.Auth");
+		body.set("version", "6");
+		body.set("method", "login");
+		body.set("account", this.config.account);
+		body.set("passwd", this.config.password);
+		body.set("format", "sid");
+		if (this.config.otpCode) body.set("otp_code", this.config.otpCode);
+		if (this.config.deviceId) body.set("device_id", this.config.deviceId);
+		let response;
+		try {
+			response = await fetch(url, {
+				method: "POST",
+				headers: { "Content-Type": "application/x-www-form-urlencoded" },
+				body: body.toString(),
+				tls: this.config.verifySsl === false ? { rejectUnauthorized: false } : void 0
+			});
+		} catch (error) {
+			throw new _aigne_afs.AFSError(`Login connection failed: ${error.message}`, "AFS_PROVIDER_ERROR");
+		}
+		if (!response.ok) throw new _aigne_afs.AFSError(`Login HTTP error: ${response.status}`, "AFS_PROVIDER_ERROR");
+		let json;
+		try {
+			json = await response.json();
+		} catch {
+			throw new _aigne_afs.AFSError("Malformed JSON during login", "AFS_PROVIDER_ERROR");
+		}
+		if (!json.success) throw require_errors.mapSynoError(json.error?.code ?? 0, "login");
+		if (!json.data?.sid) throw new _aigne_afs.AFSError("Login succeeded but no session ID returned", "AFS_PROVIDER_ERROR");
+		this.sid = json.data.sid;
+		if (json.data.device_id) this.config.deviceId = json.data.device_id;
+	}
+	/**
+	* Logout and invalidate session.
+	*/
+	async logout() {
+		if (!this.sid) return;
+		try {
+			const url = `${this.config.url}${require_types.API_BASE_PATH}`;
+			const body = new URLSearchParams();
+			body.set("api", "SYNO.API.Auth");
+			body.set("version", "6");
+			body.set("method", "logout");
+			body.set("_sid", this.sid);
+			await fetch(url, {
+				method: "POST",
+				headers: { "Content-Type": "application/x-www-form-urlencoded" },
+				body: body.toString(),
+				tls: this.config.verifySsl === false ? { rejectUnauthorized: false } : void 0
+			});
+		} catch {} finally {
+			this.sid = null;
+		}
+	}
+	/**
+	* Mark client as destroyed. Idempotent.
+	*/
+	async destroy() {
+		if (this.destroyed) return;
+		this.destroyed = true;
+		await this.logout();
+	}
+	/** Check if API is available */
+	isApiAvailable(apiName) {
+		return this.apiInfo.has(apiName);
+	}
+	/** Get the currently cached device ID */
+	getDeviceId() {
+		return this.config.deviceId;
+	}
+	/** Set device ID (for loading from persistent storage) */
+	setDeviceId(deviceId) {
+		this.config.deviceId = deviceId;
+	}
+	/** Invalidate cached data to force refresh */
+	invalidateCache() {
+		this.containerNameToId.clear();
+	}
+	/** Get container name-to-ID mapping */
+	getContainerNameToId() {
+		return this.containerNameToId;
+	}
+	/** Update container name-to-ID mapping */
+	setContainerNameToId(mapping) {
+		this.containerNameToId = mapping;
+	}
+};
+
+//#endregion
+exports.SynologyClient = SynologyClient;

package/dist/client.d.cts

@@ -0,0 +1,96 @@
+//#region src/client.d.ts
+/**
+ * Synology HTTP Client
+ *
+ * Handles authentication, session management, and API dispatch.
+ * All Synology DSM 7 APIs go through /webapi/entry.cgi with
+ * api=SYNO.XXX&version=N&method=yyy parameters.
+ *
+ * Features:
+ * - Auto-login on first request
+ * - Session auto-renewal on error 105/106/107/119
+ * - Thundering herd protection (mutex via promise lock)
+ * - 2FA with device_id caching
+ * - API version discovery via SYNO.API.Info
+ */
+interface SynoClientConfig {
+  url: string;
+  account: string;
+  password: string;
+  otpCode?: string;
+  deviceId?: string;
+  verifySsl?: boolean;
+}
+interface SynoRequestParams {
+  api: string;
+  version?: number;
+  method: string;
+  extra?: Record<string, unknown>;
+}
+/**
+ * Synology HTTP Client with session management and API discovery.
+ */
+declare class SynologyClient {
+  private config;
+  private sid;
+  private apiInfo;
+  private apiInfoLoaded;
+  private apiInfoPromise;
+  private reAuthPromise;
+  private destroyed;
+  /** Cached container name -> ID mapping */
+  private containerNameToId;
+  constructor(config: SynoClientConfig);
+  /**
+   * Make an authenticated API request.
+   * Handles auto-login and session renewal.
+   */
+  request<T = unknown>(params: SynoRequestParams): Promise<T>;
+  /**
+   * Perform the actual API request with optional re-auth retry.
+   */
+  private doRequest;
+  /**
+   * Load API info from SYNO.API.Info query.
+   * Uses promise lock to prevent concurrent discovery.
+   */
+  private ensureApiInfo;
+  private loadApiInfo;
+  /**
+   * Ensure we have a valid session. Login if needed.
+   */
+  private ensureSession;
+  /**
+   * Re-authenticate (session expired). Uses promise lock for thundering herd protection.
+   * Only one re-auth fires at a time; concurrent callers await the same promise.
+   */
+  private reAuth;
+  /**
+   * Login to Synology DSM.
+   * Supports 2FA with OTP code and device_id caching.
+   */
+  private login;
+  /**
+   * Logout and invalidate session.
+   */
+  logout(): Promise<void>;
+  /**
+   * Mark client as destroyed. Idempotent.
+   */
+  destroy(): Promise<void>;
+  /** Check if API is available */
+  isApiAvailable(apiName: string): boolean;
+  /** Get the currently cached device ID */
+  getDeviceId(): string | undefined;
+  /** Set device ID (for loading from persistent storage) */
+  setDeviceId(deviceId: string): void;
+  /** Invalidate cached data to force refresh */
+  invalidateCache(): void;
+  /** Get container name-to-ID mapping */
+  getContainerNameToId(): Map<string, string>;
+  /** Update container name-to-ID mapping */
+  setContainerNameToId(mapping: Map<string, string>): void;
+}
+//#endregion
+export { SynologyClient };
+//# sourceMappingURL=client.d.cts.map

package/dist/client.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.cts","names":[],"sources":["../src/client.ts"],"mappings":";;AAmBA;;;;;;;;;;;;AASA;UATiB,gBAAA;EACf,GAAA;EACA,OAAA;EACA,QAAA;EACA,OAAA;EACA,QAAA;EACA,SAAA;AAAA;AAAA,UAGe,iBAAA;EACf,GAAA;EACA,OAAA;EACA,MAAA;EACA,KAAA,GAAQ,MAAA;AAAA;;;;cAMG,cAAA;EAAA,QACH,MAAA;EAAA,QACA,GAAA;EAAA,QACA,OAAA;EAAA,QACA,aAAA;EAAA,QACA,cAAA;EAAA,QACA,aAAA;EAAA,QACA,SAAA;EAJA;EAAA,QAMA,iBAAA;cAEI,MAAA,EAAQ,gBAAA;EALZ;;;;EAaF,OAAA,aAAA,CAAqB,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,CAAA;EARnD;;;EAAA,QA0BE,SAAA;EAlBa;;;;EAAA,QAyFb,aAAA;EAAA,QAgBA,WAAA;EAgDA;;;EAAA,QAAA,aAAA;EA0FE;;;;EAAA,QAjFF,MAAA;EAwHd;;;;EAAA,QAtGc,KAAA;EAqHU;;;EAtDlB,MAAA,CAAA,GAAU,OAAA;EA2DiC;;;EAhC3C,OAAA,CAAA,GAAW,OAAA;;EAOjB,cAAA,CAAe,OAAA;;EAKf,WAAA,CAAA;;EAKA,WAAA,CAAY,QAAA;;EAKZ,eAAA,CAAA;;EAKA,oBAAA,CAAA,GAAwB,GAAA;;EAKxB,oBAAA,CAAqB,OAAA,EAAS,GAAA;AAAA"}

package/dist/client.d.mts

@@ -0,0 +1,96 @@
+//#region src/client.d.ts
+/**
+ * Synology HTTP Client
+ *
+ * Handles authentication, session management, and API dispatch.
+ * All Synology DSM 7 APIs go through /webapi/entry.cgi with
+ * api=SYNO.XXX&version=N&method=yyy parameters.
+ *
+ * Features:
+ * - Auto-login on first request
+ * - Session auto-renewal on error 105/106/107/119
+ * - Thundering herd protection (mutex via promise lock)
+ * - 2FA with device_id caching
+ * - API version discovery via SYNO.API.Info
+ */
+interface SynoClientConfig {
+  url: string;
+  account: string;
+  password: string;
+  otpCode?: string;
+  deviceId?: string;
+  verifySsl?: boolean;
+}
+interface SynoRequestParams {
+  api: string;
+  version?: number;
+  method: string;
+  extra?: Record<string, unknown>;
+}
+/**
+ * Synology HTTP Client with session management and API discovery.
+ */
+declare class SynologyClient {
+  private config;
+  private sid;
+  private apiInfo;
+  private apiInfoLoaded;
+  private apiInfoPromise;
+  private reAuthPromise;
+  private destroyed;
+  /** Cached container name -> ID mapping */
+  private containerNameToId;
+  constructor(config: SynoClientConfig);
+  /**
+   * Make an authenticated API request.
+   * Handles auto-login and session renewal.
+   */
+  request<T = unknown>(params: SynoRequestParams): Promise<T>;
+  /**
+   * Perform the actual API request with optional re-auth retry.
+   */
+  private doRequest;
+  /**
+   * Load API info from SYNO.API.Info query.
+   * Uses promise lock to prevent concurrent discovery.
+   */
+  private ensureApiInfo;
+  private loadApiInfo;
+  /**
+   * Ensure we have a valid session. Login if needed.
+   */
+  private ensureSession;
+  /**
+   * Re-authenticate (session expired). Uses promise lock for thundering herd protection.
+   * Only one re-auth fires at a time; concurrent callers await the same promise.
+   */
+  private reAuth;
+  /**
+   * Login to Synology DSM.
+   * Supports 2FA with OTP code and device_id caching.
+   */
+  private login;
+  /**
+   * Logout and invalidate session.
+   */
+  logout(): Promise<void>;
+  /**
+   * Mark client as destroyed. Idempotent.
+   */
+  destroy(): Promise<void>;
+  /** Check if API is available */
+  isApiAvailable(apiName: string): boolean;
+  /** Get the currently cached device ID */
+  getDeviceId(): string | undefined;
+  /** Set device ID (for loading from persistent storage) */
+  setDeviceId(deviceId: string): void;
+  /** Invalidate cached data to force refresh */
+  invalidateCache(): void;
+  /** Get container name-to-ID mapping */
+  getContainerNameToId(): Map<string, string>;
+  /** Update container name-to-ID mapping */
+  setContainerNameToId(mapping: Map<string, string>): void;
+}
+//#endregion
+export { SynologyClient };
+//# sourceMappingURL=client.d.mts.map

package/dist/client.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.mts","names":[],"sources":["../src/client.ts"],"mappings":";;AAmBA;;;;;;;;;;;;AASA;UATiB,gBAAA;EACf,GAAA;EACA,OAAA;EACA,QAAA;EACA,OAAA;EACA,QAAA;EACA,SAAA;AAAA;AAAA,UAGe,iBAAA;EACf,GAAA;EACA,OAAA;EACA,MAAA;EACA,KAAA,GAAQ,MAAA;AAAA;;;;cAMG,cAAA;EAAA,QACH,MAAA;EAAA,QACA,GAAA;EAAA,QACA,OAAA;EAAA,QACA,aAAA;EAAA,QACA,cAAA;EAAA,QACA,aAAA;EAAA,QACA,SAAA;EAJA;EAAA,QAMA,iBAAA;cAEI,MAAA,EAAQ,gBAAA;EALZ;;;;EAaF,OAAA,aAAA,CAAqB,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,CAAA;EARnD;;;EAAA,QA0BE,SAAA;EAlBa;;;;EAAA,QAyFb,aAAA;EAAA,QAgBA,WAAA;EAgDA;;;EAAA,QAAA,aAAA;EA0FE;;;;EAAA,QAjFF,MAAA;EAwHd;;;;EAAA,QAtGc,KAAA;EAqHU;;;EAtDlB,MAAA,CAAA,GAAU,OAAA;EA2DiC;;;EAhC3C,OAAA,CAAA,GAAW,OAAA;;EAOjB,cAAA,CAAe,OAAA;;EAKf,WAAA,CAAA;;EAKA,WAAA,CAAY,QAAA;;EAKZ,eAAA,CAAA;;EAKA,oBAAA,CAAA,GAAwB,GAAA;;EAKxB,oBAAA,CAAqB,OAAA,EAAS,GAAA;AAAA"}