@kollors/deep-json-server 1.0.0-beta.1 → 1.0.0-beta.3
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 +17 -6
- package/README.ru.md +17 -6
- package/dist/src/auth/password.js +1 -1
- package/dist/src/auth/password.js.map +1 -1
- package/dist/src/auth/service.d.ts +1 -1
- package/dist/src/auth/service.js +2 -2
- package/dist/src/auth/service.js.map +1 -1
- package/dist/src/cli/index.js +8 -2
- package/dist/src/cli/index.js.map +1 -1
- package/dist/src/core/constants.d.ts +1 -1
- package/dist/src/core/constants.js +1 -1
- package/dist/src/core/database.d.ts +4 -4
- package/dist/src/core/database.js +15 -12
- package/dist/src/core/database.js.map +1 -1
- package/dist/src/core/engine.d.ts +3 -1
- package/dist/src/core/engine.js +33 -24
- package/dist/src/core/engine.js.map +1 -1
- package/dist/src/core/lifecycle/mutation.d.ts +4 -4
- package/dist/src/core/lifecycle/mutation.js +36 -11
- package/dist/src/core/lifecycle/mutation.js.map +1 -1
- package/dist/src/core/lifecycle/options.d.ts +2 -2
- package/dist/src/core/lifecycle/options.js.map +1 -1
- package/dist/src/core/model/infer.d.ts +7 -0
- package/dist/src/core/model/infer.js +88 -0
- package/dist/src/core/model/infer.js.map +1 -0
- package/dist/src/core/model/load.d.ts +9 -0
- package/dist/src/core/model/load.js +215 -0
- package/dist/src/core/model/load.js.map +1 -0
- package/dist/src/core/model/policy.d.ts +15 -0
- package/dist/src/core/model/policy.js +29 -0
- package/dist/src/core/model/policy.js.map +1 -0
- package/dist/src/core/model/tree.d.ts +68 -0
- package/dist/src/core/model/tree.js +168 -0
- package/dist/src/core/model/tree.js.map +1 -0
- package/dist/src/core/model/types.d.ts +83 -0
- package/dist/src/core/model/types.js +2 -0
- package/dist/src/core/model/types.js.map +1 -0
- package/dist/src/core/model/validation.d.ts +24 -0
- package/dist/src/core/model/validation.js +96 -0
- package/dist/src/core/model/validation.js.map +1 -0
- package/dist/src/core/model.d.ts +6 -146
- package/dist/src/core/model.js +6 -520
- package/dist/src/core/model.js.map +1 -1
- package/dist/src/core/mutations/write.d.ts +33 -0
- package/dist/src/core/mutations/write.js +46 -12
- package/dist/src/core/mutations/write.js.map +1 -1
- package/dist/src/core/paths.d.ts +0 -8
- package/dist/src/core/paths.js +3 -19
- package/dist/src/core/paths.js.map +1 -1
- package/dist/src/core/query/execute.js +2 -2
- package/dist/src/core/query/execute.js.map +1 -1
- package/dist/src/core/query/filter.js +1 -1
- package/dist/src/core/query/filter.js.map +1 -1
- package/dist/src/core/query/options.js +1 -1
- package/dist/src/core/query/options.js.map +1 -1
- package/dist/src/core/records.js +5 -4
- package/dist/src/core/records.js.map +1 -1
- package/dist/src/core/relation-metadata.js +1 -1
- package/dist/src/core/relation-metadata.js.map +1 -1
- package/dist/src/core/snapshot.d.ts +10 -0
- package/dist/src/core/snapshot.js +15 -0
- package/dist/src/core/snapshot.js.map +1 -0
- package/dist/src/core/types.d.ts +5 -0
- package/dist/src/core/utils.d.ts +4 -0
- package/dist/src/core/utils.js +8 -0
- package/dist/src/core/utils.js.map +1 -1
- package/dist/src/files/contract.js +3 -1
- package/dist/src/files/contract.js.map +1 -1
- package/dist/src/graphql/preflight.js +2 -1
- package/dist/src/graphql/preflight.js.map +1 -1
- package/dist/src/graphql/resolvers.js +6 -3
- package/dist/src/graphql/resolvers.js.map +1 -1
- package/dist/src/graphql/schema.js +3 -3
- package/dist/src/graphql/schema.js.map +1 -1
- package/dist/src/openapi/document.js +9 -9
- package/dist/src/openapi/document.js.map +1 -1
- package/dist/src/rest/options.d.ts +2 -2
- package/dist/src/rest/options.js +3 -3
- package/dist/src/rest/options.js.map +1 -1
- package/dist/src/rest/projection.d.ts +6 -3
- package/dist/src/rest/projection.js +17 -8
- package/dist/src/rest/projection.js.map +1 -1
- package/dist/src/rest/routes.js +6 -6
- package/dist/src/rest/routes.js.map +1 -1
- package/dist/src/server/bootstrap.js +1 -1
- package/dist/src/server/bootstrap.js.map +1 -1
- package/dist/src/server/config.d.ts +10 -6
- package/dist/src/server/config.js +39 -37
- package/dist/src/server/config.js.map +1 -1
- package/dist/src/server/http.d.ts +1 -1
- package/dist/src/server/http.js +1 -1
- package/dist/src/server/input-paths.d.ts +8 -0
- package/dist/src/server/input-paths.js +19 -0
- package/dist/src/server/input-paths.js.map +1 -0
- package/package.json +2 -2
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { Ajv } from 'ajv';
|
|
2
|
+
import { type InputMode } from './policy.js';
|
|
3
|
+
import type { Entity, Node, ValidationSchema } from './types.js';
|
|
4
|
+
/** Создаёт независимый валидатор JSON Schema с форматами и строгой проверкой без преобразования данных.
|
|
5
|
+
* @example createValidator().validate({ type: 'number' }, '1') → false.
|
|
6
|
+
*/
|
|
7
|
+
export declare const createValidator: () => Ajv;
|
|
8
|
+
export declare const entityValidators: WeakMap<Entity, Ajv>;
|
|
9
|
+
/** Строит схему проверки значения с ограничениями, массивом и допустимостью null.
|
|
10
|
+
* @example Для строкового узла без ограничений valueSchema(node) → { type: 'string' }.
|
|
11
|
+
*/
|
|
12
|
+
export declare function valueSchema(node: Node): ValidationSchema;
|
|
13
|
+
/** Строит схему объекта для выбранного режима; при частичном обновлении корневые поля необязательны.
|
|
14
|
+
* @example Для пустого узла → { type: 'object', properties: {}, additionalProperties: false }.
|
|
15
|
+
*/
|
|
16
|
+
export declare function objectSchema(node: Node, mode: InputMode, root?: boolean, relationSchema?: (node: Node) => ValidationSchema): ValidationSchema;
|
|
17
|
+
/** Описывает ввод связанной записи: первичный ключ или объект, при необходимости — массив таких значений.
|
|
18
|
+
* @example Связь со строковым ключом → anyOf для строки и объекта; many: true → массив.
|
|
19
|
+
*/
|
|
20
|
+
export declare function relationInputSchema(node: Node, object?: ValidationSchema): ValidationSchema;
|
|
21
|
+
/** Проверяет запись по схеме выбранного режима и выбрасывает исключение при несоответствии.
|
|
22
|
+
* @example Обязательное строковое name: { name: 'Анна' } → undefined; { name: 2 } → ошибка.
|
|
23
|
+
*/
|
|
24
|
+
export declare function validateRecord(entity: Entity, value: unknown, mode: InputMode, relations?: boolean): void;
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import { Ajv } from 'ajv';
|
|
2
|
+
import addFormats from 'ajv-formats';
|
|
3
|
+
import { domainError } from '../errors.js';
|
|
4
|
+
import { AUDIT_FIELDS } from '../lifecycle/options.js';
|
|
5
|
+
import { requiredInput, writable } from './policy.js';
|
|
6
|
+
import { fieldAt, requireRelation } from './tree.js';
|
|
7
|
+
/** Создаёт независимый валидатор JSON Schema с форматами и строгой проверкой без преобразования данных.
|
|
8
|
+
* @example createValidator().validate({ type: 'number' }, '1') → false.
|
|
9
|
+
*/
|
|
10
|
+
export const createValidator = () => {
|
|
11
|
+
const ajv = new Ajv({ allErrors: true, coerceTypes: false, removeAdditional: false, strict: true, ownProperties: true });
|
|
12
|
+
addFormats.default(ajv);
|
|
13
|
+
return ajv;
|
|
14
|
+
};
|
|
15
|
+
export const entityValidators = new WeakMap();
|
|
16
|
+
/** Строит схему проверки значения с ограничениями, массивом и допустимостью null.
|
|
17
|
+
* @example Для строкового узла без ограничений valueSchema(node) → { type: 'string' }.
|
|
18
|
+
*/
|
|
19
|
+
export function valueSchema(node) {
|
|
20
|
+
let schema = node.base === 'object' ? objectSchema(node, 'stored') : { type: node.base };
|
|
21
|
+
for (const key of ['minLength', 'maxLength', 'pattern', 'format', 'minimum', 'maximum', 'enum'])
|
|
22
|
+
if (node[key] !== undefined)
|
|
23
|
+
schema[key] = node[key];
|
|
24
|
+
if (node.many)
|
|
25
|
+
schema = { type: 'array', items: schema };
|
|
26
|
+
if (node.nullable)
|
|
27
|
+
schema = { anyOf: [schema, { type: 'null' }] };
|
|
28
|
+
return schema;
|
|
29
|
+
}
|
|
30
|
+
/** Строит схему объекта для выбранного режима; при частичном обновлении корневые поля необязательны.
|
|
31
|
+
* @example Для пустого узла → { type: 'object', properties: {}, additionalProperties: false }.
|
|
32
|
+
*/
|
|
33
|
+
export function objectSchema(node, mode, root = false, relationSchema) {
|
|
34
|
+
const properties = {};
|
|
35
|
+
const required = [];
|
|
36
|
+
for (const [key, child] of Object.entries(node.children)) {
|
|
37
|
+
if (child.virtual)
|
|
38
|
+
continue;
|
|
39
|
+
if (child.relation) {
|
|
40
|
+
if (mode !== 'stored' && relationSchema)
|
|
41
|
+
properties[key] = relationSchema(child);
|
|
42
|
+
continue;
|
|
43
|
+
}
|
|
44
|
+
if (mode !== 'stored' && !writable(child, mode, !!relationSchema))
|
|
45
|
+
continue;
|
|
46
|
+
properties[key] =
|
|
47
|
+
child.base === 'object'
|
|
48
|
+
? (() => {
|
|
49
|
+
let s = objectSchema(child, mode, false, relationSchema);
|
|
50
|
+
if (child.many)
|
|
51
|
+
s = { type: 'array', items: s };
|
|
52
|
+
return child.nullable ? { anyOf: [s, { type: 'null' }] } : s;
|
|
53
|
+
})()
|
|
54
|
+
: valueSchema(child);
|
|
55
|
+
if (requiredInput(child, mode, root, !!relationSchema))
|
|
56
|
+
required.push(key);
|
|
57
|
+
}
|
|
58
|
+
// Сохраняем ранее записанные даты и авторов при отключении соответствующих флагов.
|
|
59
|
+
if (root && mode === 'stored')
|
|
60
|
+
for (const name of AUDIT_FIELDS)
|
|
61
|
+
properties[name] ??= { type: ['string', 'null'], ...(name.endsWith('At') ? { format: 'date-time' } : {}) };
|
|
62
|
+
return { type: 'object', properties, additionalProperties: false, ...(required.length ? { required } : {}) };
|
|
63
|
+
}
|
|
64
|
+
/** Описывает ввод связанной записи: первичный ключ или объект, при необходимости — массив таких значений.
|
|
65
|
+
* @example Связь со строковым ключом → anyOf для строки и объекта; many: true → массив.
|
|
66
|
+
*/
|
|
67
|
+
export function relationInputSchema(node, object = { type: 'object' }) {
|
|
68
|
+
const target = requireRelation(node).relation;
|
|
69
|
+
let schema = { anyOf: [valueSchema(fieldAt(target, target.primary)), object] };
|
|
70
|
+
if (node.many)
|
|
71
|
+
schema = { type: 'array', items: schema };
|
|
72
|
+
else if (node.nullable)
|
|
73
|
+
schema = { anyOf: [schema, { type: 'null' }] };
|
|
74
|
+
return schema;
|
|
75
|
+
}
|
|
76
|
+
const validators = new WeakMap();
|
|
77
|
+
/** Проверяет запись по схеме выбранного режима и выбрасывает исключение при несоответствии.
|
|
78
|
+
* @example Обязательное строковое name: { name: 'Анна' } → undefined; { name: 2 } → ошибка.
|
|
79
|
+
*/
|
|
80
|
+
export function validateRecord(entity, value, mode, relations = false) {
|
|
81
|
+
const ajv = entityValidators.get(entity);
|
|
82
|
+
let cache = validators.get(entity);
|
|
83
|
+
if (!cache) {
|
|
84
|
+
cache = new Map();
|
|
85
|
+
validators.set(entity, cache);
|
|
86
|
+
}
|
|
87
|
+
const key = `${mode}:${relations}`;
|
|
88
|
+
let validate = cache.get(key);
|
|
89
|
+
if (!validate) {
|
|
90
|
+
validate = ajv.compile(objectSchema(entity.root, mode, true, relations ? (node) => relationInputSchema(node) : undefined));
|
|
91
|
+
cache.set(key, validate);
|
|
92
|
+
}
|
|
93
|
+
if (!validate(value))
|
|
94
|
+
throw domainError('INVALID_INPUT', `${entity.name}: ${ajv.errorsText(validate.errors)}`);
|
|
95
|
+
}
|
|
96
|
+
//# sourceMappingURL=validation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../../../src/core/model/validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAyB,MAAM,KAAK,CAAC;AACjD,OAAO,UAAU,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAkB,aAAa,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAErD;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE;IAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,gBAAgB,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACzH,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACxB,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,OAAO,EAAe,CAAC;AAC3D;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,IAAU;IACpC,IAAI,MAAM,GAAqB,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC3G,KAAK,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC;QAAE,IAAI,IAAI,CAAC,GAAiB,CAAC,KAAK,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAiB,CAAC,CAAC;IAClL,IAAI,IAAI,CAAC,IAAI;QAAE,MAAM,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACzD,IAAI,IAAI,CAAC,QAAQ;QAAE,MAAM,GAAG,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAClE,OAAO,MAAM,CAAC;AAChB,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAU,EAAE,IAAe,EAAE,IAAI,GAAG,KAAK,EAAE,cAAiD;IACvH,MAAM,UAAU,GAAqC,EAAE,CAAC;IACxD,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACzD,IAAI,KAAK,CAAC,OAAO;YAAE,SAAS;QAC5B,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,IAAI,KAAK,QAAQ,IAAI,cAAc;gBAAE,UAAU,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;YACjF,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,CAAC;YAAE,SAAS;QAC5E,UAAU,CAAC,GAAG,CAAC;YACb,KAAK,CAAC,IAAI,KAAK,QAAQ;gBACrB,CAAC,CAAC,CAAC,GAAG,EAAE;oBACJ,IAAI,CAAC,GAAqB,YAAY,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;oBAC3E,IAAI,KAAK,CAAC,IAAI;wBAAE,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;oBAChD,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC/D,CAAC,CAAC,EAAE;gBACN,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QACzB,IAAI,aAAa,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,cAAc,CAAC;YAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7E,CAAC;IACD,mFAAmF;IACnF,IAAI,IAAI,IAAI,IAAI,KAAK,QAAQ;QAAE,KAAK,MAAM,IAAI,IAAI,YAAY;YAAE,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;IAC3K,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,oBAAoB,EAAE,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AAC/G,CAAC;AACD;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAU,EAAE,MAAM,GAAqB,EAAE,IAAI,EAAE,QAAQ,EAAE;IAC3F,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC;IAC9C,IAAI,MAAM,GAAqB,EAAE,KAAK,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC;IACjG,IAAI,IAAI,CAAC,IAAI;QAAE,MAAM,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;SACpD,IAAI,IAAI,CAAC,QAAQ;QAAE,MAAM,GAAG,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACvE,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,MAAM,UAAU,GAAG,IAAI,OAAO,EAAyC,CAAC;AACxE;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,KAAc,EAAE,IAAe,EAAE,SAAS,GAAG,KAAK;IAC/F,MAAM,GAAG,GAAG,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAQ,CAAC;IAChD,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;QAClB,UAAU,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,SAAS,EAAE,CAAC;IACnC,IAAI,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3H,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC3B,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,MAAM,WAAW,CAAC,eAAe,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;AACjH,CAAC"}
|
package/dist/src/core/model.d.ts
CHANGED
|
@@ -1,146 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
export
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
example?: JsonValue;
|
|
8
|
-
required?: boolean;
|
|
9
|
-
nullable?: boolean;
|
|
10
|
-
default?: JsonValue;
|
|
11
|
-
enum?: JsonValue[];
|
|
12
|
-
primary?: boolean;
|
|
13
|
-
generated?: 'uuid' | 'increment';
|
|
14
|
-
readOnly?: boolean;
|
|
15
|
-
writeOnly?: boolean;
|
|
16
|
-
minLength?: number;
|
|
17
|
-
maxLength?: number;
|
|
18
|
-
pattern?: string;
|
|
19
|
-
format?: 'date' | 'date-time' | 'email' | 'uri' | 'uuid';
|
|
20
|
-
minimum?: number;
|
|
21
|
-
maximum?: number;
|
|
22
|
-
source?: string;
|
|
23
|
-
target?: string;
|
|
24
|
-
onDelete?: 'restrict' | 'cascade';
|
|
25
|
-
}
|
|
26
|
-
export interface EntityDefinition {
|
|
27
|
-
timestamps?: boolean;
|
|
28
|
-
softDelete?: boolean;
|
|
29
|
-
collection: string;
|
|
30
|
-
api?: ('openapi' | 'graphql')[];
|
|
31
|
-
fields: Record<string, Field>;
|
|
32
|
-
}
|
|
33
|
-
export type ApiFormat = 'openapi' | 'graphql';
|
|
34
|
-
export interface ModelSchema {
|
|
35
|
-
models: Record<string, EntityDefinition>;
|
|
36
|
-
api?: ApiFormat[];
|
|
37
|
-
timestamps?: boolean;
|
|
38
|
-
softDelete?: boolean;
|
|
39
|
-
}
|
|
40
|
-
export interface ModelOptions {
|
|
41
|
-
auth?: boolean;
|
|
42
|
-
api?: ApiFormat[];
|
|
43
|
-
}
|
|
44
|
-
/** Проверяет список форматов и возвращает его независимую копию.
|
|
45
|
-
* @example apiFormats(['graphql']) → ['graphql']; ['unknown'] → ошибка.
|
|
46
|
-
*/
|
|
47
|
-
export declare function apiFormats(value: unknown, fallback: ApiFormat[], label: string): ApiFormat[];
|
|
48
|
-
export interface Node extends Field {
|
|
49
|
-
system?: boolean;
|
|
50
|
-
internal?: boolean;
|
|
51
|
-
virtual?: 'actions';
|
|
52
|
-
softDelete?: boolean;
|
|
53
|
-
path: string;
|
|
54
|
-
base: string;
|
|
55
|
-
many: boolean;
|
|
56
|
-
children: Record<string, Node>;
|
|
57
|
-
relation?: Entity;
|
|
58
|
-
implicit?: boolean;
|
|
59
|
-
mixed?: boolean;
|
|
60
|
-
relationKey?: boolean;
|
|
61
|
-
}
|
|
62
|
-
export interface Entity {
|
|
63
|
-
timestamps: boolean;
|
|
64
|
-
softDelete: boolean;
|
|
65
|
-
name: string;
|
|
66
|
-
collection: string;
|
|
67
|
-
api: ('openapi' | 'graphql')[];
|
|
68
|
-
primary: string;
|
|
69
|
-
fields: Record<string, Node>;
|
|
70
|
-
root: Node;
|
|
71
|
-
}
|
|
72
|
-
export interface Model {
|
|
73
|
-
options: Required<RecordOptions>;
|
|
74
|
-
entities: Entity[];
|
|
75
|
-
byName: Map<string, Entity>;
|
|
76
|
-
byCollection: Map<string, Entity>;
|
|
77
|
-
explicit: boolean;
|
|
78
|
-
}
|
|
79
|
-
export type ValidationSchema = Record<string, unknown>;
|
|
80
|
-
/** Разбивает путь по точкам и проверяет допустимость каждого имени.
|
|
81
|
-
* @example pathParts('profile.name') → ['profile', 'name']; pathParts('a..b') → ошибка.
|
|
82
|
-
*/
|
|
83
|
-
export declare const pathParts: (path: string) => string[];
|
|
84
|
-
/** Находит самый длинный префикс пути среди ключей объекта, учитывая границы сегментов.
|
|
85
|
-
* @example bindingFor({ a: {}, 'a.b': {} }, 'a.b.id') → 'a.b'; bindingFor({ a: {} }, 'abc.id') → undefined.
|
|
86
|
-
*/
|
|
87
|
-
export declare function bindingFor(bindings: Record<string, unknown>, path: string): string | undefined;
|
|
88
|
-
/** Проверяет, что все сегменты пути объявлены и доступны для записи, включая родительские объекты.
|
|
89
|
-
* @example Для поля name без ограничений canWriteKey(entity, 'name') → true; для первичного ключа → false.
|
|
90
|
-
*/
|
|
91
|
-
export declare function canWriteKey(entity: Entity, path: string): boolean;
|
|
92
|
-
/** Распознаёт обратную связь: источник совпадает с первичным ключом, а целевой путь отличается от первичного ключа цели.
|
|
93
|
-
* @example При source = 'id', target = 'authorId' и первичных ключах id → true.
|
|
94
|
-
*/
|
|
95
|
-
export declare function isReverseRelation(entity: Entity, node: Node): boolean;
|
|
96
|
-
/** Собирает значения по вложенному пути, проходя через массивы; отсутствующие значения и null пропускает.
|
|
97
|
-
* @example readPath({ rows: [{ id: 1 }, { id: 2 }] }, 'rows.id') → [1, 2].
|
|
98
|
-
*/
|
|
99
|
-
export declare const readPath: (value: unknown, path: string | string[]) => unknown[];
|
|
100
|
-
/** Возвращает последний сегмент пути поля.
|
|
101
|
-
* @example childName({ path: 'profile.name', … }) → 'name'.
|
|
102
|
-
*/
|
|
103
|
-
export declare const childName: (node: Node) => string;
|
|
104
|
-
/** Для связи возвращает целевую сущность и её корень; обычный узел сохраняет без изменений.
|
|
105
|
-
* @example canonicalNode(author, { relation: book }) → [book, book.root].
|
|
106
|
-
* @example canonicalNode(author, author.root) → [author, author.root].
|
|
107
|
-
*/
|
|
108
|
-
export declare const canonicalNode: (entity: Entity, node: Node) => [Entity, Node];
|
|
109
|
-
/** Соединяет имя сущности и путь поля, заменяя точки подчёркиваниями.
|
|
110
|
-
* @example nodeName({ name: 'User', … }, { path: 'profile.name', … }) → 'User_profile_name'.
|
|
111
|
-
*/
|
|
112
|
-
export declare const nodeName: (entity: Entity, node: Node) => string;
|
|
113
|
-
/** Переводит первую букву имени сущности в нижний регистр.
|
|
114
|
-
* @example operationName({ name: 'UserProfile', … }) → 'userProfile'.
|
|
115
|
-
*/
|
|
116
|
-
export declare const operationName: (entity: Entity) => string;
|
|
117
|
-
/** Загружает описание из объекта или JSON-файла, проверяет поля и сопоставляет связи.
|
|
118
|
-
* @example loadModel(undefined) → Promise<undefined>; корректное описание → Promise<Model>.
|
|
119
|
-
*/
|
|
120
|
-
export declare function loadModel(source: unknown, settings?: ModelOptions): Promise<Model | undefined>;
|
|
121
|
-
/** Определяет доступность поля для выбранного режима записи, учитывая защищённые дочерние поля.
|
|
122
|
-
* @example writable({ readOnly: true, … }, 'update') → false.
|
|
123
|
-
*/
|
|
124
|
-
export declare function writable(node: Node, mode: InputMode, relations?: boolean): boolean;
|
|
125
|
-
/** Проверяет наличие явной модели и доступность выбранного формата для её связей.
|
|
126
|
-
* @example assertApi(undefined, 'graphql') → ошибка; согласованная модель → undefined.
|
|
127
|
-
*/
|
|
128
|
-
export declare function assertApi(model: Model | undefined, api: 'graphql' | 'openapi'): asserts model is Model;
|
|
129
|
-
/** Строит схему проверки значения с ограничениями, массивом и допустимостью null.
|
|
130
|
-
* @example Для строкового узла без ограничений valueSchema(node) → { type: 'string' }.
|
|
131
|
-
*/
|
|
132
|
-
export declare function valueSchema(node: Node): ValidationSchema;
|
|
133
|
-
export type InputMode = 'stored' | WriteMode;
|
|
134
|
-
/** Строит схему объекта для выбранного режима; при частичном обновлении корневые поля необязательны.
|
|
135
|
-
* @example Для пустого узла → { type: 'object', properties: {}, additionalProperties: false }.
|
|
136
|
-
*/
|
|
137
|
-
export declare function objectSchema(node: Node, mode: InputMode, root?: boolean, relationSchema?: (node: Node) => ValidationSchema): ValidationSchema;
|
|
138
|
-
export declare function relationInputSchema(node: Node, object?: ValidationSchema): ValidationSchema;
|
|
139
|
-
/** Проверяет запись по схеме выбранного режима и выбрасывает исключение при несоответствии.
|
|
140
|
-
* @example Обязательное строковое name: { name: 'Анна' } → undefined; { name: 2 } → ошибка.
|
|
141
|
-
*/
|
|
142
|
-
export declare function validateRecord(entity: Entity, value: unknown, mode: InputMode, relations?: boolean): void;
|
|
143
|
-
/** Выводит поля и связи из значений коллекций, не меняя переданные записи.
|
|
144
|
-
* @example inferModel({ users: [{ id: '1', name: 'Анна' }] }) → модель со строковыми id и name.
|
|
145
|
-
*/
|
|
146
|
-
export declare function inferModel(database: DatabaseData, settings?: RecordOptions): Model;
|
|
1
|
+
export { inferModel } from './model/infer.js';
|
|
2
|
+
export { apiFormats, loadModel } from './model/load.js';
|
|
3
|
+
export { assertApi, type InputMode, requiredInput, writable } from './model/policy.js';
|
|
4
|
+
export { bindingFor, canonicalNode, canWriteKey, childName, fieldAt, isReverseRelation, nodeName, operationName, pathParts, readPath, requireRelation } from './model/tree.js';
|
|
5
|
+
export * from './model/types.js';
|
|
6
|
+
export { objectSchema, relationInputSchema, validateRecord, valueSchema } from './model/validation.js';
|