@feathersjs/schema 5.0.0-pre.15 → 5.0.0-pre.18

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 CHANGED
@@ -3,6 +3,53 @@
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.18](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.17...v5.0.0-pre.18) (2022-04-11)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **schema:** result resolver correctly resolves paginated find result ([#2594](https://github.com/feathersjs/feathers/issues/2594)) ([6511e45](https://github.com/feathersjs/feathers/commit/6511e45bd0624f1a629530719709f4b27fecbe0b))
12
+
13
+
14
+ ### Features
15
+
16
+ * **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))
17
+
18
+
19
+
20
+
21
+
22
+ # [5.0.0-pre.17](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.16...v5.0.0-pre.17) (2022-02-15)
23
+
24
+
25
+ ### Bug Fixes
26
+
27
+ * **hooks:** Allow all built-in hooks to be used the async and regular way ([#2559](https://github.com/feathersjs/feathers/issues/2559)) ([8f9f631](https://github.com/feathersjs/feathers/commit/8f9f631e0ce89de349207db72def84e7ab496a4a))
28
+ * **queryProperty:** allow compound oneOf ([#2545](https://github.com/feathersjs/feathers/issues/2545)) ([3077d2d](https://github.com/feathersjs/feathers/commit/3077d2d896a38d579ce4d5b530e21ad332bcf221))
29
+ * **schema:** Properly handle resolver errors ([#2540](https://github.com/feathersjs/feathers/issues/2540)) ([31fbdff](https://github.com/feathersjs/feathers/commit/31fbdff8bd848ac7e0eda56e307ac34b1bfcf17f))
30
+
31
+
32
+
33
+
34
+
35
+ # [5.0.0-pre.16](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.15...v5.0.0-pre.16) (2022-01-12)
36
+
37
+
38
+ ### Bug Fixes
39
+
40
+ * **schema:** Do not error for schemas without properties ([#2519](https://github.com/feathersjs/feathers/issues/2519)) ([96fdb47](https://github.com/feathersjs/feathers/commit/96fdb47d45fd88a8039aa9cc9ec8aebd98672b95))
41
+ * **schema:** Fix resolver data type and use new validation feature in test fixture ([#2523](https://github.com/feathersjs/feathers/issues/2523)) ([1093f12](https://github.com/feathersjs/feathers/commit/1093f124b60524cbd9050fcf07ddaf1d558973da))
42
+
43
+
44
+ ### Features
45
+
46
+ * **schema:** Allow to use custom AJV and test with ajv-formats ([#2513](https://github.com/feathersjs/feathers/issues/2513)) ([ecfa4df](https://github.com/feathersjs/feathers/commit/ecfa4df29f029f6ca8517cacf518c14b46ffeb4e))
47
+ * **schema:** Improve schema typing, validation and extensibility ([#2521](https://github.com/feathersjs/feathers/issues/2521)) ([8c1b350](https://github.com/feathersjs/feathers/commit/8c1b35052792e82d13be03c06583534284fbae82))
48
+
49
+
50
+
51
+
52
+
6
53
  # [5.0.0-pre.15](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.14...v5.0.0-pre.15) (2021-11-27)
7
54
 
8
55
 
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  The MIT License (MIT)
2
2
 
3
- Copyright (c) 2021 Feathers
3
+ Copyright (c) 2022 Feathers
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # @feathersjs/schema
2
2
 
3
3
  [![CI](https://github.com/feathersjs/feathers/workflows/CI/badge.svg)](https://github.com/feathersjs/feathers/actions?query=workflow%3ACI)
4
- [![Dependency Status](https://img.shields.io/david/feathersjs/feathers.svg?style=flat-square&path=packages/socketio)](https://david-dm.org/feathersjs/feathers?path=packages/schema)
5
4
  [![Download Status](https://img.shields.io/npm/dm/@feathersjs/schema.svg?style=flat-square)](https://www.npmjs.com/package/@feathersjs/schema)
5
+ [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://discord.gg/qa8kez8QBx)
6
6
 
7
7
  > A common data schema definition format
8
8
 
@@ -18,6 +18,6 @@ Refer to the [Feathers documentation](https://docs.feathersjs.com) for more deta
18
18
 
19
19
  ## License
20
20
 
21
- Copyright (c) 2021 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
21
+ Copyright (c) 2022 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors)
22
22
 
23
23
  Licensed under the [MIT license](LICENSE).
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>(resolver: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>) => (context: HookContext, next: NextFunction) => Promise<any>;
5
- export declare const resolveData: <T>(resolver: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>) => (context: HookContext, next: NextFunction) => Promise<any>;
6
- export declare const resolveResult: <T>(resolver: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>) => (context: HookContext, next: NextFunction) => Promise<void>;
7
- export declare const validateQuery: (schema: Schema<any>) => (context: HookContext, next: NextFunction) => Promise<any>;
8
- export declare const validateData: (schema: Schema<any>) => (context: HookContext, next: NextFunction) => Promise<any>;
4
+ export declare const resolveQuery: <T>(resolver: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>) => (context: HookContext, next?: NextFunction) => Promise<any>;
5
+ export declare const resolveData: <T>(resolver: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>) => (context: HookContext, next?: NextFunction) => Promise<any>;
6
+ export declare const resolveResult: <T>(resolver: Resolver<T, HookContext<import("@feathersjs/feathers").Application<any, any>, any>>) => (context: HookContext, next?: NextFunction) => Promise<void>;
7
+ export declare const validateQuery: (schema: Schema<any>) => (context: HookContext, next?: NextFunction) => Promise<any>;
8
+ export declare const validateData: (schema: Schema<any>) => (context: HookContext, next?: NextFunction) => Promise<any>;
package/lib/hooks.js CHANGED
@@ -22,7 +22,9 @@ const resolveQuery = (resolver) => async (context, next) => {
22
22
  ...context.params,
23
23
  query
24
24
  };
25
- return next();
25
+ if (typeof next === 'function') {
26
+ return next();
27
+ }
26
28
  };
27
29
  exports.resolveQuery = resolveQuery;
28
30
  const resolveData = (resolver) => async (context, next) => {
@@ -37,32 +39,39 @@ const resolveData = (resolver) => async (context, next) => {
37
39
  else {
38
40
  context.data = await resolver.resolve(data, ctx, status);
39
41
  }
40
- return next();
42
+ if (typeof next === 'function') {
43
+ return next();
44
+ }
41
45
  };
42
46
  exports.resolveData = resolveData;
43
47
  const resolveResult = (resolver) => async (context, next) => {
44
48
  var _a;
45
- const { $resolve: properties, ...query } = ((_a = context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
46
- const { resolve } = context.params;
47
- const status = {
48
- originalContext: context,
49
- ...resolve,
50
- properties
51
- };
52
- context.params = {
53
- ...context.params,
54
- query
55
- };
56
- await next();
49
+ if (typeof next === 'function') {
50
+ const { $resolve: properties, ...query } = ((_a = context.params) === null || _a === void 0 ? void 0 : _a.query) || {};
51
+ const resolve = {
52
+ originalContext: context,
53
+ ...context.params.resolve,
54
+ properties
55
+ };
56
+ context.params = {
57
+ ...context.params,
58
+ resolve,
59
+ query
60
+ };
61
+ await next();
62
+ }
57
63
  const ctx = getContext(context);
58
- const data = context.method === 'find' && context.result.data
59
- ? context.result.data
60
- : context.result;
61
- if (Array.isArray(data)) {
62
- context.result = await Promise.all(data.map(current => resolver.resolve(current, ctx, status)));
64
+ const status = context.params.resolve;
65
+ const isPaginated = context.method === 'find' && context.result.data;
66
+ const data = isPaginated ? context.result.data : context.result;
67
+ const result = Array.isArray(data) ?
68
+ await Promise.all(data.map(async (current) => resolver.resolve(current, ctx, status))) :
69
+ await resolver.resolve(data, ctx, status);
70
+ if (isPaginated) {
71
+ context.result.data = result;
63
72
  }
64
73
  else {
65
- context.result = await resolver.resolve(data, ctx, status);
74
+ context.result = result;
66
75
  }
67
76
  };
68
77
  exports.resolveResult = resolveResult;
@@ -75,7 +84,9 @@ const validateQuery = (schema) => async (context, next) => {
75
84
  ...context.params,
76
85
  query
77
86
  };
78
- return next();
87
+ if (typeof next === 'function') {
88
+ return next();
89
+ }
79
90
  }
80
91
  catch (error) {
81
92
  throw (error.ajv ? new lib_1.BadRequest(error.message, error.errors) : error);
@@ -95,7 +106,9 @@ const validateData = (schema) => async (context, next) => {
95
106
  catch (error) {
96
107
  throw (error.ajv ? new lib_1.BadRequest(error.message, error.errors) : error);
97
108
  }
98
- return next();
109
+ if (typeof next === 'function') {
110
+ return next();
111
+ }
99
112
  };
100
113
  exports.validateData = validateData;
101
114
  //# sourceMappingURL=hooks.js.map
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,QAAkC,EAAE,EAAE,CACrE,KAAK,EAAE,OAAoB,EAAE,IAAkB,EAAE,EAAE;;IACjD,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,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE;QAC9C,eAAe,EAAE,OAAO;KACzB,CAAC,CAAC;IAEH,OAAO,CAAC,MAAM,GAAG;QACf,GAAG,OAAO,CAAC,MAAM;QACjB,KAAK;KACN,CAAA;IAED,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC,CAAC;AAdS,QAAA,YAAY,gBAcrB;AAEG,MAAM,WAAW,GAAG,CAAK,QAAkC,EAAE,EAAE,CACpE,KAAK,EAAE,OAAoB,EAAE,IAAkB,EAAE,EAAE;IACjD,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,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CACvC,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,CAAC,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KAC1D;IAED,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC,CAAC;AAjBS,QAAA,WAAW,eAiBpB;AAEG,MAAM,aAAa,GAAG,CAAK,QAAkC,EAAE,EAAE,CACtE,KAAK,EAAE,OAAoB,EAAE,IAAkB,EAAE,EAAE;;IACjD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,KAAK,EAAE,GAAG,CAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,KAAK,KAAI,EAAE,CAAC;IACvE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IACnC,MAAM,MAAM,GAAG;QACb,eAAe,EAAE,OAAO;QACxB,GAAG,OAAO;QACV,UAAU;KACX,CAAC;IAEF,OAAO,CAAC,MAAM,GAAG;QACf,GAAG,OAAO,CAAC,MAAM;QACjB,KAAK;KACN,CAAA;IAED,MAAM,IAAI,EAAE,CAAC;IAEb,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,IAAI;QAC3D,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI;QACrB,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IAEnB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QACvB,OAAO,CAAC,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CACpD,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CACvC,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,CAAC,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KAC5D;AACH,CAAC,CAAC;AA7BS,QAAA,aAAa,iBA6BtB;AAEG,MAAM,aAAa,GAAG,CAAC,MAAmB,EAAE,EAAE,CACnD,KAAK,EAAE,OAAoB,EAAE,IAAkB,EAAE,EAAE;;IACjD,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,OAAO,IAAI,EAAE,CAAC;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;AAhBS,QAAA,aAAa,iBAgBtB;AAEG,MAAM,YAAY,GAAG,CAAC,MAAmB,EAAE,EAAE,CAClD,KAAK,EAAE,OAAoB,EAAE,IAAkB,EAAE,EAAE;IACjD,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,OAAO,IAAI,EAAE,CAAC;AAChB,CAAC,CAAC;AAjBS,QAAA,YAAY,gBAiBrB"}
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,QAAkC,EAAE,EAAE,CACrE,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,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE;QAC9C,eAAe,EAAE,OAAO;KACzB,CAAC,CAAC;IAEH,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;AAhBS,QAAA,YAAY,gBAgBrB;AAEG,MAAM,WAAW,GAAG,CAAK,QAAkC,EAAE,EAAE,CACpE,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,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CACvC,CAAC,CAAC;KACJ;SAAM;QACL,OAAO,CAAC,IAAI,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;KAC1D;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,QAAkC,EAAE,EAAE,CACtE,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,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QACtF,MAAM,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAE5C,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.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
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":";;;;;;;;;;;;AAEA,2CAAyB;AACzB,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB"}
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,6 +1,6 @@
1
1
  import { JSONSchema } from 'json-schema-to-ts';
2
2
  export declare const queryProperty: <T extends JSONSchema>(definition: T) => {
3
- readonly oneOf: readonly [T, {
3
+ readonly anyOf: readonly [T, {
4
4
  readonly type: "object";
5
5
  readonly additionalProperties: false;
6
6
  readonly properties: {
@@ -20,10 +20,3 @@ export declare const queryProperty: <T extends JSONSchema>(definition: T) => {
20
20
  };
21
21
  }];
22
22
  };
23
- export declare const queryArray: <T extends readonly string[]>(fields: T) => {
24
- readonly type: "array";
25
- readonly items: {
26
- readonly type: "string";
27
- readonly enum: T;
28
- };
29
- };
package/lib/query.js CHANGED
@@ -1,8 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.queryArray = exports.queryProperty = void 0;
3
+ exports.queryProperty = void 0;
4
4
  const queryProperty = (definition) => ({
5
- oneOf: [
5
+ anyOf: [
6
6
  definition,
7
7
  {
8
8
  type: 'object',
@@ -26,12 +26,4 @@ const queryProperty = (definition) => ({
26
26
  ]
27
27
  });
28
28
  exports.queryProperty = queryProperty;
29
- const queryArray = (fields) => ({
30
- type: 'array',
31
- items: {
32
- type: 'string',
33
- enum: fields
34
- }
35
- });
36
- exports.queryArray = queryArray;
37
29
  //# 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":";;;AAEO,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,UAAU,GAAG,CAA+B,MAAS,EAAE,EAAE,CAAC,CAAC;IACtE,IAAI,EAAE,OAAO;IACb,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM;KACb;CACQ,CAAA,CAAC;AANC,QAAA,UAAU,cAMX"}
1
+ {"version":3,"file":"query.js","sourceRoot":"","sources":["../src/query.ts"],"names":[],"mappings":";;;AAEO,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"}
package/lib/resolver.d.ts CHANGED
@@ -1,17 +1,17 @@
1
1
  import { Schema } from './schema';
2
- export declare type PropertyResolver<T, V, C> = (value: V | undefined, obj: any, context: C, status: ResolverStatus<T, C>) => Promise<V | undefined>;
2
+ export declare type PropertyResolver<T, V, C> = (value: V | undefined, obj: T, context: C, status: ResolverStatus<T, C>) => Promise<V | undefined>;
3
3
  export declare type PropertyResolverMap<T, C> = {
4
4
  [key in keyof T]?: PropertyResolver<T, T[key], C>;
5
5
  };
6
6
  export interface ResolverConfig<T, C> {
7
- schema?: Schema<any>;
7
+ schema?: Schema<T>;
8
8
  validate?: 'before' | 'after' | false;
9
9
  properties: PropertyResolverMap<T, C>;
10
10
  }
11
11
  export interface ResolverStatus<T, C> {
12
12
  path: string[];
13
13
  originalContext?: C;
14
- properties?: (keyof T)[];
14
+ properties?: string[];
15
15
  stack: PropertyResolver<T, any, C>[];
16
16
  }
17
17
  export declare class Resolver<T, C> {
package/lib/resolver.js CHANGED
@@ -55,7 +55,8 @@ class Resolver {
55
55
  }
56
56
  }));
57
57
  if (hasErrors) {
58
- throw new errors_1.BadRequest(`Error resolving data ${status === null || status === void 0 ? void 0 : status.properties.join('.')}`, errors);
58
+ const propertyName = (status === null || status === void 0 ? void 0 : status.properties) ? ` ${status.properties.join('.')}` : '';
59
+ throw new errors_1.BadRequest('Error resolving data' + propertyName, errors);
59
60
  }
60
61
  return schema && validate === 'after'
61
62
  ? await schema.validate(result)
@@ -1 +1 @@
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,IAAI,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;IACxD,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,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB,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,IAAI,mBAAU,CAAC,wBAAwB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;SACtF;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;AA5ED,4BA4EC;AAED,SAAgB,OAAO,CAAS,OAA6B;IAC3D,OAAO,IAAI,QAAQ,CAAO,OAAO,CAAC,CAAC;AACrC,CAAC;AAFD,0BAEC"}
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,18 +1,21 @@
1
- import Ajv, { AsyncValidateFunction } from 'ajv';
2
- import { JSONSchema6 } from 'json-schema';
1
+ import Ajv, { AsyncValidateFunction, ValidateFunction } from 'ajv';
3
2
  import { FromSchema, JSONSchema } from 'json-schema-to-ts';
4
- export declare const AJV: Ajv;
3
+ export declare const DEFAULT_AJV: Ajv;
4
+ export { Ajv };
5
5
  export declare type JSONSchemaDefinition = JSONSchema & {
6
6
  $id: string;
7
+ $async?: boolean;
7
8
  };
8
- export declare class Schema<S extends JSONSchemaDefinition> {
9
+ export interface Schema<T> {
10
+ validate<X = T>(...args: Parameters<ValidateFunction<X>>): Promise<X>;
11
+ }
12
+ export declare class SchemaWrapper<S extends JSONSchemaDefinition> implements Schema<FromSchema<S>> {
13
+ definition: S;
9
14
  ajv: Ajv;
10
- validate: AsyncValidateFunction<FromSchema<S>>;
11
- definition: JSONSchema6;
12
- propertyNames: string[];
15
+ validator: AsyncValidateFunction;
13
16
  readonly _type: FromSchema<S>;
14
17
  constructor(definition: S, ajv?: Ajv);
15
- extend<D extends JSONSchemaDefinition>(definition: D): Schema<D & S>;
16
- toJSON(): JSONSchema6;
18
+ validate<T = FromSchema<S>>(...args: Parameters<ValidateFunction<T>>): Promise<T>;
19
+ toJSON(): S;
17
20
  }
18
- export declare function schema<S extends JSONSchemaDefinition>(definition: S): Schema<S>;
21
+ export declare function schema<S extends JSONSchemaDefinition>(definition: S, ajv?: Ajv): SchemaWrapper<S>;
package/lib/schema.js CHANGED
@@ -3,40 +3,38 @@ 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.Schema = exports.AJV = void 0;
6
+ exports.schema = exports.SchemaWrapper = exports.Ajv = exports.DEFAULT_AJV = void 0;
7
7
  const ajv_1 = __importDefault(require("ajv"));
8
- exports.AJV = new ajv_1.default({
8
+ exports.Ajv = ajv_1.default;
9
+ const errors_1 = require("@feathersjs/errors");
10
+ exports.DEFAULT_AJV = new ajv_1.default({
9
11
  coerceTypes: true
10
12
  });
11
- class Schema {
12
- constructor(definition, ajv = exports.AJV) {
13
- this.ajv = ajv;
13
+ class SchemaWrapper {
14
+ constructor(definition, ajv = exports.DEFAULT_AJV) {
14
15
  this.definition = definition;
15
- this.propertyNames = Object.keys(this.definition.properties);
16
- this.validate = this.ajv.compile({
16
+ this.ajv = ajv;
17
+ this.validator = this.ajv.compile({
17
18
  $async: true,
18
19
  ...this.definition
19
20
  });
20
21
  }
21
- extend(definition) {
22
- const def = definition;
23
- const extended = {
24
- ...this.definition,
25
- ...def,
26
- properties: {
27
- ...this.definition.properties,
28
- ...def.properties
29
- }
30
- };
31
- return new Schema(extended, this.ajv);
22
+ async validate(...args) {
23
+ try {
24
+ const validated = await this.validator(...args);
25
+ return validated;
26
+ }
27
+ catch (error) {
28
+ throw new errors_1.BadRequest(error.message, error.errors);
29
+ }
32
30
  }
33
31
  toJSON() {
34
32
  return this.definition;
35
33
  }
36
34
  }
37
- exports.Schema = Schema;
38
- function schema(definition) {
39
- return new Schema(definition);
35
+ exports.SchemaWrapper = SchemaWrapper;
36
+ function schema(definition, ajv = exports.DEFAULT_AJV) {
37
+ return new SchemaWrapper(definition, ajv);
40
38
  }
41
39
  exports.schema = schema;
42
40
  //# 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,8CAAiD;AAIpC,QAAA,GAAG,GAAG,IAAI,aAAG,CAAC;IACzB,WAAW,EAAE,IAAI;CAClB,CAAC,CAAC;AAIH,MAAa,MAAM;IAOjB,YAAa,UAAa,EAAE,MAAW,WAAG;QACxC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,UAAU,GAAG,UAAyB,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAA;QAC5D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC;YAC/B,MAAM,EAAE,IAAI;YACZ,GAAG,IAAI,CAAC,UAAU;SACnB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAmC,UAAa;QACpD,MAAM,GAAG,GAAG,UAAyB,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,GAAG,IAAI,CAAC,UAAU;YAClB,GAAG,GAAG;YACN,UAAU,EAAE;gBACV,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU;gBAC7B,GAAG,GAAG,CAAC,UAAU;aAClB;SACO,CAAC;QAEX,OAAO,IAAI,MAAM,CAAU,QAAe,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAlCD,wBAkCC;AAED,SAAgB,MAAM,CAAmC,UAAa;IACpE,OAAO,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC;AAChC,CAAC;AAFD,wBAEC"}
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;AAUH,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,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;AA1BD,sCA0BC;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.15",
4
+ "version": "5.0.0-pre.18",
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
- "test": "mocha --config ../../.mocharc.json --recursive test/**.test.ts test/**/*.test.ts"
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,20 +53,21 @@
50
53
  "access": "public"
51
54
  },
52
55
  "dependencies": {
53
- "@feathersjs/errors": "^5.0.0-pre.15",
54
- "@feathersjs/feathers": "^5.0.0-pre.15",
55
- "@types/json-schema": "^7.0.9",
56
- "ajv": "^8.6.3",
57
- "json-schema": "^0.3.0",
58
- "json-schema-to-ts": "^1.6.4"
56
+ "@feathersjs/errors": "^5.0.0-pre.18",
57
+ "@feathersjs/feathers": "^5.0.0-pre.18",
58
+ "@types/json-schema": "^7.0.11",
59
+ "ajv": "^8.11.0",
60
+ "json-schema": "^0.4.0",
61
+ "json-schema-to-ts": "^1.6.5"
59
62
  },
60
63
  "devDependencies": {
61
- "@feathersjs/memory": "^5.0.0-pre.15",
62
- "@types/mocha": "^9.0.0",
63
- "@types/node": "^16.11.6",
64
- "mocha": "^9.1.3",
65
- "shx": "^0.3.3",
66
- "typescript": "^4.4.4"
64
+ "@feathersjs/memory": "^5.0.0-pre.18",
65
+ "@types/mocha": "^9.1.0",
66
+ "@types/node": "^17.0.23",
67
+ "ajv-formats": "^2.1.1",
68
+ "mocha": "^9.2.2",
69
+ "shx": "^0.3.4",
70
+ "typescript": "^4.6.3"
67
71
  },
68
- "gitHead": "8008bf4f8529a2a40b6a2f976c1f43ae13675693"
72
+ "gitHead": "c0b7b67d872dcd6b6d94e4587f21332c8a519b50"
69
73
  }
package/src/hooks.ts CHANGED
@@ -14,7 +14,7 @@ const getContext = (context: HookContext) => {
14
14
  }
15
15
 
16
16
  export const resolveQuery = <T> (resolver: Resolver<T, HookContext>) =>
17
- async (context: HookContext, next: NextFunction) => {
17
+ async (context: HookContext, next?: NextFunction) => {
18
18
  const ctx = getContext(context);
19
19
  const data = context?.params?.query || {};
20
20
  const query = await resolver.resolve(data, ctx, {
@@ -26,11 +26,13 @@ export const resolveQuery = <T> (resolver: Resolver<T, HookContext>) =>
26
26
  query
27
27
  }
28
28
 
29
- return next();
29
+ if (typeof next === 'function') {
30
+ return next();
31
+ }
30
32
  };
31
33
 
32
34
  export const resolveData = <T> (resolver: Resolver<T, HookContext>) =>
33
- async (context: HookContext, next: NextFunction) => {
35
+ async (context: HookContext, next?: NextFunction) => {
34
36
  const ctx = getContext(context);
35
37
  const data = context.data;
36
38
  const status = {
@@ -45,42 +47,49 @@ export const resolveData = <T> (resolver: Resolver<T, HookContext>) =>
45
47
  context.data = await resolver.resolve(data, ctx, status);
46
48
  }
47
49
 
48
- return next();
50
+ if (typeof next === 'function') {
51
+ return next();
52
+ }
49
53
  };
50
54
 
51
55
  export const resolveResult = <T> (resolver: Resolver<T, HookContext>) =>
52
- async (context: HookContext, next: NextFunction) => {
53
- const { $resolve: properties, ...query } = context.params?.query || {};
54
- const { resolve } = context.params;
55
- const status = {
56
- originalContext: context,
57
- ...resolve,
58
- properties
59
- };
56
+ async (context: HookContext, next?: NextFunction) => {
57
+ if (typeof next === 'function') {
58
+ const { $resolve: properties, ...query } = context.params?.query || {};
59
+ const resolve = {
60
+ originalContext: context,
61
+ ...context.params.resolve,
62
+ properties
63
+ };
60
64
 
61
- context.params = {
62
- ...context.params,
63
- query
64
- }
65
+ context.params = {
66
+ ...context.params,
67
+ resolve,
68
+ query
69
+ }
65
70
 
66
- await next();
71
+ await next();
72
+ }
67
73
 
68
74
  const ctx = getContext(context);
69
- const data = context.method === 'find' && context.result.data
70
- ? context.result.data
71
- : context.result;
75
+ const status = context.params.resolve;
72
76
 
73
- if (Array.isArray(data)) {
74
- context.result = await Promise.all(data.map(current =>
75
- resolver.resolve(current, ctx, status)
76
- ));
77
+ const isPaginated = context.method === 'find' && context.result.data;
78
+ const data = isPaginated ? context.result.data : context.result;
79
+
80
+ const result = Array.isArray(data) ?
81
+ await Promise.all(data.map(async current => resolver.resolve(current, ctx, status))) :
82
+ await resolver.resolve(data, ctx, status);
83
+
84
+ if (isPaginated) {
85
+ context.result.data = result;
77
86
  } else {
78
- context.result = await resolver.resolve(data, ctx, status);
87
+ context.result = result;
79
88
  }
80
89
  };
81
90
 
82
91
  export const validateQuery = (schema: Schema<any>) =>
83
- async (context: HookContext, next: NextFunction) => {
92
+ async (context: HookContext, next?: NextFunction) => {
84
93
  const data = context?.params?.query || {};
85
94
 
86
95
  try {
@@ -91,14 +100,16 @@ export const validateQuery = (schema: Schema<any>) =>
91
100
  query
92
101
  }
93
102
 
94
- return next();
103
+ if (typeof next === 'function') {
104
+ return next();
105
+ }
95
106
  } catch (error: any) {
96
107
  throw (error.ajv ? new BadRequest(error.message, error.errors) : error);
97
108
  }
98
109
  };
99
110
 
100
111
  export const validateData = (schema: Schema<any>) =>
101
- async (context: HookContext, next: NextFunction) => {
112
+ async (context: HookContext, next?: NextFunction) => {
102
113
  const data = context.data;
103
114
 
104
115
  try {
@@ -113,5 +124,7 @@ export const validateData = (schema: Schema<any>) =>
113
124
  throw (error.ajv ? new BadRequest(error.message, error.errors) : error);
114
125
  }
115
126
 
116
- return next();
127
+ if (typeof next === 'function') {
128
+ return next();
129
+ }
117
130
  };
package/src/query.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { JSONSchema } from 'json-schema-to-ts';
2
2
 
3
3
  export const queryProperty = <T extends JSONSchema> (definition: T) => ({
4
- oneOf: [
4
+ anyOf: [
5
5
  definition,
6
6
  {
7
7
  type: 'object',
@@ -24,11 +24,3 @@ export const queryProperty = <T extends JSONSchema> (definition: T) => ({
24
24
  }
25
25
  ]
26
26
  } as const);
27
-
28
- export const queryArray = <T extends readonly string[]> (fields: T) => ({
29
- type: 'array',
30
- items: {
31
- type: 'string',
32
- enum: fields
33
- }
34
- } as const);
package/src/resolver.ts CHANGED
@@ -3,7 +3,7 @@ import { Schema } from './schema';
3
3
 
4
4
  export type PropertyResolver<T, V, C> = (
5
5
  value: V|undefined,
6
- obj: any,
6
+ obj: T,
7
7
  context: C,
8
8
  status: ResolverStatus<T, C>
9
9
  ) => Promise<V|undefined>;
@@ -13,7 +13,7 @@ export type PropertyResolverMap<T, C> = {
13
13
  }
14
14
 
15
15
  export interface ResolverConfig<T, C> {
16
- schema?: Schema<any>,
16
+ schema?: Schema<T>,
17
17
  validate?: 'before'|'after'|false,
18
18
  properties: PropertyResolverMap<T, C>
19
19
  }
@@ -21,7 +21,7 @@ export interface ResolverConfig<T, C> {
21
21
  export interface ResolverStatus<T, C> {
22
22
  path: string[];
23
23
  originalContext?: C;
24
- properties?: (keyof T)[];
24
+ properties?: string[];
25
25
  stack: PropertyResolver<T, any, C>[];
26
26
  }
27
27
 
@@ -52,7 +52,7 @@ export class Resolver<T, C> {
52
52
  stack: [...stack, resolver]
53
53
  }
54
54
 
55
- return resolver(value, data, context, resolverStatus);
55
+ return resolver(value, data as any, context, resolverStatus);
56
56
  }
57
57
 
58
58
  async resolve<D> (_data: D, context: C, status?: Partial<ResolverStatus<T, C>>): Promise<T> {
@@ -70,7 +70,7 @@ export class Resolver<T, C> {
70
70
 
71
71
  // Not the most elegant but better performance
72
72
  await Promise.all(propertyList.map(async name => {
73
- const value = data[name];
73
+ const value = (data as any)[name];
74
74
 
75
75
  if (resolvers[name]) {
76
76
  try {
@@ -94,7 +94,9 @@ export class Resolver<T, C> {
94
94
  }));
95
95
 
96
96
  if (hasErrors) {
97
- throw new BadRequest(`Error resolving data ${status?.properties.join('.')}`, errors);
97
+ const propertyName = status?.properties ? ` ${status.properties.join('.')}` : '';
98
+
99
+ throw new BadRequest('Error resolving data' + propertyName, errors);
98
100
  }
99
101
 
100
102
  return schema && validate === 'after'
package/src/schema.ts CHANGED
@@ -1,42 +1,40 @@
1
- import Ajv, { AsyncValidateFunction } from 'ajv';
2
- import { JSONSchema6 } from 'json-schema';
1
+ import Ajv, { AsyncValidateFunction, ValidateFunction } from 'ajv';
3
2
  import { FromSchema, JSONSchema } from 'json-schema-to-ts';
3
+ import { BadRequest } from '@feathersjs/errors';
4
4
 
5
- export const AJV = new Ajv({
5
+ export const DEFAULT_AJV = new Ajv({
6
6
  coerceTypes: true
7
7
  });
8
8
 
9
- export type JSONSchemaDefinition = JSONSchema & { $id: string };
9
+ export { Ajv };
10
10
 
11
- export class Schema<S extends JSONSchemaDefinition> {
11
+ export type JSONSchemaDefinition = JSONSchema & { $id: string, $async?: boolean };
12
+
13
+ export interface Schema<T> {
14
+ validate <X = T> (...args: Parameters<ValidateFunction<X>>): Promise<X>;
15
+ }
16
+
17
+ export class SchemaWrapper<S extends JSONSchemaDefinition> implements Schema<FromSchema<S>> {
12
18
  ajv: Ajv;
13
- validate: AsyncValidateFunction<FromSchema<S>>;
14
- definition: JSONSchema6;
15
- propertyNames: string[];
19
+ validator: AsyncValidateFunction;
16
20
  readonly _type!: FromSchema<S>;
17
21
 
18
- constructor (definition: S, ajv: Ajv = AJV) {
22
+ constructor (public definition: S, ajv: Ajv = DEFAULT_AJV) {
19
23
  this.ajv = ajv;
20
- this.definition = definition as JSONSchema6;
21
- this.propertyNames = Object.keys(this.definition.properties)
22
- this.validate = this.ajv.compile({
24
+ this.validator = this.ajv.compile({
23
25
  $async: true,
24
- ...this.definition
25
- });
26
+ ...(this.definition as any)
27
+ }) as AsyncValidateFunction;
26
28
  }
27
29
 
28
- extend <D extends JSONSchemaDefinition> (definition: D) {
29
- const def = definition as JSONSchema6;
30
- const extended = {
31
- ...this.definition,
32
- ...def,
33
- properties: {
34
- ...this.definition.properties,
35
- ...def.properties
36
- }
37
- } as const;
38
-
39
- return new Schema <D & S> (extended as any, this.ajv);
30
+ async validate <T = FromSchema<S>> (...args: Parameters<ValidateFunction<T>>) {
31
+ try {
32
+ const validated = await this.validator(...args) as T;
33
+
34
+ return validated;
35
+ } catch (error: any) {
36
+ throw new BadRequest(error.message, error.errors);
37
+ }
40
38
  }
41
39
 
42
40
  toJSON () {
@@ -44,6 +42,6 @@ export class Schema<S extends JSONSchemaDefinition> {
44
42
  }
45
43
  }
46
44
 
47
- export function schema <S extends JSONSchemaDefinition> (definition: S) {
48
- return new Schema(definition);
45
+ export function schema <S extends JSONSchemaDefinition> (definition: S, ajv: Ajv = DEFAULT_AJV) {
46
+ return new SchemaWrapper(definition, ajv);
49
47
  }