@feathersjs/schema 5.0.0-pre.10 → 5.0.0-pre.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/CHANGELOG.md +64 -0
  2. package/lib/query.d.ts +0 -7
  3. package/lib/query.js +1 -9
  4. package/lib/query.js.map +1 -1
  5. package/lib/resolver.d.ts +5 -2
  6. package/lib/resolver.js +6 -3
  7. package/lib/resolver.js.map +1 -1
  8. package/lib/schema.d.ts +7 -8
  9. package/lib/schema.js +13 -16
  10. package/lib/schema.js.map +1 -1
  11. package/package.json +12 -10
  12. package/src/query.ts +0 -8
  13. package/src/resolver.ts +12 -6
  14. package/src/schema.ts +18 -26
package/CHANGELOG.md CHANGED
@@ -3,6 +3,70 @@
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.16](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.15...v5.0.0-pre.16) (2022-01-12)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **schema:** Do not error for schemas without properties ([#2519](https://github.com/feathersjs/feathers/issues/2519)) ([96fdb47](https://github.com/feathersjs/feathers/commit/96fdb47d45fd88a8039aa9cc9ec8aebd98672b95))
12
+ * **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))
13
+
14
+
15
+ ### Features
16
+
17
+ * **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))
18
+ * **schema:** Improve schema typing, validation and extensibility ([#2521](https://github.com/feathersjs/feathers/issues/2521)) ([8c1b350](https://github.com/feathersjs/feathers/commit/8c1b35052792e82d13be03c06583534284fbae82))
19
+
20
+
21
+
22
+
23
+
24
+ # [5.0.0-pre.15](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.14...v5.0.0-pre.15) (2021-11-27)
25
+
26
+
27
+ ### Bug Fixes
28
+
29
+ * **typescript:** Overall typing improvements ([#2478](https://github.com/feathersjs/feathers/issues/2478)) ([b8eb804](https://github.com/feathersjs/feathers/commit/b8eb804158556d9651a8607e3c3fda15e0bfd110))
30
+
31
+
32
+
33
+
34
+
35
+ # [5.0.0-pre.14](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.13...v5.0.0-pre.14) (2021-10-13)
36
+
37
+ **Note:** Version bump only for package @feathersjs/schema
38
+
39
+
40
+
41
+
42
+
43
+ # [5.0.0-pre.13](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.12...v5.0.0-pre.13) (2021-10-13)
44
+
45
+ **Note:** Version bump only for package @feathersjs/schema
46
+
47
+
48
+
49
+
50
+
51
+ # [5.0.0-pre.12](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.11...v5.0.0-pre.12) (2021-10-12)
52
+
53
+ **Note:** Version bump only for package @feathersjs/schema
54
+
55
+
56
+
57
+
58
+
59
+ # [5.0.0-pre.11](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.10...v5.0.0-pre.11) (2021-10-06)
60
+
61
+
62
+ ### Features
63
+
64
+ * **schema:** Allow resolvers to validate a schema ([#2465](https://github.com/feathersjs/feathers/issues/2465)) ([7d9590b](https://github.com/feathersjs/feathers/commit/7d9590bbe12b94b8b5a7987684f5d4968e426481))
65
+
66
+
67
+
68
+
69
+
6
70
  # [5.0.0-pre.10](https://github.com/feathersjs/feathers/compare/v5.0.0-pre.9...v5.0.0-pre.10) (2021-09-19)
7
71
 
8
72
 
package/lib/query.d.ts CHANGED
@@ -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,6 +1,6 @@
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
5
  oneOf: [
6
6
  definition,
@@ -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,8 +1,11 @@
1
- export declare type PropertyResolver<T, V, C> = (value: V | undefined, obj: any, context: C, status: ResolverStatus<T, C>) => Promise<V | undefined>;
1
+ import { Schema } from './schema';
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> {
7
+ schema?: Schema<any>;
8
+ validate?: 'before' | 'after' | false;
6
9
  properties: PropertyResolverMap<T, C>;
7
10
  }
8
11
  export interface ResolverStatus<T, C> {
@@ -16,6 +19,6 @@ export declare class Resolver<T, C> {
16
19
  readonly _type: T;
17
20
  constructor(options: ResolverConfig<T, C>);
18
21
  resolveProperty<D, K extends keyof T>(name: K, data: D, context: C, status?: Partial<ResolverStatus<T, C>>): Promise<T[K]>;
19
- resolve<D>(data: D, context: C, status?: Partial<ResolverStatus<T, C>>): Promise<T>;
22
+ resolve<D>(_data: D, context: C, status?: Partial<ResolverStatus<T, C>>): Promise<T>;
20
23
  }
21
24
  export declare function resolve<T, C>(options: ResolverConfig<T, C>): Resolver<T, C>;
package/lib/resolver.js CHANGED
@@ -21,8 +21,9 @@ class Resolver {
21
21
  };
22
22
  return resolver(value, data, context, resolverStatus);
23
23
  }
24
- async resolve(data, context, status) {
25
- const { properties: resolvers } = this.options;
24
+ async resolve(_data, context, status) {
25
+ const { properties: resolvers, schema, validate } = this.options;
26
+ const data = schema && validate === 'before' ? await schema.validate(_data) : _data;
26
27
  const propertyList = (Array.isArray(status === null || status === void 0 ? void 0 : status.properties)
27
28
  ? status === null || status === void 0 ? void 0 : status.properties
28
29
  // By default get all data and resolver keys but remove duplicates
@@ -56,7 +57,9 @@ class Resolver {
56
57
  if (hasErrors) {
57
58
  throw new errors_1.BadRequest(`Error resolving data ${status === null || status === void 0 ? void 0 : status.properties.join('.')}`, errors);
58
59
  }
59
- return result;
60
+ return schema && validate === 'after'
61
+ ? await schema.validate(result)
62
+ : result;
60
63
  }
61
64
  }
62
65
  exports.Resolver = Resolver;
package/lib/resolver.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"resolver.js","sourceRoot":"","sources":["../src/resolver.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;AAwBhD,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,IAAO,EAAE,OAAU,EAAE,MAAsC;QAC3E,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/C,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,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,CAAC;IAChB,CAAC;CACF;AAzED,4BAyEC;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,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"}
package/lib/schema.d.ts CHANGED
@@ -1,18 +1,17 @@
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
3
  export declare const AJV: Ajv;
5
4
  export declare type JSONSchemaDefinition = JSONSchema & {
6
5
  $id: string;
6
+ $async?: boolean;
7
7
  };
8
8
  export declare class Schema<S extends JSONSchemaDefinition> {
9
+ definition: S;
9
10
  ajv: Ajv;
10
- validate: AsyncValidateFunction<FromSchema<S>>;
11
- definition: JSONSchema6;
12
- propertyNames: string[];
11
+ validator: AsyncValidateFunction;
13
12
  readonly _type: FromSchema<S>;
14
13
  constructor(definition: S, ajv?: Ajv);
15
- extend<D extends JSONSchemaDefinition>(definition: D): Schema<D & S>;
16
- toJSON(): JSONSchema6;
14
+ validate<T = FromSchema<S>>(...args: Parameters<ValidateFunction<T>>): Promise<T>;
15
+ toJSON(): S;
17
16
  }
18
- export declare function schema<S extends JSONSchemaDefinition>(definition: S): Schema<S>;
17
+ export declare function schema<S extends JSONSchemaDefinition>(definition: S, ajv?: Ajv): Schema<S>;
package/lib/schema.js CHANGED
@@ -5,38 +5,35 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.schema = exports.Schema = exports.AJV = void 0;
7
7
  const ajv_1 = __importDefault(require("ajv"));
8
+ const errors_1 = require("@feathersjs/errors");
8
9
  exports.AJV = new ajv_1.default({
9
10
  coerceTypes: true
10
11
  });
11
12
  class Schema {
12
13
  constructor(definition, ajv = exports.AJV) {
13
- this.ajv = ajv;
14
14
  this.definition = definition;
15
- this.propertyNames = Object.keys(this.definition.properties);
16
- this.validate = this.ajv.compile({
15
+ this.ajv = ajv;
16
+ this.validator = this.ajv.compile({
17
17
  $async: true,
18
18
  ...this.definition
19
19
  });
20
20
  }
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);
21
+ async validate(...args) {
22
+ try {
23
+ const validated = await this.validator(...args);
24
+ return validated;
25
+ }
26
+ catch (error) {
27
+ throw new errors_1.BadRequest(error.message, error.errors);
28
+ }
32
29
  }
33
30
  toJSON() {
34
31
  return this.definition;
35
32
  }
36
33
  }
37
34
  exports.Schema = Schema;
38
- function schema(definition) {
39
- return new Schema(definition);
35
+ function schema(definition, ajv = exports.AJV) {
36
+ return new Schema(definition, ajv);
40
37
  }
41
38
  exports.schema = schema;
42
39
  //# 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;AAEnE,+CAAgD;AAEnC,QAAA,GAAG,GAAG,IAAI,aAAG,CAAC;IACzB,WAAW,EAAE,IAAI;CAClB,CAAC,CAAC;AAIH,MAAa,MAAM;IAKjB,YAAoB,UAAa,EAAE,MAAW,WAAG;QAA7B,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,wBA0BC;AAED,SAAgB,MAAM,CAAmC,UAAa,EAAE,MAAW,WAAG;IACpF,OAAO,IAAI,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;AACrC,CAAC;AAFD,wBAEC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@feathersjs/schema",
3
3
  "description": "A common data schema definition format",
4
- "version": "5.0.0-pre.10",
4
+ "version": "5.0.0-pre.16",
5
5
  "homepage": "https://feathersjs.com",
6
6
  "main": "lib/",
7
7
  "keywords": [
@@ -50,19 +50,21 @@
50
50
  "access": "public"
51
51
  },
52
52
  "dependencies": {
53
- "@feathersjs/errors": "^5.0.0-pre.10",
54
- "@feathersjs/feathers": "^5.0.0-pre.10",
55
- "ajv": "^8.6.3",
56
- "json-schema": "^0.3.0",
53
+ "@feathersjs/errors": "^5.0.0-pre.16",
54
+ "@feathersjs/feathers": "^5.0.0-pre.16",
55
+ "@types/json-schema": "^7.0.9",
56
+ "ajv": "^8.8.2",
57
+ "json-schema": "^0.4.0",
57
58
  "json-schema-to-ts": "^1.6.4"
58
59
  },
59
60
  "devDependencies": {
60
- "@feathersjs/memory": "^5.0.0-pre.10",
61
+ "@feathersjs/memory": "^5.0.0-pre.16",
61
62
  "@types/mocha": "^9.0.0",
62
- "@types/node": "^16.9.4",
63
- "mocha": "^9.1.1",
63
+ "@types/node": "^17.0.5",
64
+ "ajv-formats": "^2.1.1",
65
+ "mocha": "^9.1.3",
64
66
  "shx": "^0.3.3",
65
- "typescript": "^4.4.3"
67
+ "typescript": "^4.5.4"
66
68
  },
67
- "gitHead": "a9f7865cce8db2305b7c0d2ef4a165c2724034ef"
69
+ "gitHead": "f0cd227a82d159b528193bd33747c97684a48773"
68
70
  }
package/src/query.ts CHANGED
@@ -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
@@ -1,8 +1,9 @@
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,
5
- obj: any,
6
+ obj: T,
6
7
  context: C,
7
8
  status: ResolverStatus<T, C>
8
9
  ) => Promise<V|undefined>;
@@ -12,6 +13,8 @@ export type PropertyResolverMap<T, C> = {
12
13
  }
13
14
 
14
15
  export interface ResolverConfig<T, C> {
16
+ schema?: Schema<any>,
17
+ validate?: 'before'|'after'|false,
15
18
  properties: PropertyResolverMap<T, C>
16
19
  }
17
20
 
@@ -49,11 +52,12 @@ export class Resolver<T, C> {
49
52
  stack: [...stack, resolver]
50
53
  }
51
54
 
52
- return resolver(value, data, context, resolverStatus);
55
+ return resolver(value, data as any, context, resolverStatus);
53
56
  }
54
57
 
55
- async resolve<D> (data: D, context: C, status?: Partial<ResolverStatus<T, C>>): Promise<T> {
56
- const { properties: resolvers } = this.options;
58
+ async resolve<D> (_data: D, context: C, status?: Partial<ResolverStatus<T, C>>): Promise<T> {
59
+ const { properties: resolvers, schema, validate } = this.options;
60
+ const data = schema && validate === 'before' ? await schema.validate(_data) : _data;
57
61
  const propertyList = (Array.isArray(status?.properties)
58
62
  ? status?.properties
59
63
  // By default get all data and resolver keys but remove duplicates
@@ -66,7 +70,7 @@ export class Resolver<T, C> {
66
70
 
67
71
  // Not the most elegant but better performance
68
72
  await Promise.all(propertyList.map(async name => {
69
- const value = (data as any)[name];
73
+ const value = data[name];
70
74
 
71
75
  if (resolvers[name]) {
72
76
  try {
@@ -93,7 +97,9 @@ export class Resolver<T, C> {
93
97
  throw new BadRequest(`Error resolving data ${status?.properties.join('.')}`, errors);
94
98
  }
95
99
 
96
- return result;
100
+ return schema && validate === 'after'
101
+ ? await schema.validate(result)
102
+ : result;
97
103
  }
98
104
  }
99
105
 
package/src/schema.ts CHANGED
@@ -1,42 +1,34 @@
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
5
  export const AJV = new Ajv({
6
6
  coerceTypes: true
7
7
  });
8
8
 
9
- export type JSONSchemaDefinition = JSONSchema & { $id: string };
9
+ export type JSONSchemaDefinition = JSONSchema & { $id: string, $async?: boolean };
10
10
 
11
11
  export class Schema<S extends JSONSchemaDefinition> {
12
12
  ajv: Ajv;
13
- validate: AsyncValidateFunction<FromSchema<S>>;
14
- definition: JSONSchema6;
15
- propertyNames: string[];
13
+ validator: AsyncValidateFunction;
16
14
  readonly _type!: FromSchema<S>;
17
15
 
18
- constructor (definition: S, ajv: Ajv = AJV) {
16
+ constructor (public definition: S, ajv: Ajv = AJV) {
19
17
  this.ajv = ajv;
20
- this.definition = definition as JSONSchema6;
21
- this.propertyNames = Object.keys(this.definition.properties)
22
- this.validate = this.ajv.compile({
18
+ this.validator = this.ajv.compile({
23
19
  $async: true,
24
- ...this.definition
25
- });
20
+ ...(this.definition as any)
21
+ }) as AsyncValidateFunction;
26
22
  }
27
23
 
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);
24
+ async validate <T = FromSchema<S>> (...args: Parameters<ValidateFunction<T>>) {
25
+ try {
26
+ const validated = await this.validator(...args) as T;
27
+
28
+ return validated;
29
+ } catch (error: any) {
30
+ throw new BadRequest(error.message, error.errors);
31
+ }
40
32
  }
41
33
 
42
34
  toJSON () {
@@ -44,6 +36,6 @@ export class Schema<S extends JSONSchemaDefinition> {
44
36
  }
45
37
  }
46
38
 
47
- export function schema <S extends JSONSchemaDefinition> (definition: S) {
48
- return new Schema(definition);
39
+ export function schema <S extends JSONSchemaDefinition> (definition: S, ajv: Ajv = AJV) {
40
+ return new Schema(definition, ajv);
49
41
  }