@hotfusion/modeller 0.0.13 → 0.0.16
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 +99 -0
- package/dist/adapters/cipher.js +51 -0
- package/dist/adapters/cipher.js.map +1 -0
- package/dist/connector.js +81 -41
- package/dist/connector.js.map +1 -1
- package/dist/core.js +2 -48
- package/dist/core.js.map +1 -1
- package/dist/index.js +9 -1
- package/dist/index.js.map +1 -1
- package/dist/model.js +27 -50
- package/dist/model.js.map +1 -1
- package/dist/oidc/adapter.js +177 -0
- package/dist/oidc/adapter.js.map +1 -0
- package/dist/oidc/adapters/cipher.js +51 -0
- package/dist/oidc/adapters/cipher.js.map +1 -0
- package/dist/oidc/client.js +66 -0
- package/dist/oidc/client.js.map +1 -0
- package/dist/oidc/code.js +37 -0
- package/dist/oidc/code.js.map +1 -0
- package/dist/oidc/default.config.js +200 -0
- package/dist/oidc/default.config.js.map +1 -0
- package/dist/oidc/federation.js +51 -0
- package/dist/oidc/federation.js.map +1 -0
- package/dist/oidc/grant.js +37 -0
- package/dist/oidc/grant.js.map +1 -0
- package/dist/oidc/interaction.js +36 -0
- package/dist/oidc/interaction.js.map +1 -0
- package/dist/oidc/oidc.config.js +79 -0
- package/dist/oidc/oidc.config.js.map +1 -0
- package/dist/oidc/schemas/client.schema.json +62 -0
- package/dist/oidc/schemas/code.schema.json +16 -0
- package/dist/oidc/schemas/grant.schema.json +13 -0
- package/dist/oidc/schemas/interaction.schema.json +26 -0
- package/dist/oidc/schemas/session.schema.json +14 -0
- package/dist/oidc/schemas/token.schema.json +16 -0
- package/dist/oidc/schemas/user.schema.json +44 -0
- package/dist/oidc/session.js +36 -0
- package/dist/oidc/session.js.map +1 -0
- package/dist/oidc/session.token.js +24 -0
- package/dist/oidc/session.token.js.map +1 -0
- package/dist/oidc/token.js +23 -0
- package/dist/oidc/token.js.map +1 -0
- package/dist/oidc/user.js +95 -0
- package/dist/oidc/user.js.map +1 -0
- package/dist/oidc/utils.js +154 -0
- package/dist/oidc/utils.js.map +1 -0
- package/dist/server.js +722 -113
- package/dist/server.js.map +1 -1
- package/dist/types/adapters/cipher.d.ts +12 -0
- package/dist/types/adapters/cipher.d.ts.map +1 -0
- package/dist/types/connector.d.ts +13 -1
- package/dist/types/connector.d.ts.map +1 -1
- package/dist/types/core.d.ts +2 -2
- package/dist/types/core.d.ts.map +1 -1
- package/dist/types/index.d.ts +4 -0
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/model.d.ts +26 -2
- package/dist/types/model.d.ts.map +1 -1
- package/dist/types/oidc/adapter.d.ts +16 -0
- package/dist/types/oidc/adapter.d.ts.map +1 -0
- package/dist/types/oidc/adapters/cipher.d.ts +12 -0
- package/dist/types/oidc/adapters/cipher.d.ts.map +1 -0
- package/dist/types/oidc/client.d.ts +3 -0
- package/dist/types/oidc/client.d.ts.map +1 -0
- package/dist/types/oidc/code.d.ts +3 -0
- package/dist/types/oidc/code.d.ts.map +1 -0
- package/dist/types/oidc/default.config.d.ts +33 -0
- package/dist/types/oidc/default.config.d.ts.map +1 -0
- package/dist/types/oidc/federation.d.ts +3 -0
- package/dist/types/oidc/federation.d.ts.map +1 -0
- package/dist/types/oidc/grant.d.ts +3 -0
- package/dist/types/oidc/grant.d.ts.map +1 -0
- package/dist/types/oidc/interaction.d.ts +3 -0
- package/dist/types/oidc/interaction.d.ts.map +1 -0
- package/dist/types/oidc/oidc.config.d.ts +7 -0
- package/dist/types/oidc/oidc.config.d.ts.map +1 -0
- package/dist/types/oidc/session.d.ts +3 -0
- package/dist/types/oidc/session.d.ts.map +1 -0
- package/dist/types/oidc/session.token.d.ts +3 -0
- package/dist/types/oidc/session.token.d.ts.map +1 -0
- package/dist/types/oidc/token.d.ts +3 -0
- package/dist/types/oidc/token.d.ts.map +1 -0
- package/dist/types/oidc/user.d.ts +3 -0
- package/dist/types/oidc/user.d.ts.map +1 -0
- package/dist/types/oidc/utils.d.ts +56 -0
- package/dist/types/oidc/utils.d.ts.map +1 -0
- package/dist/types/server.d.ts +8 -3
- package/dist/types/server.d.ts.map +1 -1
- package/dist/types/types.d.ts +264 -0
- package/dist/types/utils/bundler.d.ts.map +1 -1
- package/dist/types/utils/display.d.ts +23 -0
- package/dist/types/utils/display.d.ts.map +1 -0
- package/dist/utils/_secret.key +1 -0
- package/dist/utils/bundler.js +48 -8
- package/dist/utils/bundler.js.map +1 -1
- package/dist/utils/display.js +207 -0
- package/dist/utils/display.js.map +1 -0
- package/package.json +28 -4
- package/docs/CORE.md +0 -191
- package/docs/ERRORS.md +0 -90
- package/docs/MODEL.md +0 -296
- package/docs/PATTERNS.md +0 -182
- package/docs/SERVER.md +0 -88
- package/docs/UTILITIES.md +0 -111
|
@@ -0,0 +1,207 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.display = exports.Display = void 0;
|
|
4
|
+
const listr2_1 = require("listr2");
|
|
5
|
+
const cli_progress_1 = require("cli-progress");
|
|
6
|
+
const c = {
|
|
7
|
+
reset: '\x1b[0m',
|
|
8
|
+
dim: '\x1b[2m',
|
|
9
|
+
cyan: '\x1b[36m',
|
|
10
|
+
green: '\x1b[32m',
|
|
11
|
+
yellow: '\x1b[33m',
|
|
12
|
+
red: '\x1b[31m',
|
|
13
|
+
white: '\x1b[37m',
|
|
14
|
+
bold: '\x1b[1m',
|
|
15
|
+
};
|
|
16
|
+
class Display {
|
|
17
|
+
models = new Map();
|
|
18
|
+
views = [];
|
|
19
|
+
oidcUrls = [];
|
|
20
|
+
logPaths = [];
|
|
21
|
+
ready = false;
|
|
22
|
+
pendingErrors = [];
|
|
23
|
+
register(modelId) {
|
|
24
|
+
if (!this.models.has(modelId)) {
|
|
25
|
+
this.models.set(modelId, {
|
|
26
|
+
id: modelId,
|
|
27
|
+
hooks: 0,
|
|
28
|
+
functions: 0,
|
|
29
|
+
workers: 0,
|
|
30
|
+
methods: 0,
|
|
31
|
+
events: 0,
|
|
32
|
+
errors: [],
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
handle(modelId, entry) {
|
|
37
|
+
const state = this.models.get(modelId);
|
|
38
|
+
if (!state)
|
|
39
|
+
return;
|
|
40
|
+
if (entry.initial) {
|
|
41
|
+
if (entry.message.includes('Hook registered'))
|
|
42
|
+
state.hooks++;
|
|
43
|
+
if (entry.message.includes('Function registered'))
|
|
44
|
+
state.functions++;
|
|
45
|
+
if (entry.message.includes('Worker registered'))
|
|
46
|
+
state.workers++;
|
|
47
|
+
if (entry.message.includes('Method registered'))
|
|
48
|
+
state.methods++;
|
|
49
|
+
if (entry.message.includes('Event registered'))
|
|
50
|
+
state.events++;
|
|
51
|
+
}
|
|
52
|
+
if (entry.level === 'error') {
|
|
53
|
+
state.errors.push(`[${modelId}] ${entry.message}`);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
// TODO: addView, addOIDC, addLog should be replaced with a generic addGroup(groupName, value)
|
|
57
|
+
// API so display.ts stays generic in the modeller package and doesn't need to know
|
|
58
|
+
// about specific consumers. Each model/package should register its own group dynamically.
|
|
59
|
+
addView(url) {
|
|
60
|
+
if (this.ready)
|
|
61
|
+
this.printLine(url);
|
|
62
|
+
else
|
|
63
|
+
this.views.push(url);
|
|
64
|
+
}
|
|
65
|
+
addOIDC(url) {
|
|
66
|
+
if (this.ready)
|
|
67
|
+
this.printLine(url);
|
|
68
|
+
else
|
|
69
|
+
this.oidcUrls.push(url);
|
|
70
|
+
}
|
|
71
|
+
addLog(path) {
|
|
72
|
+
if (this.ready) {
|
|
73
|
+
if (!this.logPaths.length)
|
|
74
|
+
console.log(`\n ${c.dim}Logs${c.reset}`);
|
|
75
|
+
this.logPaths.push(path);
|
|
76
|
+
this.printLine(path);
|
|
77
|
+
}
|
|
78
|
+
else {
|
|
79
|
+
this.logPaths.push(path);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
printLine(url) {
|
|
83
|
+
console.log(` ${c.dim}│${c.reset} ${c.green}→${c.reset} ${c.cyan}${url}${c.reset}`);
|
|
84
|
+
}
|
|
85
|
+
buildSummary(state) {
|
|
86
|
+
const parts = [];
|
|
87
|
+
if (state.hooks)
|
|
88
|
+
parts.push(`${c.cyan}${state.hooks}${c.reset}${c.dim} hooks${c.reset}`);
|
|
89
|
+
if (state.functions)
|
|
90
|
+
parts.push(`${c.cyan}${state.functions}${c.reset}${c.dim} fn${c.reset}`);
|
|
91
|
+
if (state.methods)
|
|
92
|
+
parts.push(`${c.cyan}${state.methods}${c.reset}${c.dim} methods${c.reset}`);
|
|
93
|
+
if (state.workers)
|
|
94
|
+
parts.push(`${c.cyan}${state.workers}${c.reset}${c.dim} workers${c.reset}`);
|
|
95
|
+
if (state.events)
|
|
96
|
+
parts.push(`${c.cyan}${state.events}${c.reset}${c.dim} events${c.reset}`);
|
|
97
|
+
return parts.join(` `);
|
|
98
|
+
}
|
|
99
|
+
async welcome() {
|
|
100
|
+
const bar = new cli_progress_1.SingleBar({
|
|
101
|
+
format: ` ${c.cyan}@hotfusion/modeller${c.reset} [${c.cyan}{bar}${c.reset}] ${c.dim}{percentage}%${c.reset}`,
|
|
102
|
+
barCompleteChar: '█',
|
|
103
|
+
barIncompleteChar: '░',
|
|
104
|
+
hideCursor: true,
|
|
105
|
+
clearOnComplete: true,
|
|
106
|
+
}, cli_progress_1.Presets.shades_classic);
|
|
107
|
+
bar.start(100, 0);
|
|
108
|
+
const steps = 15;
|
|
109
|
+
const delay = 1000 / steps;
|
|
110
|
+
for (let i = 1; i <= steps; i++) {
|
|
111
|
+
await new Promise(r => setTimeout(r, delay));
|
|
112
|
+
bar.update(Math.round((i / steps) * 100));
|
|
113
|
+
}
|
|
114
|
+
bar.stop();
|
|
115
|
+
}
|
|
116
|
+
async run(port, onReady) {
|
|
117
|
+
await this.welcome();
|
|
118
|
+
console.log();
|
|
119
|
+
for (const state of this.models.values()) {
|
|
120
|
+
console.log(` ${c.green}✓${c.reset} ${c.bold}${state.id.padEnd(14)}${c.reset} ${this.buildSummary(state)}`);
|
|
121
|
+
}
|
|
122
|
+
console.log();
|
|
123
|
+
const tasks = new listr2_1.Listr([
|
|
124
|
+
{
|
|
125
|
+
title: 'Starting server...',
|
|
126
|
+
task: async (_, task) => {
|
|
127
|
+
await onReady();
|
|
128
|
+
task.title = `Server listening on ${c.cyan}http://localhost:${port}${c.reset}`;
|
|
129
|
+
},
|
|
130
|
+
},
|
|
131
|
+
], { concurrent: false, renderer: 'simple' });
|
|
132
|
+
await tasks.run();
|
|
133
|
+
if (this.views.length) {
|
|
134
|
+
console.log();
|
|
135
|
+
console.log(` ${c.dim}Views${c.reset}`);
|
|
136
|
+
for (const url of this.views)
|
|
137
|
+
this.printLine(url);
|
|
138
|
+
console.log();
|
|
139
|
+
}
|
|
140
|
+
if (this.oidcUrls.length) {
|
|
141
|
+
console.log();
|
|
142
|
+
console.log(` ${c.dim}OIDC${c.reset}`);
|
|
143
|
+
for (const url of this.oidcUrls)
|
|
144
|
+
this.printLine(url);
|
|
145
|
+
console.log();
|
|
146
|
+
}
|
|
147
|
+
if (this.logPaths.length) {
|
|
148
|
+
console.log();
|
|
149
|
+
console.log(` ${c.dim}Logs${c.reset}`);
|
|
150
|
+
for (const path of this.logPaths)
|
|
151
|
+
this.printLine(path);
|
|
152
|
+
console.log();
|
|
153
|
+
}
|
|
154
|
+
this.ready = true;
|
|
155
|
+
for (const err of this.pendingErrors)
|
|
156
|
+
console.error(err);
|
|
157
|
+
this.pendingErrors = [];
|
|
158
|
+
const allErrors = Array.from(this.models.values()).flatMap(s => s.errors);
|
|
159
|
+
for (const err of allErrors) {
|
|
160
|
+
console.error(` ${c.red}✗${c.reset} ${err}`);
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
log(modelId, message, data) {
|
|
164
|
+
if (!this.ready)
|
|
165
|
+
return;
|
|
166
|
+
const ts = new Date().toISOString();
|
|
167
|
+
const line = data
|
|
168
|
+
? ` ${c.dim}[${ts}]${c.reset} ${c.cyan}[${modelId}]${c.reset} ${message} ${c.dim}${JSON.stringify(data)}${c.reset}`
|
|
169
|
+
: ` ${c.dim}[${ts}]${c.reset} ${c.cyan}[${modelId}]${c.reset} ${message}`;
|
|
170
|
+
console.log(line);
|
|
171
|
+
}
|
|
172
|
+
formatError(message) {
|
|
173
|
+
try {
|
|
174
|
+
const parsed = JSON.parse(message);
|
|
175
|
+
if (parsed?.code === 'VALIDATION_ERROR' && Array.isArray(parsed.errors)) {
|
|
176
|
+
const context = [
|
|
177
|
+
parsed.model && ` ${c.dim}model: ${c.reset}${c.cyan}${parsed.model}${c.reset}`,
|
|
178
|
+
parsed.client_id && ` ${c.dim}client: ${c.reset}${c.cyan}${parsed.client_id}${c.reset}`,
|
|
179
|
+
].filter(Boolean).join('');
|
|
180
|
+
const lines = [`${c.yellow}VALIDATION ERROR:${c.reset}${context}`];
|
|
181
|
+
for (const e of parsed.errors) {
|
|
182
|
+
lines.push(` ${c.dim}>${c.reset} ${c.dim}${e.instancePath || '/'}${c.reset} ${c.red}${e.message}${c.reset}`);
|
|
183
|
+
}
|
|
184
|
+
return lines.join('\n');
|
|
185
|
+
}
|
|
186
|
+
if (parsed?.code)
|
|
187
|
+
return `${c.yellow}${parsed.code}${c.reset}${parsed.message ? ` ${parsed.message}` : ''}`;
|
|
188
|
+
return message;
|
|
189
|
+
}
|
|
190
|
+
catch {
|
|
191
|
+
return message;
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
error(modelId, message, data) {
|
|
195
|
+
const ts = new Date().toISOString();
|
|
196
|
+
const prefix = ` ${c.red}✗${c.reset} ${c.dim}[${ts}]${c.reset} ${c.cyan}[${modelId}]${c.reset}`;
|
|
197
|
+
const body = this.formatError(typeof message === 'string' ? message : JSON.stringify(message));
|
|
198
|
+
const line = data ? `${prefix} ${body} ${c.dim}${JSON.stringify(data)}${c.reset}` : `${prefix} ${body}`;
|
|
199
|
+
if (this.ready)
|
|
200
|
+
console.error(line);
|
|
201
|
+
else
|
|
202
|
+
this.pendingErrors.push(line);
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
exports.Display = Display;
|
|
206
|
+
exports.display = new Display();
|
|
207
|
+
//# sourceMappingURL=display.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"display.js","sourceRoot":"","sources":["../../src/utils/display.ts"],"names":[],"mappings":";;;AAAA,mCAA2C;AAC3C,+CAAkD;AAGlD,MAAM,CAAC,GAAG;IACN,KAAK,EAAI,SAAS;IAClB,GAAG,EAAM,SAAS;IAClB,IAAI,EAAK,UAAU;IACnB,KAAK,EAAI,UAAU;IACnB,MAAM,EAAG,UAAU;IACnB,GAAG,EAAM,UAAU;IACnB,KAAK,EAAI,UAAU;IACnB,IAAI,EAAK,SAAS;CACrB,CAAC;AAYF,MAAa,OAAO;IACR,MAAM,GAAqC,IAAI,GAAG,EAAE,CAAC;IACrD,KAAK,GAAsC,EAAE,CAAC;IAC9C,QAAQ,GAAmC,EAAE,CAAC;IAC9C,QAAQ,GAAmC,EAAE,CAAC;IAC9C,KAAK,GAAsC,KAAK,CAAC;IACjD,aAAa,GAA8B,EAAE,CAAC;IAEtD,QAAQ,CAAC,OAAe;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE;gBACrB,EAAE,EAAU,OAAO;gBACnB,KAAK,EAAO,CAAC;gBACb,SAAS,EAAG,CAAC;gBACb,OAAO,EAAK,CAAC;gBACb,OAAO,EAAK,CAAC;gBACb,MAAM,EAAM,CAAC;gBACb,MAAM,EAAM,EAAE;aACjB,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,MAAM,CAAC,OAAe,EAAE,KAAgB;QACpC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK;YAAE,OAAO;QAEnB,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBAAM,KAAK,CAAC,KAAK,EAAE,CAAC;YACjE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAC;gBAAE,KAAK,CAAC,SAAS,EAAE,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;gBAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAC;gBAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnE,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAC;gBAAK,KAAK,CAAC,MAAM,EAAE,CAAC;QACtE,CAAC;QAED,IAAI,KAAK,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;YAC1B,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,OAAO,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACvD,CAAC;IACL,CAAC;IAED,8FAA8F;IAC9F,mFAAmF;IACnF,0FAA0F;IAE1F,OAAO,CAAC,GAAW;QACf,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;;YACpB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;IAED,OAAO,CAAC,GAAW;QACf,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;;YACpB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,IAAY;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM;gBAAE,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YACrE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;IACL,CAAC;IAEO,SAAS,CAAC,GAAW;QACzB,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,GAAG,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IAC3F,CAAC;IAEO,YAAY,CAAC,KAAkB;QACnC,MAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,KAAK;YAAM,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAC7F,IAAI,KAAK,CAAC,SAAS;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAC9F,IAAI,KAAK,CAAC,OAAO;YAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACjG,IAAI,KAAK,CAAC,OAAO;YAAI,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QACjG,IAAI,KAAK,CAAC,MAAM;YAAK,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;QAC/F,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,OAAO;QACjB,MAAM,GAAG,GAAG,IAAI,wBAAS,CAAC;YACtB,MAAM,EAAa,KAAK,CAAC,CAAC,IAAI,sBAAsB,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,KAAK,EAAE;YAC1H,eAAe,EAAI,GAAG;YACtB,iBAAiB,EAAE,GAAG;YACtB,UAAU,EAAS,IAAI;YACvB,eAAe,EAAI,IAAI;SAC1B,EAAE,sBAAO,CAAC,cAAc,CAAC,CAAC;QAE3B,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAClB,MAAM,KAAK,GAAG,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,IAAI,GAAG,KAAK,CAAC;QAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9B,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;YAC7C,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;QAC9C,CAAC;QACD,GAAG,CAAC,IAAI,EAAE,CAAC;IACf,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,IAAY,EAAE,OAA4B;QAChD,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAErB,OAAO,CAAC,GAAG,EAAE,CAAC;QACd,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YACvC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACnH,CAAC;QACD,OAAO,CAAC,GAAG,EAAE,CAAC;QAEd,MAAM,KAAK,GAAG,IAAI,cAAK,CAAC;YACpB;gBACI,KAAK,EAAG,oBAAoB;gBAC5B,IAAI,EAAI,KAAK,EAAE,CAAM,EAAE,IAAS,EAAE,EAAE;oBAChC,MAAM,OAAO,EAAE,CAAC;oBAChB,IAAI,CAAC,KAAK,GAAG,uBAAuB,CAAC,CAAC,IAAI,oBAAoB,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;gBACnF,CAAC;aACJ;SACJ,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE9C,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;QAElB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YACzC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,KAAK;gBAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,EAAE,CAAC;QAClB,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YACxC,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACrD,OAAO,CAAC,GAAG,EAAE,CAAC;QAClB,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,EAAE,CAAC;YACd,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ;gBAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACvD,OAAO,CAAC,GAAG,EAAE,CAAC;QAClB,CAAC;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAExB,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC1E,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IAED,GAAG,CAAC,OAAe,EAAE,OAAe,EAAE,IAA0B;QAC5D,IAAI,CAAC,IAAI,CAAC,KAAK;YAAE,OAAO;QACxB,MAAM,EAAE,GAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,IAAI,GAAG,IAAI;YACb,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,KAAK,OAAO,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE;YACvH,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAEO,WAAW,CAAC,OAAe;QAC/B,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,IAAI,MAAM,EAAE,IAAI,KAAK,kBAAkB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;gBACtE,MAAM,OAAO,GAAG;oBACZ,MAAM,CAAC,KAAK,IAAS,KAAK,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE;oBACpF,MAAM,CAAC,SAAS,IAAK,KAAK,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,KAAK,EAAE;iBAC5F,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC3B,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,oBAAoB,CAAC,CAAC,KAAK,GAAG,OAAO,EAAE,CAAC,CAAC;gBACnE,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC5B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,YAAY,IAAI,GAAG,GAAG,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;gBACtH,CAAC;gBACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YACD,IAAI,MAAM,EAAE,IAAI;gBAAE,OAAO,GAAG,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YAC7G,OAAO,OAAO,CAAC;QACnB,CAAC;QAAC,MAAM,CAAC;YACL,OAAO,OAAO,CAAC;QACnB,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,OAAe,EAAE,IAA0B;QAC9D,MAAM,EAAE,GAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,IAAI,IAAI,OAAO,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;QACnG,MAAM,IAAI,GAAK,IAAI,CAAC,WAAW,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;QACjG,MAAM,IAAI,GAAK,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,IAAI,KAAK,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,MAAM,KAAK,IAAI,EAAE,CAAC;QAC7G,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;;YACpB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;CACJ;AA3LD,0BA2LC;AAEY,QAAA,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hotfusion/modeller",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.16",
|
|
4
4
|
"description": "",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/types/index.d.ts",
|
|
7
7
|
"scripts": {
|
|
8
|
-
"build": "tsc",
|
|
8
|
+
"build": "tsc && cp src/types.d.ts dist/types/types.d.ts",
|
|
9
9
|
"release": "release-it"
|
|
10
10
|
},
|
|
11
11
|
"files": [
|
|
@@ -23,24 +23,41 @@
|
|
|
23
23
|
"types": "./dist/types/connector.d.ts",
|
|
24
24
|
"require": "./dist/connector.js",
|
|
25
25
|
"default": "./dist/connector.js"
|
|
26
|
+
},
|
|
27
|
+
"./core.ts": {
|
|
28
|
+
"types": "./dist/types/core.d.ts",
|
|
29
|
+
"require": "./dist/core.js",
|
|
30
|
+
"default": "./dist/core.js"
|
|
31
|
+
},
|
|
32
|
+
"./oidc/*": {
|
|
33
|
+
"types": "./dist/oidc",
|
|
34
|
+
"require": "./dist/oidc",
|
|
35
|
+
"default": "./dist/oidc"
|
|
36
|
+
},
|
|
37
|
+
"./types": {
|
|
38
|
+
"types": "./dist/types/types.d.ts",
|
|
39
|
+
"require": "./dist/index.js",
|
|
40
|
+
"default": "./dist/index.js"
|
|
26
41
|
}
|
|
27
42
|
},
|
|
28
43
|
"devDependencies": {
|
|
29
44
|
"@release-it/conventional-changelog": "^10.0.6",
|
|
30
|
-
"release-it": "^19.2.4",
|
|
31
45
|
"@types/busboy": "^1.5.4",
|
|
32
46
|
"@types/koa__cors": "^5.0.1",
|
|
47
|
+
"@types/koa-mount": "^4.0.5",
|
|
33
48
|
"@types/koa-router": "^7.4.9",
|
|
34
49
|
"@types/koa-static": "^4.0.4",
|
|
35
50
|
"@types/less": "^3.0.8",
|
|
36
51
|
"@types/nodemailer": "^7.0.11",
|
|
52
|
+
"@types/oidc-provider": "^9.5.0",
|
|
37
53
|
"@types/ssh2": "^1.15.5",
|
|
38
54
|
"fake-indexeddb": "^6.2.5",
|
|
55
|
+
"release-it": "^19.2.4",
|
|
39
56
|
"ts-node": "^10.9.2",
|
|
40
57
|
"vitest": "^4.0.16"
|
|
41
58
|
},
|
|
42
59
|
"dependencies": {
|
|
43
|
-
"@hotfusion/cipher": "0.0.
|
|
60
|
+
"@hotfusion/cipher": "0.0.13",
|
|
44
61
|
"@koa/bodyparser": "^6.0.0",
|
|
45
62
|
"@koa/cors": "^5.0.0",
|
|
46
63
|
"@rollup/plugin-alias": "^6.0.0",
|
|
@@ -48,21 +65,28 @@
|
|
|
48
65
|
"@rollup/plugin-json": "^6.1.0",
|
|
49
66
|
"@rollup/plugin-node-resolve": "^15.0.0",
|
|
50
67
|
"@rollup/plugin-replace": "^6.0.3",
|
|
68
|
+
"@types/cli-progress": "^3.11.6",
|
|
51
69
|
"ajv": "^8.17.1",
|
|
52
70
|
"ajv-errors": "^3.0.0",
|
|
53
71
|
"ajv-formats": "^3.0.1",
|
|
54
72
|
"bson": "^7.2.0",
|
|
55
73
|
"busboy": "^1.6.0",
|
|
56
74
|
"chokidar": "^5.0.0",
|
|
75
|
+
"cli-progress": "^3.12.0",
|
|
57
76
|
"eventemitter3": "^5.0.1",
|
|
58
77
|
"jose": "^6.1.3",
|
|
59
78
|
"koa": "^3.1.1",
|
|
79
|
+
"koa-body": "^8.0.0",
|
|
80
|
+
"koa-mount": "^4.2.0",
|
|
60
81
|
"koa-router": "^14.0.0",
|
|
61
82
|
"koa-session": "^7.0.2",
|
|
62
83
|
"koa-static": "^5.0.0",
|
|
63
84
|
"less": "^4.5.1",
|
|
85
|
+
"listr2": "^10.2.1",
|
|
64
86
|
"mingo": "^7.2.1",
|
|
87
|
+
"oidc-provider": "^9.8.3",
|
|
65
88
|
"openid-client": "^6.8.1",
|
|
89
|
+
"ora": "^9.4.0",
|
|
66
90
|
"prom-client": "^15.1.3",
|
|
67
91
|
"rollup": "^4.0.0",
|
|
68
92
|
"rollup-plugin-esbuild": "^6.2.1",
|
package/docs/CORE.md
DELETED
|
@@ -1,191 +0,0 @@
|
|
|
1
|
-
# Core Layer
|
|
2
|
-
|
|
3
|
-
`Core` is the in-memory data primitive. It holds documents, validates them against a schema, supports indexed lookups, mingo queries, and an optional persistence adapter. Everything in this doc is inherited by `Model`, so you can ignore Core if you only ever use `Model` — but understanding it explains where the behavior comes from.
|
|
4
|
-
|
|
5
|
-
> [← Back to README](../README.md)
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Table of Contents
|
|
10
|
-
|
|
11
|
-
- [Schema](#schema)
|
|
12
|
-
- [Validator](#validator)
|
|
13
|
-
- [CRUD primitives](#crud-primitives)
|
|
14
|
-
- [Indexes](#indexes)
|
|
15
|
-
- [Adapter](#adapter)
|
|
16
|
-
- [Trash](#trash)
|
|
17
|
-
|
|
18
|
-
---
|
|
19
|
-
|
|
20
|
-
## Schema
|
|
21
|
-
|
|
22
|
-
Schemas are JSON Schema (AJV-compatible) plus a few Modeller-specific keywords:
|
|
23
|
-
|
|
24
|
-
| Keyword | Effect |
|
|
25
|
-
|-------------|-------------------------------------------------------------------------|
|
|
26
|
-
| `unique` | Enforces uniqueness across all documents on `insert` / `update`. |
|
|
27
|
-
| `private` | Field stripped from read responses unless `{ private: true }` is set. |
|
|
28
|
-
| `index` | Builds an in-memory index on the field for fast lookups. |
|
|
29
|
-
| `protected` | Reserved for transport-layer protection (consumed by `Server`). |
|
|
30
|
-
| `hidden` | Hint for client rendering. Not enforced. |
|
|
31
|
-
| `default` | Standard JSON Schema default. |
|
|
32
|
-
| `model` | Async FK-style validation against another model by id. |
|
|
33
|
-
|
|
34
|
-
### `$ref` resolution
|
|
35
|
-
|
|
36
|
-
`$ref` resolves against `$defs` / `definitions` first, then against any `schemes` passed to the constructor (via `$id` match).
|
|
37
|
-
|
|
38
|
-
A `$ref` may also carry a query string:
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
"someModel?key=_id&label=name&search=name,email&columns=name,role&min=1&max=5&unique"
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
This rewrites the property into a model reference with display metadata (`key`, `label`, `search`, `columns`) — used by client tooling to render pickers. For `type: 'array'`, `min` / `max` / `unique` become `minItems` / `maxItems` / `uniqueItemProperties`.
|
|
45
|
-
|
|
46
|
-
### Inspecting the schema
|
|
47
|
-
|
|
48
|
-
```ts
|
|
49
|
-
model.getSchema(); // public — strips `private` fields
|
|
50
|
-
model.getSchema({ private: true }); // full
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Validator
|
|
56
|
-
|
|
57
|
-
AJV with `allErrors`, `strict: false`, `ajv-formats`, and `ajv-errors`. Two custom formats are registered:
|
|
58
|
-
|
|
59
|
-
- `phone` — `+?[0-9 \-()]{7,10}`
|
|
60
|
-
- `password` — at least 8 chars, mixed case, digit, symbol
|
|
61
|
-
|
|
62
|
-
And one custom keyword:
|
|
63
|
-
|
|
64
|
-
- `model` (async) — value must reference an existing document in the named model. Used for FK-style references.
|
|
65
|
-
|
|
66
|
-
```ts
|
|
67
|
-
properties: {
|
|
68
|
-
ownerId: { type: 'string', model: 'users.email' }
|
|
69
|
-
}
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
## CRUD primitives
|
|
75
|
-
|
|
76
|
-
All CRUD methods are async. They throw `{ code, ... }` on failure (see [Errors](./ERRORS.md)).
|
|
77
|
-
|
|
78
|
-
### `insert(key?, ...patches, opts?)`
|
|
79
|
-
|
|
80
|
-
Merges `key` and any patch objects into a single document, validates, assigns a BSON `ObjectId`, and stores it.
|
|
81
|
-
|
|
82
|
-
```ts
|
|
83
|
-
await users.insert({ email: 'a@b.com' }, { name: 'Alex' });
|
|
84
|
-
await users.insert({ email: 'admin@b.com' }, { role: 'admin' }, { private: true });
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
Returns the inserted document. `private: true` includes `private` fields in the response.
|
|
88
|
-
|
|
89
|
-
### `update(key, updates, opts?)`
|
|
90
|
-
|
|
91
|
-
Finds a document by `key` (mingo query), shallow-merges `updates`, re-validates, and saves.
|
|
92
|
-
|
|
93
|
-
```ts
|
|
94
|
-
await users.update({ _id }, { name: 'Alex H.' });
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
Returns the merged document, or `null` if no match.
|
|
98
|
-
|
|
99
|
-
### `delete(key)`
|
|
100
|
-
|
|
101
|
-
Removes the matching document. If an adapter is configured and `trash` is not disabled, the document is moved to the trash bin.
|
|
102
|
-
|
|
103
|
-
```ts
|
|
104
|
-
await users.delete({ _id }); // → { _id } or null
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
### `get(key, opts?)`
|
|
108
|
-
|
|
109
|
-
Returns a single document or `null`.
|
|
110
|
-
|
|
111
|
-
```ts
|
|
112
|
-
await users.get({ email: 'a@b.com' });
|
|
113
|
-
await users.get({ _id }, { private: true });
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### `list(query?, opts?)`
|
|
117
|
-
|
|
118
|
-
Paginated, **exact-match** mingo query.
|
|
119
|
-
|
|
120
|
-
```ts
|
|
121
|
-
await users.list({ role: 'admin' }, { start: 0, count: 25, private: false });
|
|
122
|
-
```
|
|
123
|
-
|
|
124
|
-
Default `count` is 10.
|
|
125
|
-
|
|
126
|
-
### `find(query?, opts?)`
|
|
127
|
-
|
|
128
|
-
Like `list`, but **strings match as case-insensitive substrings**. Non-string values match exactly. Returns an array.
|
|
129
|
-
|
|
130
|
-
```ts
|
|
131
|
-
await users.find({ name: 'al' }, { max: 10 });
|
|
132
|
-
// → [{ name: 'Alex' }, { name: 'Albert' }, ...]
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
Default `max` is 10.
|
|
136
|
-
|
|
137
|
-
> **`list` vs `find`** — `list` is for paginated, exact-match queries (admin views, dashboards). `find` is for autocomplete and search. `list` fires hooks; `find` does not.
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
## Indexes
|
|
142
|
-
|
|
143
|
-
Any property with `index: <number>` in its schema gets a per-field hash index built and maintained automatically. Indexes are used internally to keep large collections fast.
|
|
144
|
-
|
|
145
|
-
```ts
|
|
146
|
-
properties: {
|
|
147
|
-
email : { type: 'string', index: 1 }
|
|
148
|
-
}
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
---
|
|
152
|
-
|
|
153
|
-
## Adapter
|
|
154
|
-
|
|
155
|
-
Models are in-memory by default. Provide an `Adapter` subclass to persist on every write and rehydrate on `pull()`.
|
|
156
|
-
|
|
157
|
-
```ts
|
|
158
|
-
import { Adapter, Model } from '@hotfusion/modeller';
|
|
159
|
-
|
|
160
|
-
class FileAdapter extends Adapter {
|
|
161
|
-
async sync(id, doc) { /* called on every write */ }
|
|
162
|
-
async pull() { /* return array of docs to load */ return []; }
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
const users = new Model('users', schema, { adapter: FileAdapter });
|
|
166
|
-
await users.pull(); // hydrate before serving traffic
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
The Adapter contract:
|
|
170
|
-
|
|
171
|
-
```ts
|
|
172
|
-
class Adapter {
|
|
173
|
-
constructor(id: string) {}
|
|
174
|
-
async sync(id: string, doc: { _id: string, ... }): Promise<void>;
|
|
175
|
-
async pull(): Promise<any[]>;
|
|
176
|
-
}
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
Modeller calls `sync` on every `insert`, `update`, and `delete` — including trash moves. `pull()` is called manually when you want to rehydrate.
|
|
180
|
-
|
|
181
|
-
---
|
|
182
|
-
|
|
183
|
-
## Trash
|
|
184
|
-
|
|
185
|
-
When an adapter is configured, deleted documents go to an in-memory trash bin keyed by `_id`. The bin supports `restore`, `has`, `get`, `permanentDelete`, `empty`, `size`, `list({ start, count })`, `find(query)`, `findAll(query)`. Every trash operation also calls `adapter.sync('trash', doc)` so it can be persisted.
|
|
186
|
-
|
|
187
|
-
Pass `{ trash: false }` in model options to disable.
|
|
188
|
-
|
|
189
|
-
---
|
|
190
|
-
|
|
191
|
-
> **Next:** [Model layer →](./MODEL.md)
|
package/docs/ERRORS.md
DELETED
|
@@ -1,90 +0,0 @@
|
|
|
1
|
-
# Errors
|
|
2
|
-
|
|
3
|
-
All errors thrown by Modeller are plain objects with a `code` field. They aren't `Error` instances — catch them as plain objects and branch on `code`.
|
|
4
|
-
|
|
5
|
-
> [← Back to README](../README.md)
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## Error codes
|
|
10
|
-
|
|
11
|
-
| Code | Source | Extra fields |
|
|
12
|
-
|---------------------|-------------------------------------------------|-------------------------|
|
|
13
|
-
| `VALIDATION_ERROR` | AJV failed on `insert` / `update` / event args. | `errors` (AJV errors[]) |
|
|
14
|
-
| `UNIQUE_VIOLATION` | A `unique` field collided. | `field` |
|
|
15
|
-
| `METHOD_NOT_FOUND` | `call('id', ...)` with unregistered id. | `id` |
|
|
16
|
-
| `UPLOAD_NOT_FOUND` | `callUpload('id', ...)` with unregistered id. | `id` |
|
|
17
|
-
| `STREAM_NOT_FOUND` | `callStream('id', ...)` with unregistered id. | `id` |
|
|
18
|
-
| `EVENT_NOT_FOUND` | `subscription.dispatch('id', ...)` mismatch. | `id` |
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Catching
|
|
23
|
-
|
|
24
|
-
```ts
|
|
25
|
-
try {
|
|
26
|
-
await users.insert({ email: 'bad' });
|
|
27
|
-
} catch (err) {
|
|
28
|
-
switch (err.code) {
|
|
29
|
-
case 'VALIDATION_ERROR':
|
|
30
|
-
console.log('AJV errors:', err.errors);
|
|
31
|
-
break;
|
|
32
|
-
case 'UNIQUE_VIOLATION':
|
|
33
|
-
console.log('duplicate field:', err.field);
|
|
34
|
-
break;
|
|
35
|
-
default:
|
|
36
|
-
throw err;
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
---
|
|
42
|
-
|
|
43
|
-
## Validation error shape
|
|
44
|
-
|
|
45
|
-
`VALIDATION_ERROR` carries the raw AJV error array on `errors`. Each entry has `instancePath`, `keyword`, `message`, `params`, and `schemaPath`.
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
{
|
|
49
|
-
code: 'VALIDATION_ERROR',
|
|
50
|
-
errors: [
|
|
51
|
-
{
|
|
52
|
-
instancePath : '/email',
|
|
53
|
-
keyword : 'format',
|
|
54
|
-
message : 'must match format "email"',
|
|
55
|
-
params : { format: 'email' },
|
|
56
|
-
schemaPath : '#/properties/email/format'
|
|
57
|
-
}
|
|
58
|
-
]
|
|
59
|
-
}
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
`ajv-errors` is enabled, so per-field custom messages declared via `errorMessage` in the schema show up in `message`.
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## Hooks and errors
|
|
67
|
-
|
|
68
|
-
A non-scheduled hook that throws aborts the operation. The thrown value is logged at `error` level via the [logger](./MODEL.md#logging) and re-thrown to the caller. Throw a plain object with a `code` to keep error handling consistent:
|
|
69
|
-
|
|
70
|
-
```ts
|
|
71
|
-
users.hook({
|
|
72
|
-
id: 'check-quota',
|
|
73
|
-
on: 'before:insert',
|
|
74
|
-
callback: async ({ data }) => {
|
|
75
|
-
if (await overQuota(data)) throw { code: 'QUOTA_EXCEEDED' };
|
|
76
|
-
}
|
|
77
|
-
});
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
Scheduled hooks (those with `schedule: <ms>`) are fire-and-forget. Errors from them are logged but not propagated.
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## Workers and errors
|
|
85
|
-
|
|
86
|
-
Worker handler errors are caught and logged at `error` level. They never crash the interval — the worker keeps ticking. If you want a worker to stop on failure, call `model.stop('worker-id')` from inside the handler's catch block.
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
> **Related:** [Core →](./CORE.md) · [Model →](./MODEL.md)
|