mm_state_store 1.0.3 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,7 +18,7 @@ State 继承自 mm_cache 的 Cache,键为对象标识(如用户 ID、设备
18
18
  - 支持过期时间(TTL)与剩余时间查询
19
19
  - 写入与读取均为引用,不做深拷贝,可直接存放连接句柄等不可克隆对象
20
20
  - 支持保存到 JSON 文件,按作用域分文件存储
21
- - 基于 mm_corejs 的 Admin 管理器,按作用域缓存实例、彼此隔离
21
+ - 基于 mm_admin 的 Admin 管理器,按作用域缓存实例、彼此隔离
22
22
 
23
23
  ## 安装
24
24
 
@@ -300,7 +300,7 @@ await state.dispose();
300
300
 
301
301
  ## 依赖
302
302
 
303
- - mm_corejs:提供 Admin 管理器
303
+ - mm_admin:提供 Admin 管理器
304
304
  - mm_cache:提供 Cache 缓存基类(内存、文件持久化、过期时间)
305
305
 
306
306
  ## 测试
package/index.js CHANGED
@@ -1,7 +1,7 @@
1
- const Admin = require('mm_corejs').Admin;
1
+ const { reg } = require('mm_admin');
2
2
  const State = require('./lib/state.js');
3
3
 
4
- const admin = new Admin();
4
+ const admin = reg('state_store');
5
5
  admin.setClass(State);
6
6
 
7
7
  module.exports = {
@@ -14,9 +14,10 @@ module.exports = {
14
14
  * @returns {State} 状态存储实例
15
15
  */
16
16
  stateAdmin(scope, config) {
17
- if (!scope) {
18
- scope = 'os';
19
- }
20
- return admin.get(scope, { ...(config || {}), scope });
17
+ return admin.get(scope, { ...(config || {}), scope });
21
18
  }
22
19
  };
20
+
21
+ /* mm-tool-logic-export 工具能力层:其它模块可 require("<pkg>").tools.<name> 直接引用 */
22
+ Object.defineProperty(module.exports, 'tools', { enumerable: true, configurable: true,
23
+ get: function () { return require('./lib/tools'); } });
@@ -0,0 +1,16 @@
1
+ 'use strict';
2
+ const fs = require('fs');
3
+ const path = require('path');
4
+ /** 模块能力层:懒加载工具实现,避免模块入口被 require 时加载全部实现 */
5
+ module.exports = new Proxy({}, {
6
+ get(_t, key) {
7
+ if (typeof key !== 'string') return undefined;
8
+ if (!fs.existsSync(path.join(__dirname, key, 'index.js'))) return undefined;
9
+ return require('./' + key);
10
+ },
11
+ has(_t, key) {
12
+ return typeof key === 'string' && fs.existsSync(path.join(__dirname, key, 'index.js'));
13
+ },
14
+ ownKeys() { return fs.readdirSync(__dirname, { withFileTypes: true }).filter(e => e.isDirectory()).map(e => e.name); },
15
+ getOwnPropertyDescriptor(_t, key) { return this.has(_t, key) ? { enumerable: true, configurable: true } : undefined; }
16
+ });
@@ -0,0 +1,82 @@
1
+ /**
2
+ * 状态存储管理器
3
+ * 基于 stateAdmin 作用域单例存取带过期时间的状态对象
4
+ * @param {object} params 步骤参数
5
+ * @param {object} ctx 上下文对象
6
+ * @returns {object} 操作结果
7
+ */
8
+ const { stateAdmin } = require('../../../index.js');
9
+
10
+ async function main(params, ctx, options) {
11
+ void options;
12
+ var action = params.action || 'get';
13
+
14
+ try {
15
+ var state = stateAdmin(params.scope || 'os');
16
+
17
+ switch (action) {
18
+ case 'set': {
19
+ _assertKey(params.key);
20
+ await state.set(params.key, params.value, params.expires_in || 0);
21
+ ctx.output = { key: params.key, msg: '设置成功' };
22
+ break;
23
+ }
24
+
25
+ case 'get': {
26
+ _assertKey(params.key);
27
+ var value = await state.get(params.key);
28
+ ctx.output = { key: params.key, value: value, exists: value !== null && value !== undefined };
29
+ break;
30
+ }
31
+
32
+ case 'del': {
33
+ _assertKey(params.key);
34
+ var count = await state.del(params.key);
35
+ ctx.output = { key: params.key, msg: count > 0 ? '删除成功' : '键不存在或已过期' };
36
+ break;
37
+ }
38
+
39
+ case 'has': {
40
+ _assertKey(params.key);
41
+ ctx.output = { key: params.key, exists: await state.has(params.key) };
42
+ break;
43
+ }
44
+
45
+ case 'ttl': {
46
+ _assertKey(params.key);
47
+ ctx.output = { key: params.key, ttl: await state.ttl(params.key) };
48
+ break;
49
+ }
50
+
51
+ case 'keys': {
52
+ var keys = await state.keys(params.pattern || '*');
53
+ ctx.output = { keys: keys, count: keys.length };
54
+ break;
55
+ }
56
+
57
+ default:
58
+ ctx.output = {
59
+ error: { code: 'MGR_UNKNOWN_ACTION', message: '不支持的操作: ' + action }
60
+ };
61
+ }
62
+ } catch (e) {
63
+ ctx.output = {
64
+ error: { code: 'STATE_ERROR', message: e.message }
65
+ };
66
+ }
67
+
68
+ return ctx.output;
69
+ }
70
+
71
+ /**
72
+ * 校验键名
73
+ * @param {string} key 键名
74
+ * @returns {void}
75
+ */
76
+ function _assertKey(key) {
77
+ if (typeof key !== 'string' || key.length === 0) {
78
+ throw new TypeError('缺少 key 键名参数');
79
+ }
80
+ }
81
+
82
+ module.exports = { main };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mm_state_store",
3
- "version": "1.0.3",
3
+ "version": "1.1.0",
4
4
  "description": "状态存储模块:以对象标识为键缓存状态对象,支持过期时间与持久化",
5
5
  "main": "index.js",
6
6
  "repository": {
@@ -15,8 +15,8 @@
15
15
  "状态",
16
16
  "缓存"
17
17
  ],
18
- "layer": "infra",
19
- "group": "data",
18
+ "layer": "infrastructure",
19
+ "group": "state",
20
20
  "author": "邱文武",
21
21
  "license": "ISC",
22
22
  "engines": {
@@ -27,7 +27,7 @@
27
27
  "demo": "node example/index.js"
28
28
  },
29
29
  "dependencies": {
30
- "mm_corejs": "^1.1.4",
30
+ "mm_admin": "^1.1.0",
31
31
  "mm_cache": "^1.5.5"
32
32
  },
33
33
  "devDependencies": {
@@ -0,0 +1,7 @@
1
+ 'use strict';
2
+ /**
3
+ * state —— 工具契约适配层
4
+ * 业务实现归位于模块 lib/tools/state/,本文件只把模块能力暴露给加载器。
5
+ * 其它模块可直接 require('mm_state_store').tools.state 复用。
6
+ */
7
+ module.exports = require('../../lib/tools/state');
@@ -0,0 +1,91 @@
1
+ {
2
+ "name": "state",
3
+ "handler": "manager",
4
+ "title": "状态存储管理器",
5
+ "description": "按作用域共享的状态存储,值必须是对象,支持过期时间(秒)。适用场景:保存带时效的工作流上下文、会话状态、临时标记。工作流提示:action 选 set/get/del/has/ttl/keys,set 需传 value 对象并可选 expires_in 秒数(0 或缺省永不过期),get 结果在 value 与 exists,ttl 返回剩余秒数(-1 永不过期,-2 不存在),keys 支持 * 通配。",
6
+ "type": "data",
7
+ "params": {
8
+ "type": "object",
9
+ "properties": {
10
+ "action": {
11
+ "type": "string",
12
+ "description": "操作类型: set(写入)/get(读取)/del(删除)/has(判断存在)/ttl(剩余过期秒数)/keys(列出键)",
13
+ "enum": [
14
+ "set",
15
+ "get",
16
+ "del",
17
+ "has",
18
+ "ttl",
19
+ "keys"
20
+ ],
21
+ "default": "get"
22
+ },
23
+ "scope": {
24
+ "type": "string",
25
+ "description": "状态实例作用域,同作用域共享同一存储,缺省 os",
26
+ "default": "os"
27
+ },
28
+ "key": {
29
+ "type": "string",
30
+ "description": "状态键名(set/get/del/has/ttl时必填)"
31
+ },
32
+ "value": {
33
+ "type": "object",
34
+ "description": "状态对象(set时必填,必须是对象)"
35
+ },
36
+ "expires_in": {
37
+ "type": "number",
38
+ "description": "过期时间秒数(set时使用, 0或缺省表示永不过期)",
39
+ "default": 0
40
+ },
41
+ "pattern": {
42
+ "type": "string",
43
+ "description": "键匹配模式,支持 * 通配符(keys时使用)",
44
+ "default": "*"
45
+ }
46
+ },
47
+ "required": [
48
+ "action"
49
+ ]
50
+ },
51
+ "returns": {
52
+ "description": "get 返回 value 与 exists,has 返回 exists,ttl 返回 ttl,keys 返回 keys 与 count,set/del 返回 msg",
53
+ "type": "object",
54
+ "properties": {
55
+ "key": {
56
+ "type": "string",
57
+ "description": "状态键名"
58
+ },
59
+ "value": {
60
+ "type": "object",
61
+ "description": "读取到的状态对象(get操作,不存在或已过期时为 null)"
62
+ },
63
+ "exists": {
64
+ "type": "boolean",
65
+ "description": "键是否存在(get/has操作)"
66
+ },
67
+ "ttl": {
68
+ "type": "number",
69
+ "description": "剩余秒数(ttl操作,-1 永不过期,-2 不存在)"
70
+ },
71
+ "keys": {
72
+ "type": "array",
73
+ "description": "键名数组(keys操作)"
74
+ },
75
+ "count": {
76
+ "type": "number",
77
+ "description": "键数量(keys操作)"
78
+ },
79
+ "msg": {
80
+ "type": "string",
81
+ "description": "写操作结果描述(set/del操作)"
82
+ },
83
+ "error": {
84
+ "type": "object",
85
+ "description": "错误对象 { code, message }"
86
+ }
87
+ }
88
+ },
89
+ "options": {},
90
+ "group": "system"
91
+ }