feat: add data model validation #43

lukasbicus · 2024-08-16T08:49:54Z

closes #17

lukasbicus · 2024-08-19T06:07:49Z

@xseman - can you please give feedback?

There are 3 direct questions on task definition marked with todo in the code, please take a look at them.

xseman · 2024-08-19T06:28:24Z

src/encode.ts

+	/**
+	 * If true, validates data model before encoding it.
+	 *
+	 * @default false
+	 */
+	validateModel: boolean;


I initially suggested a default of false, but after thinking it over, I believe true would be more expected. Also, a simple validate option would be nicer.

@xseman - this will cause validation to run by default in the terminal without an option to turn it out. Should I add an optional flag withoutValidation to the cli command?

@xseman - this will cause validation to run by default in the terminal without an option to turn it out. Should I add an optional flag withoutValidation to the cli command?

Great, I almost forgot about the CLI. Sure, go ahead and add it as a simple validation option.

src/validations.test.ts

src/validations.ts

src/validations.test.ts

xseman · 2024-08-19T08:29:29Z

Thanks for your contribution @lukasbicus!
Great implementation and tests, I've left a few comments.

lukasbicus added 16 commits August 15, 2024 15:36

Add validate function

bb71c0f

Define ValidationError

982aecf

Add a test for validating iban

038f7ce

Add validator package

da33f87

Add validateBankAccount function

17a25d6

Implement partially validateSimplePayment

2d8efef

Cleanup

7c806eb

Validate currency code

ac0d9fc

Cleanup

c6e8115

Implement payment due date.

b5818e3

Add validation for validateDataModel

73402a9

Cleanup

e6a0c40

Add validateDataModel to export

047f223

Add validateModel to encode function

776e5a0

Fix typo in validations.test.ts

0248725

Update documentation.

afaf09a

xseman self-requested a review August 19, 2024 06:23