mm_datas 0.0.0-stage → 5.3.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/example/custom_demo.js +237 -0
- package/example/model/item_model.json +46 -0
- package/example/model/map_model.json +53 -0
- package/example/model/player_model.json +65 -0
- package/example/model/role_model.json +61 -0
- package/example/model/skill_model.json +60 -0
- package/example/preset_demo.js +44 -0
- package/example/rpg_cache.js +179 -0
- package/example/rpg_crud.js +170 -0
- package/example/rpg_demo.js +61 -0
- package/example/rpg_model/bag_model.json +74 -0
- package/example/rpg_model/character_model.json +165 -0
- package/example/rpg_model/character_skill_model.json +61 -0
- package/example/rpg_model/drop_model.json +103 -0
- package/example/rpg_model/item_model.json +189 -0
- package/example/rpg_model/job_model.json +96 -0
- package/example/rpg_model/level_exp_model.json +111 -0
- package/example/rpg_model/map_model.json +166 -0
- package/example/rpg_model/map_state_model.json +63 -0
- package/example/rpg_model/monster_model.json +115 -0
- package/example/rpg_model/npc_model.json +103 -0
- package/example/rpg_model/quest_model.json +106 -0
- package/example/rpg_model/quest_progress_model.json +61 -0
- package/example/rpg_model/save_model.json +42 -0
- package/example/rpg_model/skill_model.json +124 -0
- package/example/rpg_persistence.js +151 -0
- package/example/rpg_relations.js +196 -0
- package/example/rpg_world.js +149 -0
- package/example/storage_demo.js +194 -0
- package/index.js +122 -0
- package/lib/backend.js +597 -0
- package/lib/errors.js +35 -0
- package/lib/manager.js +717 -0
- package/lib/model.js +540 -0
- package/lib/pool.js +277 -0
- package/lib/relation.js +175 -0
- package/lib/store.js +430 -0
- package/package.json +64 -5
- package/test.js +748 -0
- package/tool/data/index.js +107 -0
- package/tool/data/tool.json +211 -0
- package/README.md +0 -3
|
@@ -0,0 +1,194 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
/**
|
|
3
|
+
* v5 存储布局演示(可离线运行)
|
|
4
|
+
*
|
|
5
|
+
* 1. example/model/ 下有几个 *_model.json,就创建几种集合
|
|
6
|
+
* 2. 静态数据:data/<集合名>/000001.json —— 一条记录一个文件,每种模型一个目录;
|
|
7
|
+
* 文件 I/O 委托 mm_jsondb 的 Store 文件层(database:'.' + pad:6 由模块自身补零)
|
|
8
|
+
* 3. 动态数据:mm_cache 缓存 + mm_mongodb 持久;连不上自动回退本地快照
|
|
9
|
+
* 4. mm_sql:可选的关系型 / JSONDB 数据源适配器,配置后 flush 时同步一份
|
|
10
|
+
* (mm_sql 的 way:'jsondb' 后端就是 mm_jsondb)
|
|
11
|
+
* 5. 重启恢复:新池 connect() + restore()
|
|
12
|
+
* 6. 四个依赖统一经各自 mm_admin 实例池:
|
|
13
|
+
* jsondbAdmin / cacheAdmin / mongodbAdmin / sqlAdmin
|
|
14
|
+
*
|
|
15
|
+
* 本示例用一个实现了 set/get 的内存客户端注入 mongodb 适配器,
|
|
16
|
+
* 用来演示「MongoDB 已连接」路径,生产环境去掉 client 注入、填真实连接即可。
|
|
17
|
+
*
|
|
18
|
+
* 运行:npm run demo:storage
|
|
19
|
+
*/
|
|
20
|
+
const fs = require('fs');
|
|
21
|
+
const path = require('path');
|
|
22
|
+
const os = require('os');
|
|
23
|
+
const mm = require('../index.js');
|
|
24
|
+
|
|
25
|
+
const MODEL_DIR = path.join(__dirname, 'model');
|
|
26
|
+
const ROOT = path.join(os.tmpdir(), 'mm_data_v5_demo');
|
|
27
|
+
const DATA_DIR = path.join(ROOT, 'data');
|
|
28
|
+
const DATA_DIR2 = path.join(ROOT, 'data_fallback');
|
|
29
|
+
const SQL_DIR = path.join(ROOT, 'sql');
|
|
30
|
+
|
|
31
|
+
function title(text) { console.log('\n===== ' + text + ' ====='); }
|
|
32
|
+
function show(label, value) {
|
|
33
|
+
console.log(' ' + label + ': ' + (typeof value === 'string' ? value : JSON.stringify(value)));
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/** 注入式 MongoDB 客户端:只实现 mm_mongodb 的 set / get,行为与真连接一致 */
|
|
37
|
+
function memoryMongo() {
|
|
38
|
+
const mem = new Map();
|
|
39
|
+
return {
|
|
40
|
+
async set(key, value) { mem.set(key, value); return 1; },
|
|
41
|
+
async get(key) { return mem.has(key) ? mem.get(key) : null; },
|
|
42
|
+
size() { return mem.size; }
|
|
43
|
+
};
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
const mongo = memoryMongo();
|
|
47
|
+
|
|
48
|
+
function sqlConfig() {
|
|
49
|
+
return {
|
|
50
|
+
enabled: true,
|
|
51
|
+
db_type: 'sqlite',
|
|
52
|
+
sqlite: { dir: SQL_DIR, database: 'storage_demo' }
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
function poolConfig(dir, withBackends) {
|
|
57
|
+
const cfg = { store: 'hybrid', dir: dir, models: MODEL_DIR };
|
|
58
|
+
if (withBackends) {
|
|
59
|
+
cfg.mongodb = { client: mongo };
|
|
60
|
+
cfg.sql = sqlConfig();
|
|
61
|
+
}
|
|
62
|
+
return cfg;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function dirs(root) {
|
|
66
|
+
return fs.readdirSync(root, { withFileTypes: true })
|
|
67
|
+
.filter(function (e) { return e.isDirectory() && e.name.charAt(0) !== '_'; })
|
|
68
|
+
.map(function (e) { return e.name; }).sort();
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
async function main() {
|
|
72
|
+
title('0. 依赖探测');
|
|
73
|
+
show('require 结果', mm.probe());
|
|
74
|
+
show('说明', '外部依赖都是可选增强:未安装 / 未启用 / 连不上都自动降级,同步 CRUD 永远可用');
|
|
75
|
+
|
|
76
|
+
// ---------- 1. 模型文件决定集合 ----------
|
|
77
|
+
title('1. *_model.json → 集合');
|
|
78
|
+
const files = mm.modelFiles(MODEL_DIR);
|
|
79
|
+
show('模型文件', files.map(function (f) { return f.file; }));
|
|
80
|
+
show('推导集合名', files.map(function (f) { return f.name; }));
|
|
81
|
+
|
|
82
|
+
const pool = mm.createPool('storage_demo', poolConfig(DATA_DIR, true));
|
|
83
|
+
const reg = mm.dataAdmin.registry(pool);
|
|
84
|
+
show('实际集合数', reg.models().length);
|
|
85
|
+
show('文件数 == 集合数', files.length === reg.models().length);
|
|
86
|
+
show('集合一览', reg.models().map(function (m) { return m.name + '(' + m.kind + ')'; }));
|
|
87
|
+
|
|
88
|
+
// ---------- 2. 静态数据逐文件落盘 ----------
|
|
89
|
+
title('2. 静态数据:data/<集合名>/000001.json');
|
|
90
|
+
const saved = reg.save();
|
|
91
|
+
show('save()', { backend: saved.backend, tables: saved.tables, static_files: saved.static_files });
|
|
92
|
+
const roleFile = path.join(DATA_DIR, 'role', '000001.json');
|
|
93
|
+
show('data/role/000001.json 存在', fs.existsSync(roleFile));
|
|
94
|
+
show('data/role/000001.json 内容', JSON.parse(fs.readFileSync(roleFile, 'utf8')));
|
|
95
|
+
show('data/role/ 目录', fs.readdirSync(path.join(DATA_DIR, 'role')).sort());
|
|
96
|
+
show('data/skill/ 目录', fs.readdirSync(path.join(DATA_DIR, 'skill')).sort());
|
|
97
|
+
show('data 下每种模型一个目录', dirs(DATA_DIR));
|
|
98
|
+
const backends = pool.backends();
|
|
99
|
+
show('文件层(mm_jsondb Store)', backends.file_layer);
|
|
100
|
+
show('依赖实例池工厂', {
|
|
101
|
+
file: backends.file_layer.factory, cache: backends.adapters.cache.factory,
|
|
102
|
+
mongodb: backends.adapters.mongodb.factory, sql: backends.adapters.sql.factory
|
|
103
|
+
});
|
|
104
|
+
show('为什么不走 table().add()', '上层 API 会注入 id 字段并生成 _meta.json / _index/,与模型主键和纯行文件目录约定冲突');
|
|
105
|
+
show('静态表只读', (function () {
|
|
106
|
+
try { pool.data('role').add({ name: '越界写入' }); return '未拦截'; }
|
|
107
|
+
catch (e) { return e.code || e.message; }
|
|
108
|
+
})());
|
|
109
|
+
show('换版用 reload', pool.data('role').reload([
|
|
110
|
+
{ role_id: 1, name: '战士', base_hp: 200, base_mp: 20 },
|
|
111
|
+
{ role_id: 2, name: '法师', base_hp: 100, base_mp: 120 },
|
|
112
|
+
{ role_id: 3, name: '牧师', base_hp: 120, base_mp: 100 }
|
|
113
|
+
]).count + ' 条');
|
|
114
|
+
|
|
115
|
+
// ---------- 3. 动态数据:CRUD + 关联 + mm_cache 缓存 ----------
|
|
116
|
+
title('3. 动态数据:CRUD / 关联 / mm_cache');
|
|
117
|
+
const player = pool.data('player');
|
|
118
|
+
const arthur = player.add({ name: '亚瑟', role_id: 1, map_id: 1, level: 10, hp: 200, online: true });
|
|
119
|
+
const merlin = player.add({ name: '梅林', role_id: 2, map_id: 1, level: 9 });
|
|
120
|
+
show('新增玩家', [arthur.id + ':' + arthur.obj.name, merlin.id + ':' + merlin.obj.name]);
|
|
121
|
+
show('关联展开', (function () {
|
|
122
|
+
const row = player.get(arthur.id, { with: ['role', 'map'] });
|
|
123
|
+
return row.name + ' → ' + row.role.name + ' @ ' + row.map.name;
|
|
124
|
+
})());
|
|
125
|
+
show('条件查询', player.where({ online: true }).map(function (r) { return r.name; }));
|
|
126
|
+
show('schema 拦截', (function () {
|
|
127
|
+
try { player.add({ name: '越界', role_id: 1, map_id: 1, level: 1000 }); return '未拦截'; }
|
|
128
|
+
catch (e) { return e.code || e.message; }
|
|
129
|
+
})());
|
|
130
|
+
|
|
131
|
+
const connected = await pool.connect();
|
|
132
|
+
show('mm_cache', { connected: connected.cache.connected, way: connected.cache.way });
|
|
133
|
+
show('mm_mongodb', { connected: connected.mongodb.connected, reason: connected.mongodb.reason });
|
|
134
|
+
show('mm_sql', { connected: connected.sql.connected, db_type: connected.sql.db_type });
|
|
135
|
+
|
|
136
|
+
const first = await player.cacheGet(arthur.id);
|
|
137
|
+
await player.cacheGet(arthur.id);
|
|
138
|
+
const cachedList = await player.cacheList({ online: true });
|
|
139
|
+
show('cacheGet', first.name);
|
|
140
|
+
show('cacheList', cachedList.count + ' 条');
|
|
141
|
+
show('缓存统计', pool.backends().adapters.cache.stats);
|
|
142
|
+
show('写入后失效键数', await player.invalidateCache());
|
|
143
|
+
|
|
144
|
+
// ---------- 4. flush:静态逐文件 / 动态缓存 + 持久 + 可选 SQL ----------
|
|
145
|
+
title('4. flush():一次把工作集推到各层');
|
|
146
|
+
const flushed = await pool.flush();
|
|
147
|
+
show('汇总', {
|
|
148
|
+
static_files: flushed.static_files, cache: flushed.cache,
|
|
149
|
+
mongodb: flushed.mongodb, sql: flushed.sql,
|
|
150
|
+
local_snapshot: flushed.local_snapshot, file_fallback: flushed.file_fallback
|
|
151
|
+
});
|
|
152
|
+
show('data/player 目录', fs.readdirSync(path.join(DATA_DIR, 'player')).sort());
|
|
153
|
+
show('data/role 目录', fs.readdirSync(path.join(DATA_DIR, 'role')).sort());
|
|
154
|
+
show('mm_sql 里的 player 行数', (await player.sql('SELECT body FROM d_player') || []).length);
|
|
155
|
+
show('MongoDB 快照键数', mongo.size());
|
|
156
|
+
show('后端报告', pool.backends().adapters);
|
|
157
|
+
|
|
158
|
+
// ---------- 5. 重启恢复 ----------
|
|
159
|
+
title('5. 新池重启恢复');
|
|
160
|
+
const restored = mm.createPool('storage_demo_restore', poolConfig(DATA_DIR, true));
|
|
161
|
+
show('恢复前 player 行数', restored.data('player').size);
|
|
162
|
+
await restored.connect();
|
|
163
|
+
const r = await restored.restore();
|
|
164
|
+
show('恢复集合数', r.table_names.length);
|
|
165
|
+
show('数据来源', r.sources);
|
|
166
|
+
show('恢复后玩家', restored.data('player').get(arthur.id).name);
|
|
167
|
+
show('恢复后职业', restored.data('role').get(1).name);
|
|
168
|
+
show('verify()', restored.data('player').verify().ok);
|
|
169
|
+
|
|
170
|
+
// ---------- 6. 依赖不可用时的降级 ----------
|
|
171
|
+
title('6. 未启用 mm_mongodb:自动回退本地文件');
|
|
172
|
+
const fallback = mm.createPool('storage_demo_fallback', poolConfig(DATA_DIR2, false));
|
|
173
|
+
const before = await fallback.connect();
|
|
174
|
+
show('mongodb 状态', before.mongodb.reason);
|
|
175
|
+
fallback.data('player').add({ name: '离线玩家', role_id: 3, map_id: 2, level: 1 });
|
|
176
|
+
const f3 = await fallback.flush();
|
|
177
|
+
show('flush 降级', {
|
|
178
|
+
mongodb: f3.mongodb, file_fallback: f3.file_fallback, local_snapshot: f3.local_snapshot
|
|
179
|
+
});
|
|
180
|
+
show('本地快照存在', fs.existsSync(path.join(DATA_DIR2, 'player', '_rows.json')));
|
|
181
|
+
const r3 = await fallback.restore();
|
|
182
|
+
show('恢复来源', r3.sources.player);
|
|
183
|
+
show('恢复后行数', fallback.data('player').size);
|
|
184
|
+
|
|
185
|
+
title('完成');
|
|
186
|
+
show('数据根目录', ROOT);
|
|
187
|
+
show('结论', '静态=逐文件只读配置;动态=mm_cache 缓存 + mm_mongodb 持久;mm_sql=可选数据源');
|
|
188
|
+
return { collections: reg.models().length, data_dir: DATA_DIR };
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
main().then(function () { process.exit(0); }).catch(function (e) {
|
|
192
|
+
console.error('示例失败:', e);
|
|
193
|
+
process.exit(1);
|
|
194
|
+
});
|
package/index.js
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
/**
|
|
3
|
+
* mm_data —— 基于 mm_admin 实例池的通用数据管理模块
|
|
4
|
+
*
|
|
5
|
+
* const { dataAdmin, DataManager } = require('mm_data');
|
|
6
|
+
*
|
|
7
|
+
* const role = dataAdmin('role'); // mm_admin 池按名字缓存的 DataManager 实例
|
|
8
|
+
* role instanceof DataManager; // true,role 就是「角色数据集合」
|
|
9
|
+
*
|
|
10
|
+
* role.define({
|
|
11
|
+
* key: 'role_id',
|
|
12
|
+
* schema: { // 标准 JSON Schema(draft-07 子集)
|
|
13
|
+
* $schema: 'http://json-schema.org/draft-07/schema#',
|
|
14
|
+
* type: 'object',
|
|
15
|
+
* properties: {
|
|
16
|
+
* name: { type: 'string', maxLength: 12 },
|
|
17
|
+
* level: { type: 'number', minimum: 1, maximum: 99 }
|
|
18
|
+
* },
|
|
19
|
+
* required: ['name'],
|
|
20
|
+
* additionalProperties: false
|
|
21
|
+
* }
|
|
22
|
+
* });
|
|
23
|
+
* role.add({ name:'亚瑟', level:10 }); // 每个 object 的属性值必须符合 schema
|
|
24
|
+
* role.get(1); role.all();
|
|
25
|
+
*
|
|
26
|
+
* 类型只允许 string/number/boolean/object/array/null,禁止 int/integer(整数用 number);
|
|
27
|
+
* 规则判定全部委托 mm_validator。
|
|
28
|
+
* 独立数据世界:createPool('game2') -> pool.data('role'),或 dataAdmin.use(pool)。
|
|
29
|
+
*/
|
|
30
|
+
const fs = require('fs');
|
|
31
|
+
const path = require('path');
|
|
32
|
+
const P = require('./lib/pool.js');
|
|
33
|
+
const M = require('./lib/model.js');
|
|
34
|
+
const B = require('./lib/backend.js');
|
|
35
|
+
|
|
36
|
+
const TOOL_DIR = path.join(__dirname, 'tool');
|
|
37
|
+
|
|
38
|
+
function scan_tool_names(tool_dir) {
|
|
39
|
+
if (!fs.existsSync(tool_dir)) return [];
|
|
40
|
+
return fs.readdirSync(tool_dir, { withFileTypes: true })
|
|
41
|
+
.filter(function (e) { return e.isDirectory() && fs.existsSync(path.join(tool_dir, e.name, 'tool.json')); })
|
|
42
|
+
.map(function (e) { return e.name; });
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function read_tool_config(tool_dir, name) {
|
|
46
|
+
const file = path.join(tool_dir, name, 'tool.json');
|
|
47
|
+
if (!fs.existsSync(file)) return null;
|
|
48
|
+
const cfg = JSON.parse(fs.readFileSync(file, 'utf8'));
|
|
49
|
+
// 两个参数视图必须同源:parameters 给 LLM(OpenAI function calling 格式),
|
|
50
|
+
// params 给仓库工作流扫描(kernel_catalog / kernel_validator / workflow_engine)
|
|
51
|
+
if (cfg.parameters && !cfg.params) cfg.params = cfg.parameters;
|
|
52
|
+
if (cfg.params && !cfg.parameters) cfg.parameters = cfg.params;
|
|
53
|
+
return cfg;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* 导出标准 OpenAI function calling 工具定义
|
|
58
|
+
* { type:'function', function:{ name, description, parameters } }
|
|
59
|
+
* 返回值可直接交给 mm_llm 的 setToolSchema / LLM 的 tools 数组
|
|
60
|
+
*/
|
|
61
|
+
function function_tool_config(tool_dir, name) {
|
|
62
|
+
const cfg = read_tool_config(tool_dir, name);
|
|
63
|
+
if (!cfg) return null;
|
|
64
|
+
return {
|
|
65
|
+
type: 'function',
|
|
66
|
+
function: {
|
|
67
|
+
name: cfg.name || name,
|
|
68
|
+
description: cfg.description || '',
|
|
69
|
+
parameters: cfg.parameters || cfg.params || { type: 'object', properties: {} }
|
|
70
|
+
}
|
|
71
|
+
};
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
module.exports = {
|
|
75
|
+
// 主入口与唯一的管理数据类
|
|
76
|
+
dataAdmin: P.dataAdmin,
|
|
77
|
+
DataManager: P.DataManager,
|
|
78
|
+
createPool: P.createPool,
|
|
79
|
+
admin: P.currentPool(),
|
|
80
|
+
|
|
81
|
+
// mm_admin 全局注册表直通
|
|
82
|
+
reg: P.reg,
|
|
83
|
+
unreg: P.unreg,
|
|
84
|
+
setSecret: P.setSecret,
|
|
85
|
+
list: P.list,
|
|
86
|
+
Admin: P.Admin,
|
|
87
|
+
|
|
88
|
+
EXAMPLE_MODEL_DIR: P.EXAMPLE_MODEL_DIR,
|
|
89
|
+
DEFAULT_NAMESPACE: P.DEFAULT_NAMESPACE,
|
|
90
|
+
|
|
91
|
+
// v5 存储布局与外部依赖(mm_cache / mm_sql / mm_mongodb)
|
|
92
|
+
modelFiles: P.scanModelFiles,
|
|
93
|
+
probe: B.probe,
|
|
94
|
+
RowFileLayout: B.RowFileLayout,
|
|
95
|
+
backends: P.dataAdmin.backends,
|
|
96
|
+
connect: P.dataAdmin.connect,
|
|
97
|
+
flush: P.dataAdmin.flush,
|
|
98
|
+
flushNow: P.dataAdmin.flushNow,
|
|
99
|
+
close: P.dataAdmin.close,
|
|
100
|
+
persistStatus: P.dataAdmin.persistStatus,
|
|
101
|
+
restore: P.dataAdmin.restore,
|
|
102
|
+
|
|
103
|
+
// 当前生效的校验器(schema 规则统一由 mm_validator 执行)
|
|
104
|
+
validator: M.validatorInfo,
|
|
105
|
+
|
|
106
|
+
// 兼容旧引用的别名(已统一命名为 DataManager,请勿在新代码使用)
|
|
107
|
+
DataAdmin: P.DataManager,
|
|
108
|
+
Collection: P.DataManager,
|
|
109
|
+
|
|
110
|
+
// 兼容 AI 工具宿主(mm_ai / mm_workflow)的契约扫描能力
|
|
111
|
+
TOOL_DIR: TOOL_DIR,
|
|
112
|
+
listTools: function () { return scan_tool_names(TOOL_DIR); },
|
|
113
|
+
getToolConfig: function (name) { return read_tool_config(TOOL_DIR, name); },
|
|
114
|
+
|
|
115
|
+
// 给 LLM 的标准 OpenAI function calling 工具定义(parameters 与契约同源)
|
|
116
|
+
getFunctionTool: function (name) { return function_tool_config(TOOL_DIR, name); },
|
|
117
|
+
listFunctionTools: function () {
|
|
118
|
+
return scan_tool_names(TOOL_DIR)
|
|
119
|
+
.map(function (n) { return function_tool_config(TOOL_DIR, n); })
|
|
120
|
+
.filter(Boolean);
|
|
121
|
+
}
|
|
122
|
+
};
|