jxp 4.1.1 → 5.0.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/.env.sample +30 -0
- package/README.md +2 -0
- package/dist/bin/index_audit.d.ts +3 -0
- package/dist/bin/index_audit.d.ts.map +1 -0
- package/dist/bin/index_audit.js +66 -0
- package/dist/bin/index_audit.js.map +1 -0
- package/dist/bin/mcp-stdio-bridge.d.ts +3 -0
- package/dist/bin/mcp-stdio-bridge.d.ts.map +1 -0
- package/dist/bin/mcp-stdio-bridge.js +87 -0
- package/dist/bin/mcp-stdio-bridge.js.map +1 -0
- package/dist/bin/server.d.ts.map +1 -1
- package/dist/bin/server.js +8 -2
- package/dist/bin/server.js.map +1 -1
- package/dist/libs/builtin_models.d.ts +21 -0
- package/dist/libs/builtin_models.d.ts.map +1 -0
- package/dist/libs/builtin_models.js +125 -0
- package/dist/libs/builtin_models.js.map +1 -0
- package/dist/libs/docs-auth.d.ts.map +1 -1
- package/dist/libs/docs-auth.js +6 -2
- package/dist/libs/docs-auth.js.map +1 -1
- package/dist/libs/docs.js +105 -44
- package/dist/libs/docs.js.map +1 -1
- package/dist/libs/groups.js +3 -4
- package/dist/libs/groups.js.map +1 -1
- package/dist/libs/index_diagnostics.d.ts +144 -0
- package/dist/libs/index_diagnostics.d.ts.map +1 -0
- package/dist/libs/index_diagnostics.js +671 -0
- package/dist/libs/index_diagnostics.js.map +1 -0
- package/dist/libs/jxp.d.ts.map +1 -1
- package/dist/libs/jxp.js +97 -331
- package/dist/libs/jxp.js.map +1 -1
- package/dist/libs/load-config.d.ts +2 -0
- package/dist/libs/load-config.d.ts.map +1 -1
- package/dist/libs/load-config.js +10 -0
- package/dist/libs/load-config.js.map +1 -1
- package/dist/libs/login.js +3 -8
- package/dist/libs/login.js.map +1 -1
- package/dist/libs/mcp/auth.d.ts +4 -0
- package/dist/libs/mcp/auth.d.ts.map +1 -0
- package/dist/libs/mcp/auth.js +49 -0
- package/dist/libs/mcp/auth.js.map +1 -0
- package/dist/libs/mcp/config.d.ts +21 -0
- package/dist/libs/mcp/config.d.ts.map +1 -0
- package/dist/libs/mcp/config.js +66 -0
- package/dist/libs/mcp/config.js.map +1 -0
- package/dist/libs/mcp/context.d.ts +5 -0
- package/dist/libs/mcp/context.d.ts.map +1 -0
- package/dist/libs/mcp/context.js +14 -0
- package/dist/libs/mcp/context.js.map +1 -0
- package/dist/libs/mcp/describe.d.ts +13 -0
- package/dist/libs/mcp/describe.d.ts.map +1 -0
- package/dist/libs/mcp/describe.js +36 -0
- package/dist/libs/mcp/describe.js.map +1 -0
- package/dist/libs/mcp/docs_auth.d.ts +5 -0
- package/dist/libs/mcp/docs_auth.d.ts.map +1 -0
- package/dist/libs/mcp/docs_auth.js +36 -0
- package/dist/libs/mcp/docs_auth.js.map +1 -0
- package/dist/libs/mcp/dynamic_import.d.ts +6 -0
- package/dist/libs/mcp/dynamic_import.d.ts.map +1 -0
- package/dist/libs/mcp/dynamic_import.js +12 -0
- package/dist/libs/mcp/dynamic_import.js.map +1 -0
- package/dist/libs/mcp/execute_tool.d.ts +10 -0
- package/dist/libs/mcp/execute_tool.d.ts.map +1 -0
- package/dist/libs/mcp/execute_tool.js +65 -0
- package/dist/libs/mcp/execute_tool.js.map +1 -0
- package/dist/libs/mcp/guides/default.md +67 -0
- package/dist/libs/mcp/guides.d.ts +14 -0
- package/dist/libs/mcp/guides.d.ts.map +1 -0
- package/dist/libs/mcp/guides.js +127 -0
- package/dist/libs/mcp/guides.js.map +1 -0
- package/dist/libs/mcp/model_visibility.d.ts +31 -0
- package/dist/libs/mcp/model_visibility.d.ts.map +1 -0
- package/dist/libs/mcp/model_visibility.js +73 -0
- package/dist/libs/mcp/model_visibility.js.map +1 -0
- package/dist/libs/mcp/mount.d.ts +10 -0
- package/dist/libs/mcp/mount.d.ts.map +1 -0
- package/dist/libs/mcp/mount.js +68 -0
- package/dist/libs/mcp/mount.js.map +1 -0
- package/dist/libs/mcp/read_service.d.ts +23 -0
- package/dist/libs/mcp/read_service.d.ts.map +1 -0
- package/dist/libs/mcp/read_service.js +141 -0
- package/dist/libs/mcp/read_service.js.map +1 -0
- package/dist/libs/mcp/server.d.ts +23 -0
- package/dist/libs/mcp/server.d.ts.map +1 -0
- package/dist/libs/mcp/server.js +111 -0
- package/dist/libs/mcp/server.js.map +1 -0
- package/dist/libs/parse_byte_size.d.ts +10 -0
- package/dist/libs/parse_byte_size.d.ts.map +1 -0
- package/dist/libs/parse_byte_size.js +80 -0
- package/dist/libs/parse_byte_size.js.map +1 -0
- package/dist/libs/query_limits.js +99 -13
- package/dist/libs/query_limits.js.map +1 -1
- package/dist/libs/read_handlers.d.ts +13 -0
- package/dist/libs/read_handlers.d.ts.map +1 -0
- package/dist/libs/read_handlers.js +381 -0
- package/dist/libs/read_handlers.js.map +1 -0
- package/dist/libs/schema.js +2 -2
- package/dist/libs/schema.js.map +1 -1
- package/dist/libs/schema_serialize.d.ts +3 -0
- package/dist/libs/schema_serialize.d.ts.map +1 -0
- package/dist/libs/schema_serialize.js +45 -0
- package/dist/libs/schema_serialize.js.map +1 -0
- package/dist/libs/security.js +7 -11
- package/dist/libs/security.js.map +1 -1
- package/dist/libs/setup.js +3 -4
- package/dist/libs/setup.js.map +1 -1
- package/dist/libs/startup.d.ts +4 -0
- package/dist/libs/startup.d.ts.map +1 -1
- package/dist/libs/startup.js +17 -0
- package/dist/libs/startup.js.map +1 -1
- package/dist/models/indexquerylog_model.d.ts +19 -0
- package/dist/models/indexquerylog_model.d.ts.map +1 -0
- package/dist/models/indexquerylog_model.js +32 -0
- package/dist/models/indexquerylog_model.js.map +1 -0
- package/dist/types/jxp-config.d.ts +29 -0
- package/dist/types/jxp-config.d.ts.map +1 -1
- package/dist/types/schema-fields.d.ts +4 -0
- package/dist/types/schema-fields.d.ts.map +1 -1
- package/docs/api.md +16 -2
- package/docs/changelog.md +101 -1
- package/docs/configuration.md +39 -0
- package/docs/index.md +2 -0
- package/docs/index_diagnostics.md +127 -0
- package/docs/mcp.md +134 -0
- package/docs/schemas.md +3 -1
- package/mkdocs.yml +2 -0
- package/package.json +26 -9
- package/templates/assets/diagnostics.js +352 -0
- package/templates/assets/docs.css +107 -0
- package/templates/assets/mcp-console.js +343 -0
- package/templates/diagnostics.pug +94 -0
- package/templates/index.pug +38 -0
- package/templates/mcp.pug +112 -0
- package/templates/navbar.pug +2 -0
- package/templates/sidebar.pug +12 -0
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.mcpFind = mcpFind;
|
|
4
|
+
exports.mcpCount = mcpCount;
|
|
5
|
+
exports.mcpExportCsv = mcpExportCsv;
|
|
6
|
+
const read_handlers_1 = require("../read_handlers");
|
|
7
|
+
const config_1 = require("./config");
|
|
8
|
+
const model_visibility_1 = require("./model_visibility");
|
|
9
|
+
const errors = require("restify-errors");
|
|
10
|
+
function truncateValue(value, maxLen) {
|
|
11
|
+
if (typeof value === "string" && value.length > maxLen) {
|
|
12
|
+
return value.slice(0, maxLen);
|
|
13
|
+
}
|
|
14
|
+
if (Array.isArray(value)) {
|
|
15
|
+
return value.map((v) => truncateValue(v, maxLen));
|
|
16
|
+
}
|
|
17
|
+
if (value && typeof value === "object" && !(value instanceof Date)) {
|
|
18
|
+
const out = {};
|
|
19
|
+
for (const [k, v] of Object.entries(value)) {
|
|
20
|
+
out[k] = truncateValue(v, maxLen);
|
|
21
|
+
}
|
|
22
|
+
return out;
|
|
23
|
+
}
|
|
24
|
+
return value;
|
|
25
|
+
}
|
|
26
|
+
function truncateResultPayload(payload, maxLen) {
|
|
27
|
+
if (!payload || typeof payload !== "object")
|
|
28
|
+
return payload;
|
|
29
|
+
const clone = JSON.parse(JSON.stringify(payload));
|
|
30
|
+
if (clone.data && Array.isArray(clone.data)) {
|
|
31
|
+
clone.data = clone.data.map((row) => {
|
|
32
|
+
const next = truncateValue(row, maxLen);
|
|
33
|
+
if (JSON.stringify(row).length > JSON.stringify(next).length) {
|
|
34
|
+
next._truncated = true;
|
|
35
|
+
}
|
|
36
|
+
return next;
|
|
37
|
+
});
|
|
38
|
+
}
|
|
39
|
+
else if (clone.data && typeof clone.data === "object") {
|
|
40
|
+
const row = truncateValue(clone.data, maxLen);
|
|
41
|
+
if (JSON.stringify(clone.data).length > JSON.stringify(row).length) {
|
|
42
|
+
row._truncated = true;
|
|
43
|
+
}
|
|
44
|
+
clone.data = row;
|
|
45
|
+
}
|
|
46
|
+
return clone;
|
|
47
|
+
}
|
|
48
|
+
function buildQueryFromFindParams(params, mcp) {
|
|
49
|
+
const query = {};
|
|
50
|
+
if (params.filter)
|
|
51
|
+
query.filter = params.filter;
|
|
52
|
+
if (params.search !== undefined)
|
|
53
|
+
query.search = params.search;
|
|
54
|
+
if (params.populate !== undefined)
|
|
55
|
+
query.populate = params.populate;
|
|
56
|
+
if (params.fields)
|
|
57
|
+
query.fields = params.fields;
|
|
58
|
+
if (params.sort)
|
|
59
|
+
query.sort = params.sort;
|
|
60
|
+
if (params.page)
|
|
61
|
+
query.page = params.page;
|
|
62
|
+
if (params.skip)
|
|
63
|
+
query.skip = params.skip;
|
|
64
|
+
if (params.limit !== undefined) {
|
|
65
|
+
query.limit = Math.min(params.limit, mcp.maxLimit);
|
|
66
|
+
}
|
|
67
|
+
return query;
|
|
68
|
+
}
|
|
69
|
+
function mcpConfigForRequest(baseConfig, forCsv = false) {
|
|
70
|
+
const mcp = (0, config_1.getMcpConfig)();
|
|
71
|
+
const query_limits_overlay = forCsv
|
|
72
|
+
? (0, config_1.overlayMcpCsvLimits)(baseConfig.query_limits, mcp)
|
|
73
|
+
: (0, config_1.overlayMcpQueryLimits)(baseConfig.query_limits, mcp);
|
|
74
|
+
return { ...baseConfig, query_limits: query_limits_overlay };
|
|
75
|
+
}
|
|
76
|
+
async function mcpFind(models, baseConfig, auth, params) {
|
|
77
|
+
const mcp = (0, config_1.getMcpConfig)();
|
|
78
|
+
const slug = params.model;
|
|
79
|
+
const Model = models[slug];
|
|
80
|
+
if (!Model) {
|
|
81
|
+
throw new errors.NotFoundError(`Model "${slug}" not found`);
|
|
82
|
+
}
|
|
83
|
+
await (0, model_visibility_1.assertModelVisibleMcp)(slug, Model, auth, mcp, params.id);
|
|
84
|
+
const config = mcpConfigForRequest(baseConfig);
|
|
85
|
+
const query = buildQueryFromFindParams(params, mcp);
|
|
86
|
+
if (mcp.disableAutopopulate && query.autopopulate) {
|
|
87
|
+
delete query.autopopulate;
|
|
88
|
+
}
|
|
89
|
+
const res = (0, read_handlers_1.buildSyntheticResponse)(auth.user, auth.groups);
|
|
90
|
+
if (params.id) {
|
|
91
|
+
const req = (0, read_handlers_1.buildSyntheticRequest)(config, slug, Model, query, { item_id: params.id });
|
|
92
|
+
await (0, read_handlers_1.executeGetOne)(req, res);
|
|
93
|
+
return truncateResultPayload(res.result, mcp.truncateStringsAt);
|
|
94
|
+
}
|
|
95
|
+
const req = (0, read_handlers_1.buildSyntheticRequest)(config, slug, Model, query);
|
|
96
|
+
await (0, read_handlers_1.executeList)(req, res);
|
|
97
|
+
return truncateResultPayload(res.result, mcp.truncateStringsAt);
|
|
98
|
+
}
|
|
99
|
+
async function mcpCount(models, baseConfig, auth, params) {
|
|
100
|
+
const mcp = (0, config_1.getMcpConfig)();
|
|
101
|
+
const slug = params.model;
|
|
102
|
+
const Model = models[slug];
|
|
103
|
+
if (!Model) {
|
|
104
|
+
throw new errors.NotFoundError(`Model "${slug}" not found`);
|
|
105
|
+
}
|
|
106
|
+
await (0, model_visibility_1.assertModelVisibleMcp)(slug, Model, auth, mcp);
|
|
107
|
+
const config = mcpConfigForRequest(baseConfig);
|
|
108
|
+
const query = {};
|
|
109
|
+
if (params.filter)
|
|
110
|
+
query.filter = params.filter;
|
|
111
|
+
if (params.search !== undefined)
|
|
112
|
+
query.search = params.search;
|
|
113
|
+
const req = (0, read_handlers_1.buildSyntheticRequest)(config, slug, Model, query);
|
|
114
|
+
const res = (0, read_handlers_1.buildSyntheticResponse)(auth.user, auth.groups);
|
|
115
|
+
await (0, read_handlers_1.executeCount)(req, res);
|
|
116
|
+
return res.result;
|
|
117
|
+
}
|
|
118
|
+
async function mcpExportCsv(models, baseConfig, auth, params) {
|
|
119
|
+
const mcp = (0, config_1.getMcpConfig)();
|
|
120
|
+
const slug = params.model;
|
|
121
|
+
const Model = models[slug];
|
|
122
|
+
if (!Model) {
|
|
123
|
+
throw new errors.NotFoundError(`Model "${slug}" not found`);
|
|
124
|
+
}
|
|
125
|
+
await (0, model_visibility_1.assertModelVisibleMcp)(slug, Model, auth, mcp);
|
|
126
|
+
const config = mcpConfigForRequest(baseConfig, true);
|
|
127
|
+
const query = buildQueryFromFindParams(params, mcp);
|
|
128
|
+
const req = (0, read_handlers_1.buildSyntheticRequest)(config, slug, Model, query);
|
|
129
|
+
const res = (0, read_handlers_1.buildSyntheticResponse)(auth.user, auth.groups);
|
|
130
|
+
await (0, read_handlers_1.executeList)(req, res);
|
|
131
|
+
const csv = (0, read_handlers_1.resultToCsv)(res.result);
|
|
132
|
+
const maxBytes = mcp.maxCsvBytes;
|
|
133
|
+
if (maxBytes > 0) {
|
|
134
|
+
const size = Buffer.byteLength(csv, "utf8");
|
|
135
|
+
if (size > maxBytes) {
|
|
136
|
+
throw new errors.PayloadTooLargeError(`CSV export size ${size} bytes exceeds MCP maximum ${maxBytes} bytes. Use fields and a lower limit.`);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
return csv;
|
|
140
|
+
}
|
|
141
|
+
//# sourceMappingURL=read_service.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"read_service.js","sourceRoot":"","sources":["../../../src/libs/mcp/read_service.ts"],"names":[],"mappings":";;AA8FA,0BA8BC;AAED,4BAuBC;AAED,oCA+BC;AApLD,oDAO0B;AAC1B,qCAKkB;AAClB,yDAAgF;AAEhF,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAezC,SAAS,aAAa,CAAC,KAAc,EAAE,MAAc;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;QACxD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,EAAE,CAAC;QACpE,MAAM,GAAG,GAA4B,EAAE,CAAC;QACxC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC,EAAE,CAAC;YACvE,GAAG,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAgB,EAAE,MAAc;IAC9D,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ;QAAE,OAAO,OAAO,CAAC;IAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IAClD,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAA4B,EAAE,EAAE;YAC5D,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,EAAE,MAAM,CAA4B,CAAC;YACnE,IAAI,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;gBAC9D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACxB,CAAC;YACD,OAAO,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;IACJ,CAAC;SAAM,IAAI,KAAK,CAAC,IAAI,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACzD,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAA4B,CAAC;QACzE,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;YACpE,GAAG,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;IAClB,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAkB,EAAE,GAAc;IACnE,MAAM,KAAK,GAA4B,EAAE,CAAC;IAC1C,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;QAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9D,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;QAAE,KAAK,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACpE,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAChD,IAAI,MAAM,CAAC,IAAI;QAAE,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,MAAM,CAAC,IAAI;QAAE,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,MAAM,CAAC,IAAI;QAAE,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1C,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,mBAAmB,CAAC,UAAqB,EAAE,MAAM,GAAG,KAAK;IACjE,MAAM,GAAG,GAAG,IAAA,qBAAY,GAAE,CAAC;IAC3B,MAAM,oBAAoB,GAAG,MAAM;QAClC,CAAC,CAAC,IAAA,4BAAmB,EAAC,UAAU,CAAC,YAAY,EAAE,GAAG,CAAC;QACnD,CAAC,CAAC,IAAA,8BAAqB,EAAC,UAAU,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;IACvD,OAAO,EAAE,GAAG,UAAU,EAAE,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAC9D,CAAC;AAEM,KAAK,UAAU,OAAO,CAC5B,MAAqB,EACrB,UAAqB,EACrB,IAAoB,EACpB,MAAkB;IAElB,MAAM,GAAG,GAAG,IAAA,qBAAY,GAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;IAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,UAAU,IAAI,aAAa,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,IAAA,wCAAqB,EAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;IAE/D,MAAM,MAAM,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpD,IAAI,GAAG,CAAC,mBAAmB,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;QACnD,OAAO,KAAK,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,sCAAsB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,MAAM,GAAG,GAAG,IAAA,qCAAqB,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QACtF,MAAM,IAAA,6BAAa,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAC9B,OAAO,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,GAAG,GAAG,IAAA,qCAAqB,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9D,MAAM,IAAA,2BAAW,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC5B,OAAO,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;AACjE,CAAC;AAEM,KAAK,UAAU,QAAQ,CAC7B,MAAqB,EACrB,UAAqB,EACrB,IAAoB,EACpB,MAAsG;IAEtG,MAAM,GAAG,GAAG,IAAA,qBAAY,GAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;IAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,UAAU,IAAI,aAAa,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,IAAA,wCAAqB,EAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,mBAAmB,CAAC,UAAU,CAAC,CAAC;IAC/C,MAAM,KAAK,GAA4B,EAAE,CAAC;IAC1C,IAAI,MAAM,CAAC,MAAM;QAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAChD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;QAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAE9D,MAAM,GAAG,GAAG,IAAA,qCAAqB,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9D,MAAM,GAAG,GAAG,IAAA,sCAAsB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,MAAM,IAAA,4BAAY,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC7B,OAAO,GAAG,CAAC,MAAM,CAAC;AACnB,CAAC;AAEM,KAAK,UAAU,YAAY,CACjC,MAAqB,EACrB,UAAqB,EACrB,IAAoB,EACpB,MAA8B;IAE9B,MAAM,GAAG,GAAG,IAAA,qBAAY,GAAE,CAAC;IAC3B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;IAC1B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;IAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,MAAM,IAAI,MAAM,CAAC,aAAa,CAAC,UAAU,IAAI,aAAa,CAAC,CAAC;IAC7D,CAAC;IACD,MAAM,IAAA,wCAAqB,EAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACrD,MAAM,KAAK,GAAG,wBAAwB,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACpD,MAAM,GAAG,GAAG,IAAA,qCAAqB,EAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9D,MAAM,GAAG,GAAG,IAAA,sCAAsB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3D,MAAM,IAAA,2BAAW,EAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAE5B,MAAM,GAAG,GAAG,IAAA,2BAAW,EAAC,GAAG,CAAC,MAAiC,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,CAAC;IACjC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;YACrB,MAAM,IAAI,MAAM,CAAC,oBAAoB,CACpC,mBAAmB,IAAI,8BAA8B,QAAQ,uCAAuC,CACpG,CAAC;QACH,CAAC;IACF,CAAC;IACD,OAAO,GAAG,CAAC;AACZ,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { JXPConfig } from "../../types/jxp-config";
|
|
2
|
+
import type { ModelRegistry } from "../builtin_models";
|
|
3
|
+
type McpToolResult = {
|
|
4
|
+
content: {
|
|
5
|
+
type: string;
|
|
6
|
+
text: string;
|
|
7
|
+
}[];
|
|
8
|
+
isError?: boolean;
|
|
9
|
+
};
|
|
10
|
+
type McpServerInstance = {
|
|
11
|
+
registerTool: (name: string, config: Record<string, unknown>, handler: (args: Record<string, unknown>) => Promise<McpToolResult>) => void;
|
|
12
|
+
registerResource: (name: string, uri: string, config: Record<string, unknown>, handler: () => Promise<{
|
|
13
|
+
contents: {
|
|
14
|
+
uri: string;
|
|
15
|
+
mimeType: string;
|
|
16
|
+
text: string;
|
|
17
|
+
}[];
|
|
18
|
+
}>) => void;
|
|
19
|
+
connect: (transport: unknown) => Promise<void>;
|
|
20
|
+
};
|
|
21
|
+
export declare function createMcpServer(config: JXPConfig, models: ModelRegistry): Promise<McpServerInstance>;
|
|
22
|
+
export {};
|
|
23
|
+
//# sourceMappingURL=server.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../../../src/libs/mcp/server.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAgBvD,KAAK,aAAa,GAAG;IAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtF,KAAK,iBAAiB,GAAG;IACxB,YAAY,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,aAAa,CAAC,KAC9D,IAAI,CAAC;IACV,gBAAgB,EAAE,CACjB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,EAAE,MAAM,OAAO,CAAC;QAAE,QAAQ,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;KAAE,CAAC,KACnF,IAAI,CAAC;IACV,OAAO,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/C,CAAC;AAaF,wBAAsB,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,aAAa,8BA+J7E"}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.createMcpServer = createMcpServer;
|
|
4
|
+
const config_1 = require("./config");
|
|
5
|
+
const context_1 = require("./context");
|
|
6
|
+
const guides_1 = require("./guides");
|
|
7
|
+
const execute_tool_1 = require("./execute_tool");
|
|
8
|
+
const dynamic_import_1 = require("./dynamic_import");
|
|
9
|
+
const path = require("path");
|
|
10
|
+
const { z } = require("zod");
|
|
11
|
+
const pkg = require(path.join(__dirname, "../../../package.json"));
|
|
12
|
+
function toolText(payload) {
|
|
13
|
+
return {
|
|
14
|
+
content: [{ type: "text", text: typeof payload === "string" ? payload : JSON.stringify(payload, null, 2) }],
|
|
15
|
+
};
|
|
16
|
+
}
|
|
17
|
+
function toolError(err) {
|
|
18
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
19
|
+
return { content: [{ type: "text", text: message }], isError: true };
|
|
20
|
+
}
|
|
21
|
+
async function createMcpServer(config, models) {
|
|
22
|
+
const { McpServer } = await (0, dynamic_import_1.dynamicImport)("@modelcontextprotocol/server");
|
|
23
|
+
const mcpConfig = (0, config_1.getMcpConfig)();
|
|
24
|
+
const guideCtx = { config, mcpConfig };
|
|
25
|
+
const server = new McpServer({ name: "jxp", version: pkg.version }, { instructions: (0, guides_1.buildMcpInstructions)(guideCtx) });
|
|
26
|
+
server.registerResource(guides_1.MCP_GUIDE_RESOURCE_NAME, guides_1.MCP_GUIDE_URI, {
|
|
27
|
+
title: "JXP MCP usage guide",
|
|
28
|
+
description: "Full markdown guide for querying JXP via MCP tools.",
|
|
29
|
+
mimeType: "text/markdown",
|
|
30
|
+
}, async () => ({
|
|
31
|
+
contents: [
|
|
32
|
+
{
|
|
33
|
+
uri: guides_1.MCP_GUIDE_URI,
|
|
34
|
+
mimeType: "text/markdown",
|
|
35
|
+
text: (0, guides_1.buildMcpGuideMarkdown)(guideCtx),
|
|
36
|
+
},
|
|
37
|
+
],
|
|
38
|
+
}));
|
|
39
|
+
const modelSlug = z.string().min(1).describe("Model slug (from jxp_list_models)");
|
|
40
|
+
server.registerTool("jxp_list_models", {
|
|
41
|
+
title: "List JXP models",
|
|
42
|
+
description: "Always call this first to discover model slugs. Read resource jxp-guide if unsure about workflow.",
|
|
43
|
+
inputSchema: z.object({}),
|
|
44
|
+
}, async () => {
|
|
45
|
+
const auth = (0, context_1.getMcpAuth)();
|
|
46
|
+
const result = await (0, execute_tool_1.executeMcpTool)("jxp_list_models", {}, config, models, auth);
|
|
47
|
+
return result.isError ? toolError(result.text) : toolText(JSON.parse(result.text));
|
|
48
|
+
});
|
|
49
|
+
server.registerTool("jxp_describe_model", {
|
|
50
|
+
title: "Describe JXP model",
|
|
51
|
+
description: "JSON schema for a model: fields, links, populate hints. Call after jxp_list_models before jxp_find.",
|
|
52
|
+
inputSchema: z.object({ model: modelSlug }),
|
|
53
|
+
}, async ({ model }) => {
|
|
54
|
+
const auth = (0, context_1.getMcpAuth)();
|
|
55
|
+
const result = await (0, execute_tool_1.executeMcpTool)("jxp_describe_model", { model: String(model) }, config, models, auth);
|
|
56
|
+
return result.isError ? toolError(result.text) : toolText(JSON.parse(result.text));
|
|
57
|
+
});
|
|
58
|
+
const findSchema = z.object({
|
|
59
|
+
model: modelSlug,
|
|
60
|
+
id: z.string().optional().describe("MongoDB _id for a single document"),
|
|
61
|
+
filter: z.record(z.string(), z.unknown()).optional(),
|
|
62
|
+
search: z.union([z.string(), z.record(z.string(), z.unknown())]).optional(),
|
|
63
|
+
populate: z.union([z.string(), z.record(z.string(), z.string())]).optional(),
|
|
64
|
+
fields: z.string().optional().describe("Comma-separated field projection"),
|
|
65
|
+
sort: z.string().optional(),
|
|
66
|
+
limit: z.number().int().positive().optional(),
|
|
67
|
+
page: z.number().int().positive().optional(),
|
|
68
|
+
skip: z.number().int().nonnegative().optional(),
|
|
69
|
+
});
|
|
70
|
+
server.registerTool("jxp_find", {
|
|
71
|
+
title: "Find JXP documents",
|
|
72
|
+
description: "List or get documents. Use jxp_count first on large collections. Always set fields and a low limit. " +
|
|
73
|
+
`Default limit ${mcpConfig.defaultLimit}, max ${mcpConfig.maxLimit}.`,
|
|
74
|
+
inputSchema: findSchema,
|
|
75
|
+
}, async (args) => {
|
|
76
|
+
const auth = (0, context_1.getMcpAuth)();
|
|
77
|
+
const result = await (0, execute_tool_1.executeMcpTool)("jxp_find", args, config, models, auth);
|
|
78
|
+
if (result.isError)
|
|
79
|
+
return toolError(result.text);
|
|
80
|
+
try {
|
|
81
|
+
return toolText(JSON.parse(result.text));
|
|
82
|
+
}
|
|
83
|
+
catch {
|
|
84
|
+
return toolText(result.text);
|
|
85
|
+
}
|
|
86
|
+
});
|
|
87
|
+
server.registerTool("jxp_count", {
|
|
88
|
+
title: "Count JXP documents",
|
|
89
|
+
description: "Count matching documents. Use before jxp_find on large collections to avoid huge result sets.",
|
|
90
|
+
inputSchema: z.object({
|
|
91
|
+
model: modelSlug,
|
|
92
|
+
filter: z.record(z.string(), z.unknown()).optional(),
|
|
93
|
+
search: z.union([z.string(), z.record(z.string(), z.unknown())]).optional(),
|
|
94
|
+
}),
|
|
95
|
+
}, async (args) => {
|
|
96
|
+
const auth = (0, context_1.getMcpAuth)();
|
|
97
|
+
const result = await (0, execute_tool_1.executeMcpTool)("jxp_count", args, config, models, auth);
|
|
98
|
+
return result.isError ? toolError(result.text) : toolText(JSON.parse(result.text));
|
|
99
|
+
});
|
|
100
|
+
server.registerTool("jxp_export_csv", {
|
|
101
|
+
title: "Export JXP documents as CSV",
|
|
102
|
+
description: "Export matching documents as CSV text. Prefer fields and a low limit. No populate support.",
|
|
103
|
+
inputSchema: findSchema.omit({ id: true }),
|
|
104
|
+
}, async (args) => {
|
|
105
|
+
const auth = (0, context_1.getMcpAuth)();
|
|
106
|
+
const result = await (0, execute_tool_1.executeMcpTool)("jxp_export_csv", args, config, models, auth);
|
|
107
|
+
return result.isError ? toolError(result.text) : toolText(result.text);
|
|
108
|
+
});
|
|
109
|
+
return server;
|
|
110
|
+
}
|
|
111
|
+
//# sourceMappingURL=server.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/libs/mcp/server.ts"],"names":[],"mappings":";;AA6CA,0CA+JC;AA1MD,qCAAwC;AACxC,uCAAuC;AACvC,qCAKkB;AAClB,iDAAgD;AAChD,qDAAiD;AAEjD,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAC7B,MAAM,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;AAC7B,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,CAAC,CAAC;AAmBnE,SAAS,QAAQ,CAAC,OAAgB;IACjC,OAAO;QACN,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;KAC3G,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,GAAY;IAC9B,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACjE,OAAO,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AACtE,CAAC;AAEM,KAAK,UAAU,eAAe,CAAC,MAAiB,EAAE,MAAqB;IAC7E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAA,8BAAa,EAKtC,8BAA8B,CAAC,CAAC;IACnC,MAAM,SAAS,GAAG,IAAA,qBAAY,GAAE,CAAC;IACjC,MAAM,QAAQ,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;IAEvC,MAAM,MAAM,GAAG,IAAI,SAAS,CAC3B,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,EACrC,EAAE,YAAY,EAAE,IAAA,6BAAoB,EAAC,QAAQ,CAAC,EAAE,CAChD,CAAC;IAEF,MAAM,CAAC,gBAAgB,CACtB,gCAAuB,EACvB,sBAAa,EACb;QACC,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EAAE,qDAAqD;QAClE,QAAQ,EAAE,eAAe;KACzB,EACD,KAAK,IAAI,EAAE,CAAC,CAAC;QACZ,QAAQ,EAAE;YACT;gBACC,GAAG,EAAE,sBAAa;gBAClB,QAAQ,EAAE,eAAe;gBACzB,IAAI,EAAE,IAAA,8BAAqB,EAAC,QAAQ,CAAC;aACrC;SACD;KACD,CAAC,CACF,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,mCAAmC,CAAC,CAAC;IAElF,MAAM,CAAC,YAAY,CAClB,iBAAiB,EACjB;QACC,KAAK,EAAE,iBAAiB;QACxB,WAAW,EACV,mGAAmG;QACpG,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;KACzB,EACD,KAAK,IAAI,EAAE;QACV,MAAM,IAAI,GAAG,IAAA,oBAAU,GAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAc,EAAC,iBAAiB,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,YAAY,CAClB,oBAAoB,EACpB;QACC,KAAK,EAAE,oBAAoB;QAC3B,WAAW,EACV,qGAAqG;QACtG,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;KAC3C,EACD,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QACnB,MAAM,IAAI,GAAG,IAAA,oBAAU,GAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAc,EAClC,oBAAoB,EACpB,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,EAAE,EACxB,MAAM,EACN,MAAM,EACN,IAAI,CACJ,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,CAAC,CACD,CAAC;IAEF,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;QAC3B,KAAK,EAAE,SAAS;QAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;QACvE,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;QACpD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;QAC3E,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;QAC5E,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;QAC1E,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAC7C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAC5C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE;KAC/C,CAAC,CAAC;IAEH,MAAM,CAAC,YAAY,CAClB,UAAU,EACV;QACC,KAAK,EAAE,oBAAoB;QAC3B,WAAW,EACV,sGAAsG;YACtG,iBAAiB,SAAS,CAAC,YAAY,SAAS,SAAS,CAAC,QAAQ,GAAG;QACtE,WAAW,EAAE,UAAU;KACvB,EACD,KAAK,EAAE,IAAI,EAAE,EAAE;QACd,MAAM,IAAI,GAAG,IAAA,oBAAU,GAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAc,EAClC,UAAU,EACV,IAA+B,EAC/B,MAAM,EACN,MAAM,EACN,IAAI,CACJ,CAAC;QACF,IAAI,MAAM,CAAC,OAAO;YAAE,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,CAAC;YACJ,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC;IACF,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,YAAY,CAClB,WAAW,EACX;QACC,KAAK,EAAE,qBAAqB;QAC5B,WAAW,EACV,+FAA+F;QAChG,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACrB,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;YACpD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;SAC3E,CAAC;KACF,EACD,KAAK,EAAE,IAAI,EAAE,EAAE;QACd,MAAM,IAAI,GAAG,IAAA,oBAAU,GAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAc,EAClC,WAAW,EACX,IAA+B,EAC/B,MAAM,EACN,MAAM,EACN,IAAI,CACJ,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACpF,CAAC,CACD,CAAC;IAEF,MAAM,CAAC,YAAY,CAClB,gBAAgB,EAChB;QACC,KAAK,EAAE,6BAA6B;QACpC,WAAW,EACV,4FAA4F;QAC7F,WAAW,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;KAC1C,EACD,KAAK,EAAE,IAAI,EAAE,EAAE;QACd,MAAM,IAAI,GAAG,IAAA,oBAAU,GAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAc,EAClC,gBAAgB,EAChB,IAA+B,EAC/B,MAAM,EACN,MAAM,EACN,IAAI,CACJ,CAAC;QACF,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxE,CAAC,CACD,CAAC;IAEF,OAAO,MAA2B,CAAC;AACpC,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/** Normalize human sizes (e.g. `10M`, `10kb`) for the `bytes` parser. */
|
|
2
|
+
export declare function normalizeByteSizeString(value: string): string;
|
|
3
|
+
/**
|
|
4
|
+
* Parse a byte size from a number (bytes) or string (`10mb`, `10M`, `512kb`).
|
|
5
|
+
* Returns 0 for disabled (`0`, `0b`, `false`). Throws on invalid values.
|
|
6
|
+
*/
|
|
7
|
+
export declare function parseByteSize(value: string | number | null | undefined, label?: string): number;
|
|
8
|
+
/** Safe parse for config/env; returns fallback when value is missing. */
|
|
9
|
+
export declare function parseByteSizeOr(value: string | number | null | undefined, fallback: string | number, label?: string): number;
|
|
10
|
+
//# sourceMappingURL=parse_byte_size.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parse_byte_size.d.ts","sourceRoot":"","sources":["../../src/libs/parse_byte_size.ts"],"names":[],"mappings":"AAkBA,yEAAyE;AACzE,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAkB7D;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,KAAK,SAAc,GAAG,MAAM,CAuBpG;AAED,yEAAyE;AACzE,wBAAgB,eAAe,CAC9B,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,EACzC,QAAQ,EAAE,MAAM,GAAG,MAAM,EACzB,KAAK,SAAc,GACjB,MAAM,CAKR"}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.normalizeByteSizeString = normalizeByteSizeString;
|
|
7
|
+
exports.parseByteSize = parseByteSize;
|
|
8
|
+
exports.parseByteSizeOr = parseByteSizeOr;
|
|
9
|
+
const bytes_1 = __importDefault(require("bytes"));
|
|
10
|
+
const UNIT_ALIASES = {
|
|
11
|
+
b: "b",
|
|
12
|
+
k: "kb",
|
|
13
|
+
kb: "kb",
|
|
14
|
+
kib: "kb",
|
|
15
|
+
m: "mb",
|
|
16
|
+
mb: "mb",
|
|
17
|
+
mib: "mb",
|
|
18
|
+
g: "gb",
|
|
19
|
+
gb: "gb",
|
|
20
|
+
gib: "gb",
|
|
21
|
+
t: "tb",
|
|
22
|
+
tb: "tb",
|
|
23
|
+
tib: "tb",
|
|
24
|
+
};
|
|
25
|
+
/** Normalize human sizes (e.g. `10M`, `10kb`) for the `bytes` parser. */
|
|
26
|
+
function normalizeByteSizeString(value) {
|
|
27
|
+
const trimmed = value.trim();
|
|
28
|
+
if (!trimmed) {
|
|
29
|
+
return trimmed;
|
|
30
|
+
}
|
|
31
|
+
const match = trimmed.match(/^(\d+(?:\.\d+)?)\s*([a-zA-Z]+)?$/);
|
|
32
|
+
if (!match) {
|
|
33
|
+
return trimmed.toLowerCase();
|
|
34
|
+
}
|
|
35
|
+
const [, num, unit] = match;
|
|
36
|
+
if (!unit) {
|
|
37
|
+
return num;
|
|
38
|
+
}
|
|
39
|
+
const mapped = UNIT_ALIASES[unit.toLowerCase()];
|
|
40
|
+
if (!mapped) {
|
|
41
|
+
return trimmed.toLowerCase();
|
|
42
|
+
}
|
|
43
|
+
return `${num}${mapped}`;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Parse a byte size from a number (bytes) or string (`10mb`, `10M`, `512kb`).
|
|
47
|
+
* Returns 0 for disabled (`0`, `0b`, `false`). Throws on invalid values.
|
|
48
|
+
*/
|
|
49
|
+
function parseByteSize(value, label = "byte size") {
|
|
50
|
+
if (value === null || value === undefined) {
|
|
51
|
+
throw new Error(`${label} is required`);
|
|
52
|
+
}
|
|
53
|
+
if (typeof value === "number") {
|
|
54
|
+
if (!Number.isFinite(value) || value < 0) {
|
|
55
|
+
throw new Error(`${label} must be a non-negative number`);
|
|
56
|
+
}
|
|
57
|
+
return Math.floor(value);
|
|
58
|
+
}
|
|
59
|
+
const raw = String(value).trim();
|
|
60
|
+
if (!raw) {
|
|
61
|
+
throw new Error(`${label} must not be empty`);
|
|
62
|
+
}
|
|
63
|
+
if (raw === "0" || raw.toLowerCase() === "0b" || raw.toLowerCase() === "false") {
|
|
64
|
+
return 0;
|
|
65
|
+
}
|
|
66
|
+
const normalized = normalizeByteSizeString(raw);
|
|
67
|
+
const parsed = bytes_1.default.parse(normalized);
|
|
68
|
+
if (parsed === null || !Number.isFinite(parsed) || parsed < 0) {
|
|
69
|
+
throw new Error(`${label} "${value}" is not a valid byte size (e.g. 10mb, 512kb, 10M)`);
|
|
70
|
+
}
|
|
71
|
+
return parsed;
|
|
72
|
+
}
|
|
73
|
+
/** Safe parse for config/env; returns fallback when value is missing. */
|
|
74
|
+
function parseByteSizeOr(value, fallback, label = "byte size") {
|
|
75
|
+
if (value === null || value === undefined || value === "") {
|
|
76
|
+
return parseByteSize(fallback, label);
|
|
77
|
+
}
|
|
78
|
+
return parseByteSize(value, label);
|
|
79
|
+
}
|
|
80
|
+
//# sourceMappingURL=parse_byte_size.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parse_byte_size.js","sourceRoot":"","sources":["../../src/libs/parse_byte_size.ts"],"names":[],"mappings":";;;;;AAmBA,0DAkBC;AAMD,sCAuBC;AAGD,0CASC;AA9ED,kDAA0B;AAE1B,MAAM,YAAY,GAA2B;IAC5C,CAAC,EAAE,GAAG;IACN,CAAC,EAAE,IAAI;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;IACT,CAAC,EAAE,IAAI;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;IACT,CAAC,EAAE,IAAI;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;IACT,CAAC,EAAE,IAAI;IACP,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,IAAI;CACT,CAAC;AAEF,yEAAyE;AACzE,SAAgB,uBAAuB,CAAC,KAAa;IACpD,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAChE,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IACD,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;IAC5B,IAAI,CAAC,IAAI,EAAE,CAAC;QACX,OAAO,GAAG,CAAC;IACZ,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAChD,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,OAAO,OAAO,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IACD,OAAO,GAAG,GAAG,GAAG,MAAM,EAAE,CAAC;AAC1B,CAAC;AAED;;;GAGG;AACH,SAAgB,aAAa,CAAC,KAAyC,EAAE,KAAK,GAAG,WAAW;IAC3F,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC3C,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,cAAc,CAAC,CAAC;IACzC,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,gCAAgC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IACD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC;IACjC,IAAI,CAAC,GAAG,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,GAAG,KAAK,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,IAAI,GAAG,CAAC,WAAW,EAAE,KAAK,OAAO,EAAE,CAAC;QAChF,OAAO,CAAC,CAAC;IACV,CAAC;IACD,MAAM,UAAU,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,eAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACvC,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,KAAK,oDAAoD,CAAC,CAAC;IACzF,CAAC;IACD,OAAO,MAAM,CAAC;AACf,CAAC;AAED,yEAAyE;AACzE,SAAgB,eAAe,CAC9B,KAAyC,EACzC,QAAyB,EACzB,KAAK,GAAG,WAAW;IAEnB,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;QAC3D,OAAO,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACpC,CAAC"}
|
|
@@ -2,6 +2,9 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
const errors = require("restify-errors");
|
|
4
4
|
const { logRequestError } = require("./request_log");
|
|
5
|
+
const { parseByteSize } = require("./parse_byte_size");
|
|
6
|
+
const DEFAULT_MAX_RESPONSE_SIZE = "10mb";
|
|
7
|
+
const DEFAULT_MAX_RESPONSE_BYTES = parseByteSize(DEFAULT_MAX_RESPONSE_SIZE, "query_limits.max_response_size");
|
|
5
8
|
const DEFAULTS = {
|
|
6
9
|
enabled: true,
|
|
7
10
|
large_collection_threshold: 10000,
|
|
@@ -10,53 +13,97 @@ const DEFAULTS = {
|
|
|
10
13
|
require_limit_always: true,
|
|
11
14
|
skip_count_unless_paginated: true,
|
|
12
15
|
};
|
|
16
|
+
function resolveMaxResponseBytes(limits) {
|
|
17
|
+
const raw = limits.max_response_size ?? limits.max_response_bytes ?? DEFAULT_MAX_RESPONSE_SIZE;
|
|
18
|
+
try {
|
|
19
|
+
return parseByteSize(raw, "query_limits.max_response_size");
|
|
20
|
+
}
|
|
21
|
+
catch (err) {
|
|
22
|
+
const message = err instanceof Error ? err.message : String(err);
|
|
23
|
+
throw new errors.BadRequestError(message);
|
|
24
|
+
}
|
|
25
|
+
}
|
|
13
26
|
function getLimits(req) {
|
|
14
27
|
const limits = Object.assign({}, DEFAULTS, req.config?.query_limits);
|
|
15
28
|
const modelLimits = req.Model?.schema?.opts?.query_limits;
|
|
16
29
|
if (modelLimits && typeof modelLimits === "object") {
|
|
17
30
|
Object.assign(limits, modelLimits);
|
|
18
31
|
}
|
|
32
|
+
limits.max_response_bytes = resolveMaxResponseBytes(limits);
|
|
19
33
|
return limits;
|
|
20
34
|
}
|
|
21
35
|
function parseRequestedLimit(req) {
|
|
22
36
|
const n = parseInt(String(req.query.limit ?? ""), 10);
|
|
23
37
|
return Number.isFinite(n) && n > 0 ? n : null;
|
|
24
38
|
}
|
|
25
|
-
function
|
|
39
|
+
function hasMeaningfulFilter(filter) {
|
|
40
|
+
if (filter == null || filter === "") {
|
|
41
|
+
return false;
|
|
42
|
+
}
|
|
43
|
+
if (typeof filter === "object" && !Array.isArray(filter)) {
|
|
44
|
+
return Object.keys(filter).length > 0;
|
|
45
|
+
}
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
/** GET ?filter= or non-empty POST /query body query */
|
|
49
|
+
function hasClientFilter(req, bodyQuery) {
|
|
50
|
+
if (hasMeaningfulFilter(bodyQuery)) {
|
|
51
|
+
return true;
|
|
52
|
+
}
|
|
53
|
+
return hasMeaningfulFilter(req.query?.filter);
|
|
54
|
+
}
|
|
55
|
+
function shouldRunCount(req, opts = {}) {
|
|
26
56
|
const limits = getLimits(req);
|
|
27
57
|
if (limits.skip_count_unless_paginated === false)
|
|
28
58
|
return true;
|
|
29
59
|
if (req.query.count === "true" || req.query.count === true)
|
|
30
60
|
return true;
|
|
31
61
|
const page = parseInt(String(req.query.page ?? ""), 10);
|
|
32
|
-
|
|
62
|
+
if (Number.isFinite(page) && page > 0)
|
|
63
|
+
return true;
|
|
64
|
+
if (opts.filterExemption || opts.limitCapped)
|
|
65
|
+
return true;
|
|
66
|
+
return false;
|
|
33
67
|
}
|
|
34
|
-
function enforceListLimit(req, estimatedCount, res) {
|
|
68
|
+
function enforceListLimit(req, estimatedCount, res, opts = {}) {
|
|
35
69
|
const limits = getLimits(req);
|
|
70
|
+
const result = opts.result;
|
|
71
|
+
const hasFilter = hasClientFilter(req, opts.bodyQuery);
|
|
36
72
|
if (limits.enabled === false) {
|
|
37
|
-
return parseRequestedLimit(req);
|
|
73
|
+
return { limit: parseRequestedLimit(req), limitCapped: false, filterExemption: false };
|
|
38
74
|
}
|
|
39
75
|
const requested = parseRequestedLimit(req);
|
|
40
76
|
const isLarge = estimatedCount >= limits.large_collection_threshold;
|
|
41
77
|
const sizeHint = `~${estimatedCount} docs threshold=${limits.large_collection_threshold}`;
|
|
42
|
-
|
|
78
|
+
let limitCapped = false;
|
|
79
|
+
let filterExemption = false;
|
|
80
|
+
if (isLarge && !requested && limits.require_limit_always !== false && !hasFilter) {
|
|
43
81
|
const err = new errors.BadRequestError(`Collection "${req.modelname}" has ~${estimatedCount} documents. ` +
|
|
44
82
|
`Use ?limit=1..${limits.max} (required). For totals use GET /count/${req.modelname}.`);
|
|
45
83
|
logRequestError(req, res, err, "query_limit", sizeHint);
|
|
46
84
|
throw err;
|
|
47
85
|
}
|
|
86
|
+
if (isLarge && !requested && hasFilter) {
|
|
87
|
+
filterExemption = true;
|
|
88
|
+
}
|
|
89
|
+
let effectiveLimit;
|
|
48
90
|
if (requested && requested > limits.max) {
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
91
|
+
effectiveLimit = limits.max;
|
|
92
|
+
limitCapped = true;
|
|
93
|
+
if (result) {
|
|
94
|
+
result.limit_capped = true;
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
else if (requested) {
|
|
98
|
+
effectiveLimit = requested;
|
|
52
99
|
}
|
|
53
|
-
if (
|
|
54
|
-
|
|
100
|
+
else if (limits.require_limit_always !== false && limits.default) {
|
|
101
|
+
effectiveLimit = limits.default;
|
|
55
102
|
}
|
|
56
|
-
|
|
57
|
-
|
|
103
|
+
else {
|
|
104
|
+
effectiveLimit = null;
|
|
58
105
|
}
|
|
59
|
-
return
|
|
106
|
+
return { limit: effectiveLimit, limitCapped, filterExemption };
|
|
60
107
|
}
|
|
61
108
|
function applyListPagination(q, result, req, limit, count, changeUrlParams) {
|
|
62
109
|
if (!limit) {
|
|
@@ -79,12 +126,51 @@ function applyListPagination(q, result, req, limit, count, changeUrlParams) {
|
|
|
79
126
|
q.skip(limit * (page - 1));
|
|
80
127
|
}
|
|
81
128
|
}
|
|
129
|
+
function finalizeListPagination(result, req, dataLength, limit, count, changeUrlParams) {
|
|
130
|
+
if (!limit || dataLength !== limit) {
|
|
131
|
+
return;
|
|
132
|
+
}
|
|
133
|
+
const page = typeof result.page === "number" ? result.page : 1;
|
|
134
|
+
if (count >= 0) {
|
|
135
|
+
const page_count = Math.ceil(count / limit);
|
|
136
|
+
if (page < page_count && !result.next) {
|
|
137
|
+
result.next = changeUrlParams(req, "page", page + 1);
|
|
138
|
+
}
|
|
139
|
+
return;
|
|
140
|
+
}
|
|
141
|
+
result.has_more = true;
|
|
142
|
+
if (!result.next) {
|
|
143
|
+
result.next = changeUrlParams(req, "page", page + 1);
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
function responseByteSize(payload) {
|
|
147
|
+
return Buffer.byteLength(JSON.stringify(payload), "utf8");
|
|
148
|
+
}
|
|
149
|
+
function enforceResponseSize(result, req, res) {
|
|
150
|
+
const limits = getLimits(req);
|
|
151
|
+
const maxBytes = limits.max_response_bytes;
|
|
152
|
+
if (!maxBytes || maxBytes <= 0) {
|
|
153
|
+
return;
|
|
154
|
+
}
|
|
155
|
+
const size = responseByteSize(result);
|
|
156
|
+
if (size > maxBytes) {
|
|
157
|
+
const err = new errors.PayloadTooLargeError(`Response size ${size} bytes exceeds maximum ${maxBytes} bytes for "${req.modelname}". ` +
|
|
158
|
+
`Reduce ?limit=, use ?fields=, or paginate.`);
|
|
159
|
+
logRequestError(req, res, err, "response_size", `${size}B max=${maxBytes}B`);
|
|
160
|
+
throw err;
|
|
161
|
+
}
|
|
162
|
+
}
|
|
82
163
|
module.exports = {
|
|
83
164
|
getLimits,
|
|
84
165
|
parseRequestedLimit,
|
|
166
|
+
hasClientFilter,
|
|
167
|
+
hasMeaningfulFilter,
|
|
85
168
|
shouldRunCount,
|
|
86
169
|
enforceListLimit,
|
|
87
170
|
applyListPagination,
|
|
171
|
+
finalizeListPagination,
|
|
172
|
+
enforceResponseSize,
|
|
173
|
+
responseByteSize,
|
|
88
174
|
DEFAULTS,
|
|
89
175
|
};
|
|
90
176
|
//# sourceMappingURL=query_limits.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query_limits.js","sourceRoot":"","sources":["../../src/libs/query_limits.ts"],"names":[],"mappings":";;AAAA,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACzC,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"query_limits.js","sourceRoot":"","sources":["../../src/libs/query_limits.ts"],"names":[],"mappings":";;AAAA,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AACzC,MAAM,EAAE,eAAe,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;AACrD,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAuBvD,MAAM,yBAAyB,GAAG,MAAM,CAAC;AACzC,MAAM,0BAA0B,GAAG,aAAa,CAAC,yBAAyB,EAAE,gCAAgC,CAAC,CAAC;AAE9G,MAAM,QAAQ,GAAwE;IACrF,OAAO,EAAE,IAAI;IACb,0BAA0B,EAAE,KAAK;IACjC,GAAG,EAAE,IAAI;IACT,OAAO,EAAE,GAAG;IACZ,oBAAoB,EAAE,IAAI;IAC1B,2BAA2B,EAAE,IAAI;CACjC,CAAC;AAEF,SAAS,uBAAuB,CAAC,MAA+B;IAC/D,MAAM,GAAG,GAAG,MAAM,CAAC,iBAAiB,IAAI,MAAM,CAAC,kBAAkB,IAAI,yBAAyB,CAAC;IAC/F,IAAI,CAAC;QACJ,OAAO,aAAa,CAAC,GAAsB,EAAE,gCAAgC,CAAC,CAAC;IAChF,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,OAAO,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACjE,MAAM,IAAI,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;AACF,CAAC;AAED,SAAS,SAAS,CAAC,GAAG;IACrB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAgD,CAAC;IACpH,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC;IAC1D,IAAI,WAAW,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,kBAAkB,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC;AACf,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAG;IAC/B,MAAM,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC/C,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAM;IAClC,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,KAAK,EAAE,EAAE,CAAC;QACrC,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1D,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,IAAI,CAAC;AACb,CAAC;AAED,uDAAuD;AACvD,SAAS,eAAe,CAAC,GAAG,EAAE,SAAU;IACvC,IAAI,mBAAmB,CAAC,SAAS,CAAC,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC;IACb,CAAC;IACD,OAAO,mBAAmB,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,cAAc,CAAC,GAAG,EAAE,OAAkB,EAAE;IAChD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,MAAM,CAAC,2BAA2B,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IAC9D,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACxE,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACxD,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACnD,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,WAAW;QAAE,OAAO,IAAI,CAAC;IAC1D,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,gBAAgB,CAAC,GAAG,EAAE,cAAc,EAAE,GAAI,EAAE,OAAkB,EAAE;IACxE,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;IAC3B,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAEvD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;QAC9B,OAAO,EAAE,KAAK,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;IACxF,CAAC;IAED,MAAM,SAAS,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,cAAc,IAAI,MAAM,CAAC,0BAA0B,CAAC;IACpE,MAAM,QAAQ,GAAG,IAAI,cAAc,mBAAmB,MAAM,CAAC,0BAA0B,EAAE,CAAC;IAC1F,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,IAAI,OAAO,IAAI,CAAC,SAAS,IAAI,MAAM,CAAC,oBAAoB,KAAK,KAAK,IAAI,CAAC,SAAS,EAAE,CAAC;QAClF,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,eAAe,CACrC,eAAe,GAAG,CAAC,SAAS,UAAU,cAAc,cAAc;YACjE,iBAAiB,MAAM,CAAC,GAAG,0CAA0C,GAAG,CAAC,SAAS,GAAG,CACtF,CAAC;QACF,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;QACxD,MAAM,GAAG,CAAC;IACX,CAAC;IAED,IAAI,OAAO,IAAI,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC;QACxC,eAAe,GAAG,IAAI,CAAC;IACxB,CAAC;IAED,IAAI,cAAc,CAAC;IACnB,IAAI,SAAS,IAAI,SAAS,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC;QACzC,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC;QAC5B,WAAW,GAAG,IAAI,CAAC;QACnB,IAAI,MAAM,EAAE,CAAC;YACZ,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,CAAC;IACF,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACtB,cAAc,GAAG,SAAS,CAAC;IAC5B,CAAC;SAAM,IAAI,MAAM,CAAC,oBAAoB,KAAK,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACpE,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC;IACjC,CAAC;SAAM,CAAC;QACP,cAAc,GAAG,IAAI,CAAC;IACvB,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;AAChE,CAAC;AAED,SAAS,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe;IACzE,IAAI,CAAC,KAAK,EAAE,CAAC;QACZ,OAAO;IACR,CAAC;IACD,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACf,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,MAAM,UAAU,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAChE,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;QACzB,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;IAChC,CAAC;IACD,IAAI,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACtD,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACvB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,IAAI,UAAU,KAAK,IAAI,IAAI,IAAI,GAAG,UAAU,EAAE,CAAC;QAC9C,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACd,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QACrD,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;IAC5B,CAAC;AACF,CAAC;AAED,SAAS,sBAAsB,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK,EAAE,eAAe;IACrF,IAAI,CAAC,KAAK,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;QACpC,OAAO;IACR,CAAC;IACD,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAChB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,CAAC;QAC5C,IAAI,IAAI,GAAG,UAAU,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,OAAO;IACR,CAAC;IACD,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC;IACtD,CAAC;AACF,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAO;IAChC,OAAO,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAM,EAAE,GAAG,EAAE,GAAI;IAC7C,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,kBAAkB,CAAC;IAC3C,IAAI,CAAC,QAAQ,IAAI,QAAQ,IAAI,CAAC,EAAE,CAAC;QAChC,OAAO;IACR,CAAC;IACD,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;QACrB,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,oBAAoB,CAC1C,iBAAiB,IAAI,0BAA0B,QAAQ,eAAe,GAAG,CAAC,SAAS,KAAK;YACvF,4CAA4C,CAC7C,CAAC;QACF,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,IAAI,SAAS,QAAQ,GAAG,CAAC,CAAC;QAC7E,MAAM,GAAG,CAAC;IACX,CAAC;AACF,CAAC;AAED,MAAM,CAAC,OAAO,GAAG;IAChB,SAAS;IACT,mBAAmB;IACnB,eAAe;IACf,mBAAmB;IACnB,cAAc;IACd,gBAAgB;IAChB,mBAAmB;IACnB,sBAAsB;IACtB,mBAAmB;IACnB,gBAAgB;IAChB,QAAQ;CACR,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { JXPConfig, JXPRequest, JXPResponse } from "../types/jxp-config";
|
|
2
|
+
import type { Model } from "mongoose";
|
|
3
|
+
export declare function parseFilter(filter: unknown, depth?: number): Record<string, unknown>;
|
|
4
|
+
export declare function getOneDocument(Model: Model<unknown>, item_id: string, params: Record<string, unknown>, options: {
|
|
5
|
+
user?: JXPResponse["user"];
|
|
6
|
+
}): Promise<any>;
|
|
7
|
+
export declare function executeList(req: JXPRequest, res: JXPResponse): Promise<void>;
|
|
8
|
+
export declare function executeGetOne(req: JXPRequest, res: JXPResponse): Promise<void>;
|
|
9
|
+
export declare function executeCount(req: JXPRequest, res: JXPResponse): Promise<void>;
|
|
10
|
+
export declare function resultToCsv(result: Record<string, unknown>): string;
|
|
11
|
+
export declare function buildSyntheticRequest(config: JXPConfig, modelname: string, Model: Model<unknown>, query: Record<string, unknown>, params?: Record<string, string>): JXPRequest;
|
|
12
|
+
export declare function buildSyntheticResponse(user: JXPResponse["user"], groups: string[]): JXPResponse;
|
|
13
|
+
//# sourceMappingURL=read_handlers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"read_handlers.d.ts","sourceRoot":"","sources":["../../src/libs/read_handlers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAC9E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAiCtC,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,SAAI,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAmG/E;AAED,wBAAsB,cAAc,CACnC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EACrB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CAAE,gBAmCvC;AAED,wBAAsB,WAAW,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAqHlF;AAED,wBAAsB,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CASpF;AAED,wBAAsB,YAAY,CAAC,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBnF;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAOnE;AAED,wBAAgB,qBAAqB,CACpC,MAAM,EAAE,SAAS,EACjB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,EACrB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,GACjC,UAAU,CAWZ;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,WAAW,CAe/F"}
|