@feathersjs/schema 5.0.0-pre.17 → 5.0.0-pre.20
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/CHANGELOG.md +45 -0
- package/README.md +1 -0
- package/lib/hooks.d.ts +3 -3
- package/lib/hooks.js +21 -14
- package/lib/hooks.js.map +1 -1
- package/lib/index.js +5 -1
- package/lib/index.js.map +1 -1
- package/lib/query.d.ts +54 -1
- package/lib/query.js +35 -1
- package/lib/query.js.map +1 -1
- package/lib/resolver.d.ts +2 -1
- package/lib/resolver.js.map +1 -1
- package/lib/schema.d.ts +13 -3
- package/lib/schema.js +14 -7
- package/lib/schema.js.map +1 -1
- package/package.json +17 -14
- package/src/hooks.ts +32 -17
- package/src/query.ts +62 -0
- package/src/resolver.ts +3 -4
- package/src/schema.ts +25 -6
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,51 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [5.0.0-pre.20](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.19...v5.0.0-pre.20) (2022-05-04)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **dependencies:** Lock monorepo package version numbers ([#2623](https://github.com/feathersjs/feathers/issues/2623)) ([5640c10](https://github.com/feathersjs/feathers/commit/5640c1020cc139994e695d658c08bad3494db507))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* **schema:** Add querySyntax helper to create full query schemas ([#2621](https://github.com/feathersjs/feathers/issues/2621)) ([2bbb103](https://github.com/feathersjs/feathers/commit/2bbb103b2f3e30fb0fff935f92ad3276a1a67e41))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# [5.0.0-pre.19](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.18...v5.0.0-pre.19) (2022-05-01)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Features
|
|
26
|
+
|
|
27
|
+
* **schema:** Allow hooks to run resolvers in sequence ([#2609](https://github.com/feathersjs/feathers/issues/2609)) ([d85c507](https://github.com/feathersjs/feathers/commit/d85c507c76d07e48fc8e7e28ff7de0ef435e0ef8))
|
|
28
|
+
* **typescript:** Improve adapter typings ([#2605](https://github.com/feathersjs/feathers/issues/2605)) ([3b2ca0a](https://github.com/feathersjs/feathers/commit/3b2ca0a6a8e03e8390272c4d7e930b4bffdaacf5))
|
|
29
|
+
* **typescript:** Improve params and query typeability ([#2600](https://github.com/feathersjs/feathers/issues/2600)) ([df28b76](https://github.com/feathersjs/feathers/commit/df28b7619161f1df5e700326f52cca1a92dc5d28))
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
# [5.0.0-pre.18](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.17...v5.0.0-pre.18) (2022-04-11)
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
### Bug Fixes
|
|
39
|
+
|
|
40
|
+
* **schema:** result resolver correctly resolves paginated find result ([#2594](https://github.com/feathersjs/feathers/issues/2594)) ([6511e45](https://github.com/feathersjs/feathers/commit/6511e45bd0624f1a629530719709f4b27fecbe0b))
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Features
|
|
44
|
+
|
|
45
|
+
* **configuration:** Allow app configuration to be validated against a schema ([#2590](https://github.com/feathersjs/feathers/issues/2590)) ([a268f86](https://github.com/feathersjs/feathers/commit/a268f86da92a8ada14ed11ab456aac0a4bba5bb0))
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
6
51
|
# [5.0.0-pre.17](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.16...v5.0.0-pre.17) (2022-02-15)
|
|
7
52
|
|
|
8
53
|
|
package/README.md
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
|
|
4
4
|
[](https://www.npmjs.com/package/@feathersjs/schema)
|
|
5
|
+
[](https://discord.gg/qa8kez8QBx)
|
|
5
6
|
|
|
6
7
|
> A common data schema definition format
|
|
7
8
|
|
package/lib/hooks.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { HookContext, NextFunction } from '@feathersjs/feathers';
|
|
2
2
|
import { Resolver } from './resolver';
|
|
3
3
|
import { Schema } from './schema';
|
|
4
|
-
export declare const resolveQuery: <T>(
|
|
5
|
-
export declare const resolveData: <T>(
|
|
6
|
-
export declare const resolveResult: <T>(
|
|
4
|
+
export declare const resolveQuery: <T>(...resolvers: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>[]) => (context: HookContext, next?: NextFunction) => Promise<any>;
|
|
5
|
+
export declare const resolveData: <T>(...resolvers: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>[]) => (context: HookContext, next?: NextFunction) => Promise<any>;
|
|
6
|
+
export declare const resolveResult: <T>(...resolvers: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>[]) => (context: HookContext, next?: NextFunction) => Promise<void>;
|
|
7
7
|
export declare const validateQuery: (schema: Schema<any>) => (context: HookContext, next?: NextFunction) => Promise<any>;
|
|
8
8
|
export declare const validateData: (schema: Schema<any>) => (context: HookContext, next?: NextFunction) => Promise<any>;
|
package/lib/hooks.js
CHANGED
|
@@ -11,13 +11,18 @@ const getContext = (context) => {
|
|
|
11
11
|
}
|
|
12
12
|
};
|
|
13
13
|
};
|
|
14
|
-
const
|
|
14
|
+
const runResolvers = async (resolvers, data, ctx, status) => {
|
|
15
|
+
let current = data;
|
|
16
|
+
for (const resolver of resolvers) {
|
|
17
|
+
current = await resolver.resolve(current, ctx, status);
|
|
18
|
+
}
|
|
19
|
+
return current;
|
|
20
|
+
};
|
|
21
|
+
const resolveQuery = (...resolvers) => async (context, next) => {
|
|
15
22
|
var _a;
|
|
16
23
|
const ctx = getContext(context);
|
|
17
24
|
const data = ((_a = context === null || context === void 0 ? void 0 : context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
|
|
18
|
-
const query = await
|
|
19
|
-
originalContext: context
|
|
20
|
-
});
|
|
25
|
+
const query = await runResolvers(resolvers, data, ctx);
|
|
21
26
|
context.params = {
|
|
22
27
|
...context.params,
|
|
23
28
|
query
|
|
@@ -27,24 +32,24 @@ const resolveQuery = (resolver) => async (context, next) => {
|
|
|
27
32
|
}
|
|
28
33
|
};
|
|
29
34
|
exports.resolveQuery = resolveQuery;
|
|
30
|
-
const resolveData = (
|
|
35
|
+
const resolveData = (...resolvers) => async (context, next) => {
|
|
31
36
|
const ctx = getContext(context);
|
|
32
37
|
const data = context.data;
|
|
33
38
|
const status = {
|
|
34
39
|
originalContext: context
|
|
35
40
|
};
|
|
36
41
|
if (Array.isArray(data)) {
|
|
37
|
-
context.data = await Promise.all(data.map(current =>
|
|
42
|
+
context.data = await Promise.all(data.map(current => runResolvers(resolvers, current, ctx, status)));
|
|
38
43
|
}
|
|
39
44
|
else {
|
|
40
|
-
context.data = await
|
|
45
|
+
context.data = await runResolvers(resolvers, data, ctx, status);
|
|
41
46
|
}
|
|
42
47
|
if (typeof next === 'function') {
|
|
43
48
|
return next();
|
|
44
49
|
}
|
|
45
50
|
};
|
|
46
51
|
exports.resolveData = resolveData;
|
|
47
|
-
const resolveResult = (
|
|
52
|
+
const resolveResult = (...resolvers) => async (context, next) => {
|
|
48
53
|
var _a;
|
|
49
54
|
if (typeof next === 'function') {
|
|
50
55
|
const { $resolve: properties, ...query } = ((_a = context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
|
|
@@ -62,14 +67,16 @@ const resolveResult = (resolver) => async (context, next) => {
|
|
|
62
67
|
}
|
|
63
68
|
const ctx = getContext(context);
|
|
64
69
|
const status = context.params.resolve;
|
|
65
|
-
const
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
+
const isPaginated = context.method === 'find' && context.result.data;
|
|
71
|
+
const data = isPaginated ? context.result.data : context.result;
|
|
72
|
+
const result = Array.isArray(data) ?
|
|
73
|
+
await Promise.all(data.map(async (current) => runResolvers(resolvers, current, ctx, status))) :
|
|
74
|
+
await runResolvers(resolvers, data, ctx, status);
|
|
75
|
+
if (isPaginated) {
|
|
76
|
+
context.result.data = result;
|
|
70
77
|
}
|
|
71
78
|
else {
|
|
72
|
-
context.result =
|
|
79
|
+
context.result = result;
|
|
73
80
|
}
|
|
74
81
|
};
|
|
75
82
|
exports.resolveResult = resolveResult;
|
package/lib/hooks.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":";;;AACA,0CAA8C;AAI9C,MAAM,UAAU,GAAG,CAAC,OAAoB,EAAE,EAAE;IAC1C,OAAO;QACL,GAAG,OAAO;QACV,MAAM,EAAE;YACN,GAAG,OAAO,CAAC,MAAM;YACjB,KAAK,EAAE,EAAE;SACV;KACF,CAAA;AACH,CAAC,CAAA;AAEM,MAAM,YAAY,GAAG,CAAK,
|
|
1
|
+
{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":";;;AACA,0CAA8C;AAI9C,MAAM,UAAU,GAAG,CAAC,OAAoB,EAAE,EAAE;IAC1C,OAAO;QACL,GAAG,OAAO;QACV,MAAM,EAAE;YACN,GAAG,OAAO,CAAC,MAAM;YACjB,KAAK,EAAE,EAAE;SACV;KACF,CAAA;AACH,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,KAAK,EACxB,SAAqC,EACrC,IAAS,EACT,GAAgB,EAChB,MAAgD,EAChD,EAAE;IACF,IAAI,OAAO,GAAQ,IAAI,CAAC;IAExB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,OAAO,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KACxD;IAED,OAAO,OAAY,CAAC;AACtB,CAAC,CAAA;AAEM,MAAM,YAAY,GAAG,CAAK,GAAG,SAAqC,EAAE,EAAE,CAC3E,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;;IAClD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IAEvD,OAAO,CAAC,MAAM,GAAG;QACf,GAAG,OAAO,CAAC,MAAM;QACjB,KAAK;KACN,CAAA;IAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,OAAO,IAAI,EAAE,CAAC;KACf;AACH,CAAC,CAAC;AAdS,QAAA,YAAY,gBAcrB;AAEG,MAAM,WAAW,GAAG,CAAK,GAAG,SAAqC,EAAE,EAAE,CAC1E,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;IAClD,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1B,MAAM,MAAM,GAAG;QACb,eAAe,EAAE,OAAO;KACzB,CAAC;IAEF,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,CAAC,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAClD,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAC9C,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,CAAC,IAAI,GAAG,MAAM,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KACjE;IAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,OAAO,IAAI,EAAE,CAAC;KACf;AACH,CAAC,CAAC;AAnBS,QAAA,WAAW,eAmBpB;AAEG,MAAM,aAAa,GAAG,CAAK,GAAG,SAAqC,EAAE,EAAE,CAC5E,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;;IAClD,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,CAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;QACvE,MAAM,OAAO,GAAG;YACd,eAAe,EAAE,OAAO;YACxB,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO;YACzB,UAAU;SACX,CAAC;QAEF,OAAO,CAAC,MAAM,GAAG;YACf,GAAG,OAAO,CAAC,MAAM;YACjB,OAAO;YACP,KAAK;SACN,CAAA;QAED,MAAM,IAAI,EAAE,CAAC;KACd;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;IAEtC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;IACrE,MAAM,IAAI,GAAG,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAEhE,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;QAClC,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7F,MAAM,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAEnD,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;KAC9B;SAAM;QACL,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;KACzB;AACH,CAAC,CAAC;AAlCS,QAAA,aAAa,iBAkCtB;AAEG,MAAM,aAAa,GAAG,CAAC,MAAmB,EAAE,EAAE,CACnD,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;;IAClD,MAAM,IAAI,GAAG,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;IAE1C,IAAI;QACF,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE1C,OAAO,CAAC,MAAM,GAAG;YACf,GAAG,OAAO,CAAC,MAAM;YACjB,KAAK;SACN,CAAA;QAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;YAC9B,OAAO,IAAI,EAAE,CAAC;SACf;KACF;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;KACzE;AACH,CAAC,CAAC;AAlBS,QAAA,aAAa,iBAkBtB;AAEG,MAAM,YAAY,GAAG,CAAC,MAAmB,EAAE,EAAE,CAClD,KAAK,EAAE,OAAoB,EAAE,IAAmB,EAAE,EAAE;IAClD,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAE1B,IAAI;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,OAAO,CAAC,IAAI,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAClD,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CACzB,CAAC,CAAC;SACJ;aAAM;YACL,OAAO,CAAC,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;SAC5C;KACF;IAAC,OAAO,KAAU,EAAE;QACnB,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,gBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;KACzE;IAED,IAAI,OAAO,IAAI,KAAK,UAAU,EAAE;QAC9B,OAAO,IAAI,EAAE,CAAC;KACf;AACH,CAAC,CAAC;AAnBS,QAAA,YAAY,gBAmBrB"}
|
package/lib/index.js
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
3
|
if (k2 === undefined) k2 = k;
|
|
4
|
-
Object.
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
5
9
|
}) : (function(o, m, k, k2) {
|
|
6
10
|
if (k2 === undefined) k2 = k;
|
|
7
11
|
o[k2] = m[k];
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAEA,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB"}
|
package/lib/query.d.ts
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
import { JSONSchema } from 'json-schema-to-ts';
|
|
2
|
-
export declare
|
|
2
|
+
export declare type PropertyQuery<D extends JSONSchema> = {
|
|
3
|
+
anyOf: [
|
|
4
|
+
D,
|
|
5
|
+
{
|
|
6
|
+
type: 'object';
|
|
7
|
+
additionalProperties: false;
|
|
8
|
+
properties: {
|
|
9
|
+
$gt: D;
|
|
10
|
+
$gte: D;
|
|
11
|
+
$lt: D;
|
|
12
|
+
$lte: D;
|
|
13
|
+
$ne: D;
|
|
14
|
+
$in: {
|
|
15
|
+
type: 'array';
|
|
16
|
+
items: D;
|
|
17
|
+
};
|
|
18
|
+
$nin: {
|
|
19
|
+
type: 'array';
|
|
20
|
+
items: D;
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
}
|
|
24
|
+
];
|
|
25
|
+
};
|
|
26
|
+
export declare const queryProperty: <T extends import("json-schema-to-ts").JSONSchema7>(definition: T) => {
|
|
3
27
|
readonly anyOf: readonly [T, {
|
|
4
28
|
readonly type: "object";
|
|
5
29
|
readonly additionalProperties: false;
|
|
@@ -20,3 +44,32 @@ export declare const queryProperty: <T extends JSONSchema>(definition: T) => {
|
|
|
20
44
|
};
|
|
21
45
|
}];
|
|
22
46
|
};
|
|
47
|
+
export declare const queryProperties: <T extends {
|
|
48
|
+
[key: string]: import("json-schema-to-ts").JSONSchema7;
|
|
49
|
+
}>(definition: T) => { [K in keyof T]: PropertyQuery<T[K]>; };
|
|
50
|
+
export declare const querySyntax: <T extends {
|
|
51
|
+
[key: string]: import("json-schema-to-ts").JSONSchema7;
|
|
52
|
+
}>(definition: T) => {
|
|
53
|
+
readonly $limit: {
|
|
54
|
+
readonly type: "number";
|
|
55
|
+
readonly minimum: 0;
|
|
56
|
+
};
|
|
57
|
+
readonly $skip: {
|
|
58
|
+
readonly type: "number";
|
|
59
|
+
readonly minimum: 0;
|
|
60
|
+
};
|
|
61
|
+
readonly $sort: {
|
|
62
|
+
readonly type: "object";
|
|
63
|
+
readonly properties: { [K in keyof T]: {
|
|
64
|
+
readonly type: 'number';
|
|
65
|
+
readonly enum: [1, -1];
|
|
66
|
+
}; };
|
|
67
|
+
};
|
|
68
|
+
readonly $select: {
|
|
69
|
+
readonly type: "array";
|
|
70
|
+
readonly items: {
|
|
71
|
+
readonly type: "string";
|
|
72
|
+
readonly enum: (keyof T)[];
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
} & { [K_1 in keyof T]: PropertyQuery<T[K_1]>; };
|
package/lib/query.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.queryProperty = void 0;
|
|
3
|
+
exports.querySyntax = exports.queryProperties = exports.queryProperty = void 0;
|
|
4
4
|
const queryProperty = (definition) => ({
|
|
5
5
|
anyOf: [
|
|
6
6
|
definition,
|
|
@@ -26,4 +26,38 @@ const queryProperty = (definition) => ({
|
|
|
26
26
|
]
|
|
27
27
|
});
|
|
28
28
|
exports.queryProperty = queryProperty;
|
|
29
|
+
const queryProperties = (definition) => Object.keys(definition).reduce((res, key) => {
|
|
30
|
+
res[key] = (0, exports.queryProperty)(definition[key]);
|
|
31
|
+
return res;
|
|
32
|
+
}, {});
|
|
33
|
+
exports.queryProperties = queryProperties;
|
|
34
|
+
const querySyntax = (definition) => ({
|
|
35
|
+
$limit: {
|
|
36
|
+
type: 'number',
|
|
37
|
+
minimum: 0
|
|
38
|
+
},
|
|
39
|
+
$skip: {
|
|
40
|
+
type: 'number',
|
|
41
|
+
minimum: 0
|
|
42
|
+
},
|
|
43
|
+
$sort: {
|
|
44
|
+
type: 'object',
|
|
45
|
+
properties: Object.keys(definition).reduce((res, key) => {
|
|
46
|
+
res[key] = {
|
|
47
|
+
type: 'number',
|
|
48
|
+
enum: [1, -1]
|
|
49
|
+
};
|
|
50
|
+
return res;
|
|
51
|
+
}, {})
|
|
52
|
+
},
|
|
53
|
+
$select: {
|
|
54
|
+
type: 'array',
|
|
55
|
+
items: {
|
|
56
|
+
type: 'string',
|
|
57
|
+
enum: Object.keys(definition)
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
...(0, exports.queryProperties)(definition)
|
|
61
|
+
});
|
|
62
|
+
exports.querySyntax = querySyntax;
|
|
29
63
|
//# sourceMappingURL=query.js.map
|
package/lib/query.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":";;;AA2BO,MAAM,aAAa,GAAG,CAAwB,UAAa,EAAE,EAAE,CAAC,CAAC;IACtE,KAAK,EAAE;QACL,UAAU;QACV;YACE,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,UAAU;gBACf,IAAI,EAAE,UAAU;gBAChB,GAAG,EAAE,UAAU;gBACf,GAAG,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,UAAU;iBAClB;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,UAAU;iBAClB;aACF;SACF;KACF;CACQ,CAAA,CAAC;AAvBC,QAAA,aAAa,iBAuBd;AAEL,MAAM,eAAe,GAAG,CAA2C,UAAa,EAAE,EAAE,CACzF,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;IACzC,GAAW,CAAC,GAAG,CAAC,GAAG,IAAA,qBAAa,EAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;IAElD,OAAO,GAAG,CAAA;AACZ,CAAC,EAAE,EAA6C,CAAC,CAAA;AALtC,QAAA,eAAe,mBAKuB;AAE5C,MAAM,WAAW,GAAG,CAA2C,UAAa,EAAE,EAAE,CAAC,CAAC;IACvF,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;KACX;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC;KACX;IACD,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACrD,GAAW,CAAC,GAAG,CAAC,GAAG;gBAClB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aACd,CAAA;YAED,OAAO,GAAG,CAAA;QACZ,CAAC,EAAE,EAA6E,CAAC;KAClF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,OAAO;QACb,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAuB;SACpD;KACF;IACD,GAAG,IAAA,uBAAe,EAAC,UAAU,CAAC;CACrB,CAAA,CAAA;AA5BE,QAAA,WAAW,eA4Bb"}
|
package/lib/resolver.d.ts
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
|
+
import { Schema } from './schema';
|
|
1
2
|
export declare type PropertyResolver<T, V, C> = (value: V | undefined, obj: T, context: C, status: ResolverStatus<T, C>) => Promise<V | undefined>;
|
|
2
3
|
export declare type PropertyResolverMap<T, C> = {
|
|
3
4
|
[key in keyof T]?: PropertyResolver<T, T[key], C>;
|
|
4
5
|
};
|
|
5
6
|
export interface ResolverConfig<T, C> {
|
|
6
|
-
schema?:
|
|
7
|
+
schema?: Schema<T>;
|
|
7
8
|
validate?: 'before' | 'after' | false;
|
|
8
9
|
properties: PropertyResolverMap<T, C>;
|
|
9
10
|
}
|
package/lib/resolver.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;
|
|
1
|
+
{"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;AA2BhD,MAAa,QAAQ;IAGnB,YAAoB,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;IACjD,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,IAAO,EACP,IAAO,EACP,OAAU,EACV,SAAwC,EAAE;QAE1C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,KAAK,GAAI,IAAY,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAE/C,sCAAsC;QACtC,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YAC5B,OAAO,SAAS,CAAC;SAClB;QAED,MAAM,cAAc,GAAG;YACrB,GAAG,MAAM;YACT,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,IAAc,CAAC;YAC/B,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,QAAQ,CAAC;SAC5B,CAAA;QAED,OAAO,QAAQ,CAAC,KAAK,EAAE,IAAW,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;IAC/D,CAAC;IAED,KAAK,CAAC,OAAO,CAAK,KAAQ,EAAE,OAAU,EAAE,MAAsC;QAC5E,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACjE,MAAM,IAAI,GAAG,MAAM,IAAI,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACpF,MAAM,YAAY,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAC;YACrD,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU;YACpB,kEAAkE;YAClE,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAClD,CAAC;QAEjB,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,MAAM,MAAM,GAAQ,EAAE,CAAC;QACvB,IAAI,SAAS,GAAG,KAAK,CAAC;QAEtB,8CAA8C;QAC9C,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YAC9C,MAAM,KAAK,GAAI,IAAY,CAAC,IAAI,CAAC,CAAC;YAElC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;oBAEzE,IAAI,QAAQ,KAAK,SAAS,EAAE;wBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;qBACzB;iBACF;gBAAC,OAAO,KAAU,EAAE;oBACnB,wBAAwB;oBACxB,MAAM,cAAc,GAAG,OAAO,KAAK,CAAC,MAAM,KAAK,UAAU;wBACvD,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE;wBAChB,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,KAAK,EAAE,CAAC;oBAExC,MAAM,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC;oBAC9B,SAAS,GAAG,IAAI,CAAC;iBAClB;aACF;iBAAM,IAAI,KAAK,KAAK,SAAS,EAAE;gBAC9B,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;aACtB;QACH,CAAC,CAAC,CAAC,CAAC;QAEJ,IAAI,SAAS,EAAE;YACb,MAAM,YAAY,GAAG,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,EAAC,CAAC,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAEjF,MAAM,IAAI,mBAAU,CAAC,sBAAsB,GAAG,YAAY,EAAE,MAAM,CAAC,CAAC;SACrE;QAED,OAAO,MAAM,IAAI,QAAQ,KAAK,OAAO;YACnC,CAAC,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;YAC/B,CAAC,CAAC,MAAM,CAAC;IACb,CAAC;CACF;AA9ED,4BA8EC;AAED,SAAgB,OAAO,CAAS,OAA6B;IAC3D,OAAO,IAAI,QAAQ,CAAO,OAAO,CAAC,CAAC;AACrC,CAAC;AAFD,0BAEC"}
|
package/lib/schema.d.ts
CHANGED
|
@@ -1,17 +1,27 @@
|
|
|
1
1
|
import Ajv, { AsyncValidateFunction, ValidateFunction } from 'ajv';
|
|
2
2
|
import { FromSchema, JSONSchema } from 'json-schema-to-ts';
|
|
3
|
-
export declare const
|
|
3
|
+
export declare const DEFAULT_AJV: Ajv;
|
|
4
|
+
export { Ajv };
|
|
4
5
|
export declare type JSONSchemaDefinition = JSONSchema & {
|
|
5
6
|
$id: string;
|
|
6
7
|
$async?: boolean;
|
|
8
|
+
properties?: {
|
|
9
|
+
[key: string]: JSONSchema;
|
|
10
|
+
};
|
|
11
|
+
required?: readonly string[];
|
|
7
12
|
};
|
|
8
|
-
export
|
|
13
|
+
export interface Schema<T> {
|
|
14
|
+
validate<X = T>(...args: Parameters<ValidateFunction<X>>): Promise<X>;
|
|
15
|
+
}
|
|
16
|
+
export declare class SchemaWrapper<S extends JSONSchemaDefinition> implements Schema<FromSchema<S>> {
|
|
9
17
|
definition: S;
|
|
10
18
|
ajv: Ajv;
|
|
11
19
|
validator: AsyncValidateFunction;
|
|
12
20
|
readonly _type: FromSchema<S>;
|
|
13
21
|
constructor(definition: S, ajv?: Ajv);
|
|
22
|
+
get properties(): S["properties"];
|
|
23
|
+
get required(): S["required"];
|
|
14
24
|
validate<T = FromSchema<S>>(...args: Parameters<ValidateFunction<T>>): Promise<T>;
|
|
15
25
|
toJSON(): S;
|
|
16
26
|
}
|
|
17
|
-
export declare function schema<S extends JSONSchemaDefinition>(definition: S, ajv?: Ajv):
|
|
27
|
+
export declare function schema<S extends JSONSchemaDefinition>(definition: S, ajv?: Ajv): SchemaWrapper<S>;
|
package/lib/schema.js
CHANGED
|
@@ -3,14 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.schema = exports.
|
|
6
|
+
exports.schema = exports.SchemaWrapper = exports.Ajv = exports.DEFAULT_AJV = void 0;
|
|
7
7
|
const ajv_1 = __importDefault(require("ajv"));
|
|
8
|
+
exports.Ajv = ajv_1.default;
|
|
8
9
|
const errors_1 = require("@feathersjs/errors");
|
|
9
|
-
exports.
|
|
10
|
+
exports.DEFAULT_AJV = new ajv_1.default({
|
|
10
11
|
coerceTypes: true
|
|
11
12
|
});
|
|
12
|
-
class
|
|
13
|
-
constructor(definition, ajv = exports.
|
|
13
|
+
class SchemaWrapper {
|
|
14
|
+
constructor(definition, ajv = exports.DEFAULT_AJV) {
|
|
14
15
|
this.definition = definition;
|
|
15
16
|
this.ajv = ajv;
|
|
16
17
|
this.validator = this.ajv.compile({
|
|
@@ -18,6 +19,12 @@ class Schema {
|
|
|
18
19
|
...this.definition
|
|
19
20
|
});
|
|
20
21
|
}
|
|
22
|
+
get properties() {
|
|
23
|
+
return this.definition.properties;
|
|
24
|
+
}
|
|
25
|
+
get required() {
|
|
26
|
+
return this.definition.required;
|
|
27
|
+
}
|
|
21
28
|
async validate(...args) {
|
|
22
29
|
try {
|
|
23
30
|
const validated = await this.validator(...args);
|
|
@@ -31,9 +38,9 @@ class Schema {
|
|
|
31
38
|
return this.definition;
|
|
32
39
|
}
|
|
33
40
|
}
|
|
34
|
-
exports.
|
|
35
|
-
function schema(definition, ajv = exports.
|
|
36
|
-
return new
|
|
41
|
+
exports.SchemaWrapper = SchemaWrapper;
|
|
42
|
+
function schema(definition, ajv = exports.DEFAULT_AJV) {
|
|
43
|
+
return new SchemaWrapper(definition, ajv);
|
|
37
44
|
}
|
|
38
45
|
exports.schema = schema;
|
|
39
46
|
//# sourceMappingURL=schema.js.map
|
package/lib/schema.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAmE;
|
|
1
|
+
{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAmE;AAQ1D,cARF,aAAG,CAQE;AANZ,+CAAgD;AAEnC,QAAA,WAAW,GAAG,IAAI,aAAG,CAAC;IACjC,WAAW,EAAE,IAAI;CAClB,CAAC,CAAC;AAeH,MAAa,aAAa;IAKxB,YAAoB,UAAa,EAAE,MAAW,mBAAW;QAArC,eAAU,GAAV,UAAU,CAAG;QAC/B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YAChC,MAAM,EAAE,IAAI;YACZ,GAAI,IAAI,CAAC,UAAkB;SAC5B,CAA0B,CAAC;IAC9B,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,UAA6B,CAAC;IACvD,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,UAAU,CAAC,QAAyB,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,QAAQ,CAAsB,GAAG,IAAqC;QAC1E,IAAI;YACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAM,CAAC;YAErD,OAAO,SAAS,CAAC;SAClB;QAAC,OAAO,KAAU,EAAE;YACnB,MAAM,IAAI,mBAAU,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;SACnD;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAlCD,sCAkCC;AAED,SAAgB,MAAM,CAAmC,UAAa,EAAE,MAAW,mBAAW;IAC5F,OAAO,IAAI,aAAa,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AAC5C,CAAC;AAFD,wBAEC"}
|
package/package.json
CHANGED
|
@@ -1,9 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@feathersjs/schema",
|
|
3
3
|
"description": "A common data schema definition format",
|
|
4
|
-
"version": "5.0.0-pre.
|
|
4
|
+
"version": "5.0.0-pre.20",
|
|
5
5
|
"homepage": "https://feathersjs.com",
|
|
6
6
|
"main": "lib/",
|
|
7
|
+
"types": "lib/",
|
|
7
8
|
"keywords": [
|
|
8
9
|
"feathers",
|
|
9
10
|
"feathers-plugin"
|
|
@@ -15,7 +16,8 @@
|
|
|
15
16
|
},
|
|
16
17
|
"repository": {
|
|
17
18
|
"type": "git",
|
|
18
|
-
"url": "git://github.com/feathersjs/feathers.git"
|
|
19
|
+
"url": "git://github.com/feathersjs/feathers.git",
|
|
20
|
+
"directory": "packages/schema"
|
|
19
21
|
},
|
|
20
22
|
"author": {
|
|
21
23
|
"name": "Feathers contributors",
|
|
@@ -41,7 +43,8 @@
|
|
|
41
43
|
"scripts": {
|
|
42
44
|
"prepublish": "npm run compile",
|
|
43
45
|
"compile": "shx rm -rf lib/ && tsc",
|
|
44
|
-
"
|
|
46
|
+
"mocha": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts",
|
|
47
|
+
"test": "npm run compile && npm run mocha"
|
|
45
48
|
},
|
|
46
49
|
"directories": {
|
|
47
50
|
"lib": "lib"
|
|
@@ -50,21 +53,21 @@
|
|
|
50
53
|
"access": "public"
|
|
51
54
|
},
|
|
52
55
|
"dependencies": {
|
|
53
|
-
"@feathersjs/errors": "^5.0.0-pre.
|
|
54
|
-
"@feathersjs/feathers": "^5.0.0-pre.
|
|
55
|
-
"@types/json-schema": "^7.0.
|
|
56
|
-
"ajv": "^8.
|
|
56
|
+
"@feathersjs/errors": "^5.0.0-pre.20",
|
|
57
|
+
"@feathersjs/feathers": "^5.0.0-pre.20",
|
|
58
|
+
"@types/json-schema": "^7.0.11",
|
|
59
|
+
"ajv": "^8.11.0",
|
|
57
60
|
"json-schema": "^0.4.0",
|
|
58
|
-
"json-schema-to-ts": "^
|
|
61
|
+
"json-schema-to-ts": "^2.3.0"
|
|
59
62
|
},
|
|
60
63
|
"devDependencies": {
|
|
61
|
-
"@feathersjs/memory": "^5.0.0-pre.
|
|
62
|
-
"@types/mocha": "^9.1.
|
|
63
|
-
"@types/node": "^17.0.
|
|
64
|
+
"@feathersjs/memory": "^5.0.0-pre.20",
|
|
65
|
+
"@types/mocha": "^9.1.1",
|
|
66
|
+
"@types/node": "^17.0.31",
|
|
64
67
|
"ajv-formats": "^2.1.1",
|
|
65
|
-
"mocha": "^
|
|
68
|
+
"mocha": "^10.0.0",
|
|
66
69
|
"shx": "^0.3.4",
|
|
67
|
-
"typescript": "^4.
|
|
70
|
+
"typescript": "^4.6.4"
|
|
68
71
|
},
|
|
69
|
-
"gitHead": "
|
|
72
|
+
"gitHead": "54de749a0b392c7da726c668002b50cafaca530c"
|
|
70
73
|
}
|
package/src/hooks.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { HookContext, NextFunction } from '@feathersjs/feathers';
|
|
2
2
|
import { BadRequest } from '../../errors/lib';
|
|
3
|
-
import { Resolver } from './resolver';
|
|
3
|
+
import { Resolver, ResolverStatus } from './resolver';
|
|
4
4
|
import { Schema } from './schema';
|
|
5
5
|
|
|
6
6
|
const getContext = (context: HookContext) => {
|
|
@@ -13,13 +13,26 @@ const getContext = (context: HookContext) => {
|
|
|
13
13
|
}
|
|
14
14
|
}
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
const runResolvers = async <T> (
|
|
17
|
+
resolvers: Resolver<T, HookContext>[],
|
|
18
|
+
data: any,
|
|
19
|
+
ctx: HookContext,
|
|
20
|
+
status?: Partial<ResolverStatus<T, HookContext>>
|
|
21
|
+
) => {
|
|
22
|
+
let current: any = data;
|
|
23
|
+
|
|
24
|
+
for (const resolver of resolvers) {
|
|
25
|
+
current = await resolver.resolve(current, ctx, status);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
return current as T;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export const resolveQuery = <T> (...resolvers: Resolver<T, HookContext>[]) =>
|
|
17
32
|
async (context: HookContext, next?: NextFunction) => {
|
|
18
33
|
const ctx = getContext(context);
|
|
19
34
|
const data = context?.params?.query || {};
|
|
20
|
-
const query = await
|
|
21
|
-
originalContext: context
|
|
22
|
-
});
|
|
35
|
+
const query = await runResolvers(resolvers, data, ctx);
|
|
23
36
|
|
|
24
37
|
context.params = {
|
|
25
38
|
...context.params,
|
|
@@ -31,7 +44,7 @@ export const resolveQuery = <T> (resolver: Resolver<T, HookContext>) =>
|
|
|
31
44
|
}
|
|
32
45
|
};
|
|
33
46
|
|
|
34
|
-
export const resolveData = <T> (
|
|
47
|
+
export const resolveData = <T> (...resolvers: Resolver<T, HookContext>[]) =>
|
|
35
48
|
async (context: HookContext, next?: NextFunction) => {
|
|
36
49
|
const ctx = getContext(context);
|
|
37
50
|
const data = context.data;
|
|
@@ -41,10 +54,10 @@ export const resolveData = <T> (resolver: Resolver<T, HookContext>) =>
|
|
|
41
54
|
|
|
42
55
|
if (Array.isArray(data)) {
|
|
43
56
|
context.data = await Promise.all(data.map(current =>
|
|
44
|
-
|
|
57
|
+
runResolvers(resolvers, current, ctx, status)
|
|
45
58
|
));
|
|
46
59
|
} else {
|
|
47
|
-
context.data = await
|
|
60
|
+
context.data = await runResolvers(resolvers, data, ctx, status);
|
|
48
61
|
}
|
|
49
62
|
|
|
50
63
|
if (typeof next === 'function') {
|
|
@@ -52,7 +65,7 @@ export const resolveData = <T> (resolver: Resolver<T, HookContext>) =>
|
|
|
52
65
|
}
|
|
53
66
|
};
|
|
54
67
|
|
|
55
|
-
export const resolveResult = <T> (
|
|
68
|
+
export const resolveResult = <T> (...resolvers: Resolver<T, HookContext>[]) =>
|
|
56
69
|
async (context: HookContext, next?: NextFunction) => {
|
|
57
70
|
if (typeof next === 'function') {
|
|
58
71
|
const { $resolve: properties, ...query } = context.params?.query || {};
|
|
@@ -73,16 +86,18 @@ export const resolveResult = <T> (resolver: Resolver<T, HookContext>) =>
|
|
|
73
86
|
|
|
74
87
|
const ctx = getContext(context);
|
|
75
88
|
const status = context.params.resolve;
|
|
76
|
-
const data = context.method === 'find' && context.result.data
|
|
77
|
-
? context.result.data
|
|
78
|
-
: context.result;
|
|
79
89
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
90
|
+
const isPaginated = context.method === 'find' && context.result.data;
|
|
91
|
+
const data = isPaginated ? context.result.data : context.result;
|
|
92
|
+
|
|
93
|
+
const result = Array.isArray(data) ?
|
|
94
|
+
await Promise.all(data.map(async current => runResolvers(resolvers, current, ctx, status))) :
|
|
95
|
+
await runResolvers(resolvers, data, ctx, status);
|
|
96
|
+
|
|
97
|
+
if (isPaginated) {
|
|
98
|
+
context.result.data = result;
|
|
84
99
|
} else {
|
|
85
|
-
context.result =
|
|
100
|
+
context.result = result;
|
|
86
101
|
}
|
|
87
102
|
};
|
|
88
103
|
|
package/src/query.ts
CHANGED
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
import { JSONSchema } from 'json-schema-to-ts';
|
|
2
2
|
|
|
3
|
+
export type PropertyQuery<D extends JSONSchema> = {
|
|
4
|
+
anyOf: [
|
|
5
|
+
D,
|
|
6
|
+
{
|
|
7
|
+
type: 'object',
|
|
8
|
+
additionalProperties: false,
|
|
9
|
+
properties: {
|
|
10
|
+
$gt: D,
|
|
11
|
+
$gte: D,
|
|
12
|
+
$lt: D,
|
|
13
|
+
$lte: D,
|
|
14
|
+
$ne: D,
|
|
15
|
+
$in: {
|
|
16
|
+
type: 'array',
|
|
17
|
+
items: D
|
|
18
|
+
},
|
|
19
|
+
$nin: {
|
|
20
|
+
type: 'array',
|
|
21
|
+
items: D
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
}
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
|
|
3
28
|
export const queryProperty = <T extends JSONSchema> (definition: T) => ({
|
|
4
29
|
anyOf: [
|
|
5
30
|
definition,
|
|
@@ -24,3 +49,40 @@ export const queryProperty = <T extends JSONSchema> (definition: T) => ({
|
|
|
24
49
|
}
|
|
25
50
|
]
|
|
26
51
|
} as const);
|
|
52
|
+
|
|
53
|
+
export const queryProperties = <T extends { [key: string]: JSONSchema }> (definition: T) =>
|
|
54
|
+
Object.keys(definition).reduce((res, key) => {
|
|
55
|
+
(res as any)[key] = queryProperty(definition[key])
|
|
56
|
+
|
|
57
|
+
return res
|
|
58
|
+
}, {} as { [K in keyof T]: PropertyQuery<T[K]> })
|
|
59
|
+
|
|
60
|
+
export const querySyntax = <T extends { [key: string]: JSONSchema }> (definition: T) => ({
|
|
61
|
+
$limit: {
|
|
62
|
+
type: 'number',
|
|
63
|
+
minimum: 0
|
|
64
|
+
},
|
|
65
|
+
$skip: {
|
|
66
|
+
type: 'number',
|
|
67
|
+
minimum: 0
|
|
68
|
+
},
|
|
69
|
+
$sort: {
|
|
70
|
+
type: 'object',
|
|
71
|
+
properties: Object.keys(definition).reduce((res, key) => {
|
|
72
|
+
(res as any)[key] = {
|
|
73
|
+
type: 'number',
|
|
74
|
+
enum: [1, -1]
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
return res
|
|
78
|
+
}, {} as { [K in keyof T]: { readonly type: 'number', readonly enum: [1, -1] } })
|
|
79
|
+
},
|
|
80
|
+
$select: {
|
|
81
|
+
type: 'array',
|
|
82
|
+
items: {
|
|
83
|
+
type: 'string',
|
|
84
|
+
enum: Object.keys(definition) as any as (keyof T)[]
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
...queryProperties(definition)
|
|
88
|
+
} as const)
|
package/src/resolver.ts
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { BadRequest } from '@feathersjs/errors';
|
|
2
|
+
import { Schema } from './schema';
|
|
2
3
|
|
|
3
4
|
export type PropertyResolver<T, V, C> = (
|
|
4
5
|
value: V|undefined,
|
|
@@ -12,9 +13,7 @@ export type PropertyResolverMap<T, C> = {
|
|
|
12
13
|
}
|
|
13
14
|
|
|
14
15
|
export interface ResolverConfig<T, C> {
|
|
15
|
-
|
|
16
|
-
// https://github.com/ThomasAribart/json-schema-to-ts/issues/53
|
|
17
|
-
schema?: any,
|
|
16
|
+
schema?: Schema<T>,
|
|
18
17
|
validate?: 'before'|'after'|false,
|
|
19
18
|
properties: PropertyResolverMap<T, C>
|
|
20
19
|
}
|
|
@@ -71,7 +70,7 @@ export class Resolver<T, C> {
|
|
|
71
70
|
|
|
72
71
|
// Not the most elegant but better performance
|
|
73
72
|
await Promise.all(propertyList.map(async name => {
|
|
74
|
-
const value = data[name];
|
|
73
|
+
const value = (data as any)[name];
|
|
75
74
|
|
|
76
75
|
if (resolvers[name]) {
|
|
77
76
|
try {
|
package/src/schema.ts
CHANGED
|
@@ -2,18 +2,29 @@ import Ajv, { AsyncValidateFunction, ValidateFunction } from 'ajv';
|
|
|
2
2
|
import { FromSchema, JSONSchema } from 'json-schema-to-ts';
|
|
3
3
|
import { BadRequest } from '@feathersjs/errors';
|
|
4
4
|
|
|
5
|
-
export const
|
|
5
|
+
export const DEFAULT_AJV = new Ajv({
|
|
6
6
|
coerceTypes: true
|
|
7
7
|
});
|
|
8
8
|
|
|
9
|
-
export
|
|
9
|
+
export { Ajv };
|
|
10
10
|
|
|
11
|
-
export
|
|
11
|
+
export type JSONSchemaDefinition = JSONSchema & {
|
|
12
|
+
$id: string,
|
|
13
|
+
$async?: boolean,
|
|
14
|
+
properties?: { [key: string]: JSONSchema }
|
|
15
|
+
required?: readonly string[]
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
export interface Schema<T> {
|
|
19
|
+
validate <X = T> (...args: Parameters<ValidateFunction<X>>): Promise<X>;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export class SchemaWrapper<S extends JSONSchemaDefinition> implements Schema<FromSchema<S>> {
|
|
12
23
|
ajv: Ajv;
|
|
13
24
|
validator: AsyncValidateFunction;
|
|
14
25
|
readonly _type!: FromSchema<S>;
|
|
15
26
|
|
|
16
|
-
constructor (public definition: S, ajv: Ajv =
|
|
27
|
+
constructor (public definition: S, ajv: Ajv = DEFAULT_AJV) {
|
|
17
28
|
this.ajv = ajv;
|
|
18
29
|
this.validator = this.ajv.compile({
|
|
19
30
|
$async: true,
|
|
@@ -21,6 +32,14 @@ export class Schema<S extends JSONSchemaDefinition> {
|
|
|
21
32
|
}) as AsyncValidateFunction;
|
|
22
33
|
}
|
|
23
34
|
|
|
35
|
+
get properties () {
|
|
36
|
+
return this.definition.properties as S['properties'];
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
get required () {
|
|
40
|
+
return this.definition.required as S['required'];
|
|
41
|
+
}
|
|
42
|
+
|
|
24
43
|
async validate <T = FromSchema<S>> (...args: Parameters<ValidateFunction<T>>) {
|
|
25
44
|
try {
|
|
26
45
|
const validated = await this.validator(...args) as T;
|
|
@@ -36,6 +55,6 @@ export class Schema<S extends JSONSchemaDefinition> {
|
|
|
36
55
|
}
|
|
37
56
|
}
|
|
38
57
|
|
|
39
|
-
export function schema <S extends JSONSchemaDefinition> (definition: S, ajv: Ajv =
|
|
40
|
-
return new
|
|
58
|
+
export function schema <S extends JSONSchemaDefinition> (definition: S, ajv: Ajv = DEFAULT_AJV) {
|
|
59
|
+
return new SchemaWrapper(definition, ajv);
|
|
41
60
|
}
|