@sweepbright/import-validator

This package is used to validate the import files.

Installation

npm install -g @sweepbright/import-validator

Or

yarn global add @sweepbright/import-validator

Usage

sb-import-validator single <file> # Validate a JSON file with a single property
sb-import-validator multiple <file> # Validate a JSON file with an array of properties

Options:

--json # Output the result as JSON
--csv # Output the result as CSV

Input format

Validated properties should stored in JSON files.

For a single property files, the format should be just a property object:

{
    "id": "00000000-0000-0000-0000-000000000002",
    "buyers": [],
    "owners": [],
    "negotiator_id": "5935",
    "type": "apartment",
    "office_id": "0391806b-6df3-4c0d-a3f1-00071d801f9b",
    "is_project": false,
    "negotiation": "sale",
    "attributes": {
        "location": {
            "country": "BE"
        }
        // etc
    }
}

For a list of properties, the format should be an array of property objects:

[
    {
        "id": "00000000-0000-0000-0000-000000000002",
        "buyers": [],
        "owners": [],
        "negotiator_id": "5935",
        "type": "apartment",
        "office_id": "0391806b-6df3-4c0d-a3f1-00071d801f9b",
        "is_project": false,
        "negotiation": "sale",
        "attributes": {
            "location": {
                "country": "BE"
            }
            // etc
        }
    },
    {
        "id": "00000000-0000-0000-0000-000000000003",
        "buyers": [],
        "owners": [],
        "negotiator_id": "5935",
        "type": "apartment",
        "office_id": "0391806b-6df3-4c0d-a3f1-00071d801f9b",
        "is_project": false,
        "negotiation": "sale",
        "attributes": {
            "location": {
                "country": "BE"
            }
            // etc
        }
    },
    // etc
]

The detailed structure of the property object is described in the GrpaQL import schema.