@aws-lambda-powertools/validation 2.36.0 → 2.37.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -131,7 +131,7 @@ import type { ValidatorOptions } from './types.js';
131
131
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
132
132
  * @param options.formats - Optional formats for validation.
133
133
  * @param options.externalRefs - Optional external references for validation.
134
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
134
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
135
135
  */
136
136
  declare function validator(options: ValidatorOptions): (_target: unknown, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;
137
137
  export { validator };
@@ -136,7 +136,7 @@ const validate_js_1 = require("./validate.js");
136
136
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
137
137
  * @param options.formats - Optional formats for validation.
138
138
  * @param options.externalRefs - Optional external references for validation.
139
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
139
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
140
140
  */
141
141
  function validator(options) {
142
142
  return (_target, _propertyKey, descriptor) => {
@@ -95,7 +95,7 @@ import type { ValidatorOptions } from './types.js';
95
95
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
96
96
  * @param options.formats - Optional formats for validation.
97
97
  * @param options.externalRefs - Optional external references for validation.
98
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
98
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
99
99
  */
100
100
  declare const validator: (options: ValidatorOptions) => {
101
101
  before: MiddlewareFn;
@@ -99,7 +99,7 @@ const validate_js_1 = require("./validate.js");
99
99
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
100
100
  * @param options.formats - Optional formats for validation.
101
101
  * @param options.externalRefs - Optional external references for validation.
102
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
102
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
103
103
  */
104
104
  const validator = (options) => {
105
105
  const before = (request) => {
@@ -7,7 +7,7 @@ import type { Ajv, AnySchema, Format } from 'ajv';
7
7
  * @param envelope - Optional JMESPATH expression to use as envelope for the payload.
8
8
  * @param formats - Optional formats for validation.
9
9
  * @param externalRefs - Optional external references for validation.
10
- * @param ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
10
+ * @param ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
11
11
  */
12
12
  type ValidateParams = {
13
13
  /**
@@ -31,7 +31,7 @@ type ValidateParams = {
31
31
  */
32
32
  externalRefs?: AnySchema | AnySchema[];
33
33
  /**
34
- * Optional Ajv instance to use for validation, if not provided a new instance will be created.
34
+ * Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
35
35
  */
36
36
  ajv?: Ajv;
37
37
  };
@@ -43,7 +43,7 @@ type ValidateParams = {
43
43
  * @param envelope - Optional JMESPATH expression to use as envelope for the payload.
44
44
  * @param formats - Optional formats for validation.
45
45
  * @param externalRefs - Optional external references for validation.
46
- * @param ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
46
+ * @param ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
47
47
  */
48
48
  interface ValidatorOptions extends Omit<ValidateParams, 'payload' | 'schema'> {
49
49
  /**
@@ -112,7 +112,7 @@ import type { ValidateParams } from './types.js';
112
112
  * @param params.envelope - Optional JMESPath expression to use as envelope for the payload.
113
113
  * @param params.formats - Optional formats for validation.
114
114
  * @param params.externalRefs - Optional external references for validation.
115
- * @param params.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
115
+ * @param params.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
116
116
  */
117
117
  declare const validate: <T = unknown>(params: ValidateParams) => T;
118
118
  export { validate };
@@ -117,11 +117,11 @@ const errors_js_1 = require("./errors.js");
117
117
  * @param params.envelope - Optional JMESPath expression to use as envelope for the payload.
118
118
  * @param params.formats - Optional formats for validation.
119
119
  * @param params.externalRefs - Optional external references for validation.
120
- * @param params.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
120
+ * @param params.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
121
121
  */
122
122
  const validate = (params) => {
123
123
  const { payload, schema, envelope, formats, externalRefs, ajv } = params;
124
- const ajvInstance = ajv || new ajv_1.Ajv({ allErrors: true });
124
+ const ajvInstance = ajv || new ajv_1.Ajv();
125
125
  if (formats) {
126
126
  for (const key of Object.keys(formats)) {
127
127
  ajvInstance.addFormat(key, formats[key]);
@@ -131,7 +131,7 @@ import type { ValidatorOptions } from './types.js';
131
131
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
132
132
  * @param options.formats - Optional formats for validation.
133
133
  * @param options.externalRefs - Optional external references for validation.
134
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
134
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
135
135
  */
136
136
  declare function validator(options: ValidatorOptions): (_target: unknown, _propertyKey: string | symbol, descriptor: PropertyDescriptor) => PropertyDescriptor;
137
137
  export { validator };
@@ -133,7 +133,7 @@ import { validate } from './validate.js';
133
133
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
134
134
  * @param options.formats - Optional formats for validation.
135
135
  * @param options.externalRefs - Optional external references for validation.
136
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
136
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
137
137
  */
138
138
  function validator(options) {
139
139
  return (_target, _propertyKey, descriptor) => {
@@ -95,7 +95,7 @@ import type { ValidatorOptions } from './types.js';
95
95
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
96
96
  * @param options.formats - Optional formats for validation.
97
97
  * @param options.externalRefs - Optional external references for validation.
98
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
98
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
99
99
  */
100
100
  declare const validator: (options: ValidatorOptions) => {
101
101
  before: MiddlewareFn;
@@ -96,7 +96,7 @@ import { validate } from './validate.js';
96
96
  * @param options.envelope - Optional JMESPath expression to use as envelope for the payload.
97
97
  * @param options.formats - Optional formats for validation.
98
98
  * @param options.externalRefs - Optional external references for validation.
99
- * @param options.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
99
+ * @param options.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
100
100
  */
101
101
  const validator = (options) => {
102
102
  const before = (request) => {
@@ -7,7 +7,7 @@ import type { Ajv, AnySchema, Format } from 'ajv';
7
7
  * @param envelope - Optional JMESPATH expression to use as envelope for the payload.
8
8
  * @param formats - Optional formats for validation.
9
9
  * @param externalRefs - Optional external references for validation.
10
- * @param ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
10
+ * @param ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
11
11
  */
12
12
  type ValidateParams = {
13
13
  /**
@@ -31,7 +31,7 @@ type ValidateParams = {
31
31
  */
32
32
  externalRefs?: AnySchema | AnySchema[];
33
33
  /**
34
- * Optional Ajv instance to use for validation, if not provided a new instance will be created.
34
+ * Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
35
35
  */
36
36
  ajv?: Ajv;
37
37
  };
@@ -43,7 +43,7 @@ type ValidateParams = {
43
43
  * @param envelope - Optional JMESPATH expression to use as envelope for the payload.
44
44
  * @param formats - Optional formats for validation.
45
45
  * @param externalRefs - Optional external references for validation.
46
- * @param ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
46
+ * @param ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
47
47
  */
48
48
  interface ValidatorOptions extends Omit<ValidateParams, 'payload' | 'schema'> {
49
49
  /**
@@ -112,7 +112,7 @@ import type { ValidateParams } from './types.js';
112
112
  * @param params.envelope - Optional JMESPath expression to use as envelope for the payload.
113
113
  * @param params.formats - Optional formats for validation.
114
114
  * @param params.externalRefs - Optional external references for validation.
115
- * @param params.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
115
+ * @param params.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
116
116
  */
117
117
  declare const validate: <T = unknown>(params: ValidateParams) => T;
118
118
  export { validate };
@@ -114,11 +114,11 @@ import { SchemaCompilationError, SchemaValidationError } from './errors.js';
114
114
  * @param params.envelope - Optional JMESPath expression to use as envelope for the payload.
115
115
  * @param params.formats - Optional formats for validation.
116
116
  * @param params.externalRefs - Optional external references for validation.
117
- * @param params.ajv - Optional Ajv instance to use for validation, if not provided a new instance will be created.
117
+ * @param params.ajv - Optional Ajv instance to use for validation; if omitted, a new instance with Ajv's default options is created.
118
118
  */
119
119
  const validate = (params) => {
120
120
  const { payload, schema, envelope, formats, externalRefs, ajv } = params;
121
- const ajvInstance = ajv || new Ajv({ allErrors: true });
121
+ const ajvInstance = ajv || new Ajv();
122
122
  if (formats) {
123
123
  for (const key of Object.keys(formats)) {
124
124
  ajvInstance.addFormat(key, formats[key]);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aws-lambda-powertools/validation",
3
- "version": "2.36.0",
3
+ "version": "2.37.0",
4
4
  "description": "An utility to validate events and responses using JSON Schemas",
5
5
  "author": {
6
6
  "name": "Amazon Web Services",
@@ -27,8 +27,8 @@
27
27
  "serverless"
28
28
  ],
29
29
  "dependencies": {
30
- "@aws-lambda-powertools/commons": "2.36.0",
31
- "@aws-lambda-powertools/jmespath": "2.36.0",
30
+ "@aws-lambda-powertools/commons": "2.37.0",
31
+ "@aws-lambda-powertools/jmespath": "2.37.0",
32
32
  "ajv": "^8.20.0"
33
33
  },
34
34
  "main": "./lib/cjs/index.js",