mm_config 2.1.2 → 2.1.4

package/index.js

@@ -1,199 +1,351 @@
-require('mm_logs');
-
-/**
- * 配置管理器类，提供同步和异步API
- */
-class ConfigManager {
-  /**
-   * 构造函数
-   * @param {Object} _config 配置对象
-   * @param {String} _jsonFile 配置文件路径
-   * @param {Object} options 配置选项
-   * @param {Number} options.debounceTime 防抖时间(ms)
-   * @param {Boolean} options.pretty 是否美化输出
-   * @param {String} options.format 格式(json/json5)
-   */
-  constructor(_config, _jsonFile, options = {}) {
-    this.config = _config || {};
-    this.filePath = _jsonFile;
-    this.options = {
-      debounceTime: 0, // 默认不防抖
-      pretty: true,
-      format: 'json',
-      ...options
-    };
-    this.writeTimer = null;
-    this.writePromise = Promise.resolve();
-
-    // 如果没有提供配置且有文件路径，则从文件加载
-    if (!_config && _jsonFile) {
-      try {
-        this.config = _jsonFile.loadJson();
-      } catch(error) {
-        $.log.error(`Error loading config from ${_jsonFile}:`, error.message);
-        this.config = {};
-      }
-    }
-  }
-
-  /**
-   * 保存配置到文件（同步）
-   */
-  saveSync() {
-    if (!this.filePath) return false;
-    try {
-      this.filePath.saveJson(this.config);
-      return true;
-    } catch(error) {
-      $.log.error(`Error saving config to ${this.filePath}:`, error.message);
-      return false;
-    }
-  }
-
-  /**
-   * 保存配置到文件（异步）
-   * @returns {Promise<Boolean>}
-   */
-  async saveAsync() {
-    if (!this.filePath) return Promise.resolve(true);
-
-    // 确保之前的写操作完成
-    await this.writePromise;
-
-    this.writePromise = Promise.resolve()
-      .then(() => {
-        this.filePath.saveJson(this.config);
-        return true;
-      })
-      .catch(error => {
-        $.log.error(`Error saving config to ${this.filePath}:`, error.message);
-        return false;
-      });
-
-    return this.writePromise;
-  }
-
-  /**
-   * 获取代理对象
-   * @returns {Proxy}
-   */
-  getProxy() {
-    const self = this;
-
-    return new Proxy(this.config, {
-      set(obj, prop, value) {
-        obj[prop] = value;
-
-        if (self.options.debounceTime > 0) {
-          // 防抖处理
-          if (self.writeTimer) {
-            clearTimeout(self.writeTimer);
-          }
-          self.writeTimer = setTimeout(() => {
-            self.saveSync();
-          }, self.options.debounceTime);
-        } else {
-          // 无防抖，直接保存
-          self.saveSync();
-        }
-
-        return true;
-      },
-
-      get(obj, prop) {
-        // 提供一些特殊属性访问
-        if (prop === '_saveAsync') {
-          return () => self.saveAsync();
-        }
-        if (prop === '_saveSync') {
-          return () => self.saveSync();
-        }
-        if (prop === '_raw') {
-          return obj;
-        }
-
-        return obj[prop];
-      }
-    });
-  }
-
-  /**
-   * 获取异步代理对象
-   * @returns {Proxy}
-   */
-  getAsyncProxy() {
-    const self = this;
-
-    return new Proxy(this.config, {
-      set(obj, prop, value) {
-        obj[prop] = value;
-
-        if (self.options.debounceTime > 0) {
-          if (self.writeTimer) {
-            clearTimeout(self.writeTimer);
-          }
-          self.writeTimer = setTimeout(() => {
-            self.saveAsync();
-          }, self.options.debounceTime);
-        } else {
-          self.saveAsync();
-        }
-
-        return true;
-      },
-
-      get(obj, prop) {
-        if (prop === '_saveAsync') {
-          return () => self.saveAsync();
-        }
-        if (prop === '_saveSync') {
-          return () => self.saveSync();
-        }
-        if (prop === '_raw') {
-          return obj;
-        }
-
-        return obj[prop];
-      }
-    });
-  }
+require('mm_expand');
+
+/**
+ * 配置类
+ * @class
+ */
+class Config {
+	/**
+	 * 创建配置实例
+	 * @param {Object} options - 配置对象
+	 * @param {String} file - 配置文件路径
+	 * @param {Object} config - 配置选项
+	 * @param {Number} config.debounce_time - 防抖时间(ms)
+	 * @param {Boolean} config.pretty - 是否美化输出
+	 * @param {String} config.format - 格式(json/json5)
+	 * @throws {TypeError} 当options非对象时
+	 * @throws {TypeError} 当file非字符串时
+	 */
+	constructor(options, file, config) {
+		// 参数校验
+		if (options && typeof options !== 'object') {
+			throw new TypeError('options must be an object');
+		}
+		if (file && typeof file !== 'string') {
+			throw new TypeError('file must be a string');
+		}
+
+		this.config = {
+			debounce_time: 0, // 默认不防抖
+			pretty: true,
+			format: 'json'
+		};
+		this.options = {};
+		this._file = file;
+		this._conn = null;
+		this._timer = null;
+		this._promise = Promise.resolve();
+
+		// 如果没有提供配置且有文件路径，则从文件加载
+		if (!options && file) {
+			try {
+				this.options = file.loadJson();
+			} catch (err) {
+				$.log.error(`[options] Error loading options from ${file}:`, err.message);
+				this.options = {};
+			}
+		}
+		// 设置配置
+		this.setOptions(options);
+		// 设置配置
+		this.setConfig(config);
+	}
+}
+
+/**
+ * 设置配置
+ * @param {Object} config - 配置对象
+ */
+Config.prototype.setConfig = function (config) {
+	Object.assign(this.config, config);
 }
 
 /**
- * 创建配置管理器的工厂函数
- * @param {Object} _config 配置对象
- * @param {String} _jsonFile 配置文件路径
- * @param {Object} options 配置选项
+ * 设置配置
+ * @param {Object} options - 配置对象
+ */
+Config.prototype.setOptions = function (options) {
+	Object.assign(this.options, options);
+}
+
+/**
+ * 初始化配置（连接文件）
+ * @param {Object} conn - 已连接的文件对象
+ * @returns {Promise} 连接结果
+ */
+Config.prototype.setup = async function (conn) {
+	if (conn) this._conn = conn;
+	return this._conn;
+};
+
+/**
+ * 保存配置到文件（同步）
+ * @returns {Boolean} 保存是否成功
+ */
+Config.prototype.saveSync = function () {
+	if (!this._file) return false;
+	try {
+		this._file.saveJson(this.options);
+		return true;
+	} catch (err) {
+		$.log.error(`[options] Error saving options to ${this._file}:`, err.message);
+		return false;
+	}
+};
+
+/**
+ * 保存配置到文件（异步）
+ * @returns {Promise<Boolean>}
+ */
+Config.prototype.saveAsync = async function () {
+	if (!this._file) return Promise.resolve(true);
+
+	// 确保之前的写操作完成
+	await this._promise;
+
+	this._promise = Promise.resolve()
+		.then(() => {
+			this._file.saveJson(this.options);
+			return true;
+		})
+		.catch(err => {
+			$.log.error(`[options] Error saving options to ${this._file}:`, err.message);
+			return false;
+		});
+
+	return this._promise;
+};
+
+/**
+ * 获取代理对象
+ * @returns {Proxy}
+ */
+Config.prototype.getProxy = function () {
+	var self = this;
+
+	return new Proxy(this.options, {
+		set(obj, prop, val) {
+			obj[prop] = val;
+
+			if (self.config.debounce_time > 0) {
+				// 防抖处理
+				if (self._timer) {
+					clearTimeout(self._timer);
+				}
+				self._timer = setTimeout(() => {
+					self.saveSync();
+				}, self.config.debounce_time);
+			} else {
+				// 无防抖，直接保存
+				self.saveSync();
+			}
+
+			return true;
+		},
+
+		get(obj, prop) {
+			// 提供一些特殊属性访问
+			if (prop === '_saveAsync') {
+				return () => self.saveAsync();
+			}
+			if (prop === '_saveSync') {
+				return () => self.saveSync();
+			}
+			if (prop === '_raw') {
+				return obj;
+			}
+
+			return obj[prop];
+		}
+	});
+};
+
+/**
+ * 获取异步代理对象
  * @returns {Proxy}
  */
-function createConfig(_config, _jsonFile, options = {}) {
-  // 兼容旧的调用方式（this.filename）
-  if (!_jsonFile && this && this.filename) {
-    _jsonFile = this.filename;
-  }
+Config.prototype.getAsyncProxy = function () {
+	var self = this;
 
-  const manager = new ConfigManager(_config, _jsonFile, options);
-  return manager.getProxy(); // 默认返回同步代理
+	return new Proxy(this.options, {
+		set(obj, prop, val) {
+			obj[prop] = val;
+
+			if (self.config.debounce_time > 0) {
+				if (self._timer) {
+					clearTimeout(self._timer);
+				}
+				self._timer = setTimeout(() => {
+					self.saveAsync();
+				}, self.config.debounce_time);
+			} else {
+				self.saveAsync();
+			}
+
+			return true;
+		},
+
+		get(obj, prop) {
+			if (prop === '_saveAsync') {
+				return () => self.saveAsync();
+			}
+			if (prop === '_saveSync') {
+				return () => self.saveSync();
+			}
+			if (prop === '_raw') {
+				return obj;
+			}
+
+			return obj[prop];
+		}
+	});
+};
+
+/**
+ * 配置字典（私有）
+ * @type {Object}
+ */
+const dict = {};
+
+/**
+ * 创建配置（同步）
+ * @param {String} file - 配置文件路径
+ * @param {Object} options - 配置对象
+ * @param {Object} config - 配置选项
+ * @returns {Proxy}
+ */
+function create(file, options = {}, config = {}) {
+	let f = file.fullname();
+	// 检查是否已存在配置
+	if (dict[f]) {
+		// $.log.warn(`[options] Config for file ${f} already exists.`);
+		return dict[f].getProxy();
+	}
+	var cfg = new Config(options, f, config);
+	cfg.saveSync(); // 确保文件存在
+	// 注册配置字典
+	dict[f] = cfg;
+	return dict[f].getProxy();
 }
 
 /**
- * 创建异步配置管理器的工厂函数
- * @param {Object} _config 配置对象
- * @param {String} _jsonFile 配置文件路径
- * @param {Object} options 配置选项
+ * 创建配置（异步）
+ * @param {String} file - 配置文件路径
+ * @param {Object} options - 配置对象
+ * @param {Object} config - 配置选项
  * @returns {Promise<Proxy>}
  */
-async function createConfigAsync(_config, _jsonFile, options = {}) {
-  // 兼容旧的调用方式（this.filename）
-  if (!_jsonFile && this && this.filename) {
-    _jsonFile = this.filename;
-  }
+async function createAsync(file, options = {}, config = {}) {
+	let f = file.fullname();
+	// 检查是否已存在配置
+	if (dict[f]) {
+		$.log.warn(`[options] Config for file ${f} already exists.`);
+		return dict[f].getAsyncProxy();
+	}
+	var cfg = new Config(options, f, config);
+	await cfg.saveAsync(); // 确保文件存在
+	// 注册配置字典
+	dict[f] = cfg;
+	return dict[f].getAsyncProxy();
+}
 
-  const manager = new ConfigManager(_config, _jsonFile, options);
-  return manager.getAsyncProxy();
+/**
+ * 清理指定文件配置缓存
+ * @param {String} file - 配置文件路径
+ */
+function clear(file) {
+	if (!file) return clearAll();
+	let f = file.fullname();
+	if (dict[f]) {
+		delete dict[f];
+	}
 }
 
-// 导出工厂函数和类
-module.exports = createConfig;
-module.exports.createConfigAsync = createConfigAsync;
-module.exports.ConfigManager = ConfigManager;
+/**
+ * 清理所有配置缓存
+ */
+function clearAll() {
+	Object.keys(dict).forEach(key => {
+		delete dict[key];
+	});
+}
+
+/**
+ * 获取配置值
+ * @param {String} key - 配置键
+ * @returns {*}
+ */
+Config.prototype.get = async function (key) {
+	var value;
+	if (this._conn) {
+		value = await this._conn.get(key);
+	}
+	if (!value) {
+		value = this.options[key];
+	}
+	return value;
+};
+
+/**
+ * 设置配置值
+ * @param {String} key - 配置键
+ * @param {*} value - 配置值
+ */
+Config.prototype.set = async function (key, value) {
+	if (this._conn) {
+		await this._conn.set(key, value);
+	}
+	else {
+		this.options[key] = value;
+	}
+};
+
+/**
+ * 检查配置是否存在
+ * @param {String} key - 配置键
+ * @returns {Boolean}
+ */
+Config.prototype.has = async function (key) {
+	var bl = false;
+	if (this._conn) {
+		bl = await this._conn.has(key);
+	};
+	if (!bl) {
+		bl = this.options.hasOwnProperty(key);
+	}
+	return bl;
+};
+
+/**
+ * 删除配置项
+ * @param {String} key - 配置键
+ */
+Config.prototype.del = async function (key) {
+	if (this._conn) {
+		await this._conn.del(key);
+	};
+	delete this.options[key];
+};
+
+/**
+ * 获取所有配置键
+ * @returns {Array<String>}
+ */
+Config.prototype.keys = async function () {
+	let keys = [];
+	if (this._conn) {
+		keys = await this._conn.keys();
+	}
+	let local_keys = Object.keys(this.options);
+	keys = keys.concat(local_keys);
+	return keys;
+};
+
+// 模块导出
+module.exports = {
+	Config,
+	create,
+	createAsync,
+	clear,
+	clearAll
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_config",
-    "version": "2.1.2",
+    "version": "2.1.4",
     "description": "这是超级美眉配置同步器,用于更改配置同步保存为JSON文件",
     "main": "index.js",
     "scripts": {
@@ -26,6 +26,6 @@
     },
     "homepage": "https://gitee.com/qiuwenwu91/mm_config#readme",
     "dependencies": {
-        "mm_logs": "^1.5.1"
+        "mm_expand": "^1.9.7"
     }
-}
+}