ACTIVEPIECES/packages/engine/test/services/props-validator.test.ts

import { PieceAuth, Property } from '@activepieces/pieces-framework'
import { propsProcessor } from '../../src/lib/variables/props-processor'
describe('Property Validation', () => {
    describe('required properties', () => {
        it('should validate required string property', async () => {
            const props = {
                text: Property.ShortText({
                    displayName: 'Text',
                    required: true,
                }),
            }
            
            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { text: 'valid text' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { text: null },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(nullErrors).toEqual({
                text: ['Expected string, received: null'],
            })

            const { errors: undefinedErrors } = await propsProcessor.applyProcessorsAndValidators(
                { text: undefined },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(undefinedErrors).toEqual({
                text: ['Expected string, received: undefined'],
            })
        })

        it('should validate required number property', async () => {
            const props = {
                number: Property.Number({
                    displayName: 'Number',
                    required: true,
                }),
            }
            
            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { number: 42 },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { number: null },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(nullErrors).toEqual({
                number: ['Expected number, received: null'],
            })

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { number: 'not a number' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(typeErrors).toEqual({
                number: ['Expected number, received: not a number'],
            })
        })

        it('should validate required datetime property', async () => {
            const props = {
                date: Property.DateTime({
                    displayName: 'DateTime',
                    required: true,
                }),
            }
            
            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { date: '2024-03-14T12:00:00.000Z' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validErrors).toEqual({})

            const { errors: invalidErrors } = await propsProcessor.applyProcessorsAndValidators(
                { date: 'not a date' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(invalidErrors).toEqual({
                date: ['Invalid datetime format. Expected ISO format (e.g. 2024-03-14T12:00:00.000Z), received: not a date'],
            })
        })

        it('should validate required array property', async () => {
            const props = {
                array: Property.Array({
                    displayName: 'Array',
                    required: true,
                }),
            }
            
            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { array: [1, 2, 3] },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validErrors).toEqual({})

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { array: 'not an array' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(typeErrors).toEqual({
                array: ['Expected array, received: not an array'],
            })
        })

        it('should validate required json property', async () => {
            const props = {
                json: Property.Json({
                    displayName: 'JSON',
                    required: true,
                }),
            }
            
            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: { key: 'value' } },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validErrors).toEqual({})

            const { errors: validJsonStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: '{"key": "value"}' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validJsonStringErrors).toEqual({})

            const { errors: validArrayErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: [1, 2, 3] },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validArrayErrors).toEqual({})

            const { errors: validArrayStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: '[1, 2, 3]' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validArrayStringErrors).toEqual({})

            const { errors: invalidJsonErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: 'not a json object' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(invalidJsonErrors).toEqual({
                json: ['Expected JSON, received: not a json object'],
            })

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { json: null },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(nullErrors).toEqual({
                json: ['Expected JSON, received: null'],
            })
        })
        it('should validate required object property', async () => {
            const props = {
                object: Property.Object({
                    displayName: 'Object',
                    required: true,
                }),
            }
            
            const { errors: validErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: { key: 'value' } },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(validErrors).toEqual({})

            const { errors: nullErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: null },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(nullErrors).toEqual({
                object: ['Expected object, received: null'],
            })

            const { errors: typeErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: 'not an object' },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(typeErrors).toEqual({
                object: ['Expected object, received: not an object'],
            })

            const { errors: jsonStringErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: JSON.stringify({ key: 'value' }) },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(jsonStringErrors).toEqual({})

            const { errors: undefinedErrors } = await propsProcessor.applyProcessorsAndValidators(
                { object: { key: 'value' } },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(undefinedErrors).toEqual({})
        })
    })

    describe('optional properties', () => {
        it('should validate optional properties', async () => {
            const props = {
                text: Property.ShortText({
                    displayName: 'Text',
                    required: false,
                }),
                number: Property.Number({
                    displayName: 'Number',
                    required: false,
                }),
            }
            
            const { errors } = await propsProcessor.applyProcessorsAndValidators(
                { 
                    text: null,
                    number: undefined,
                },
                props,
                PieceAuth.None(),
                false,
                null,
            )
            expect(errors).toEqual({})
        })
    })

    describe('type validation', () => {
        it('should validate property types', async () => {
            const props = {
                string: Property.ShortText({
                    displayName: 'Text',
                    required: true,
                }),
                number: Property.Number({
                    displayName: 'Number',
                    required: true,
                }),
                boolean: Property.Checkbox({
                    displayName: 'Checkbox',
                    required: true,
                }),
                array: Property.Array({
                    displayName: 'Array',
                    required: true,
                }),
                object: Property.Object({
                    displayName: 'Object',
                    required: true,
                }),
            }

            const { errors } = await propsProcessor.applyProcessorsAndValidators(
                {
                    string: 42,
                    number: 'not a number',
                    boolean: 'not a boolean',
                    array: 'not an array',
                    object: 'not an object',
                },
                props,
                PieceAuth.None(),
                false,
                null,
            )

            expect(errors).toEqual({
                number: ['Expected number, received: not a number'],
                boolean: ['Expected boolean, received: not a boolean'],
                array: ['Expected array, received: not an array'],
                object: ['Expected object, received: not an object'],
            })
        })
    })
})