DDF validator

The complete solution for validating DDF File.

- Installation
- Quick Start

Installation

``sh
npm install @deconz-community/ddf-validator
`

Quick Start

You can validate all DDF in a specefic directory using the example below. The validate method will return the validated data or will throw a Zod Error. You can use the package zod-validation-error to format the error for the user.

Example :

`js
import { readFile } from 'node:fs/promises'
import glob from 'fast-glob'
import { fromZodError } from 'zod-validation-error'
import { createValidator } from '@deconz-community/ddf-validator'

(async () => {
const validator = createValidator()

const genericFiles = await glob('test-data/generic/*/.json')
const ddfFiles = await glob('test-data/*/.json', {
ignore: '/generic/',
})

const genericFilesData = await Promise.all(genericFiles.map(
async (filePath) => {
const data = await readFile(filePath, 'utf-8')
const decoded = JSON.parse(data)
return { path: filePath, data: decoded }
},
))

// Sort to load consts first
genericFilesData.sort((a, b) => a.data.schema.localeCompare(b.data.schema))

genericFilesData.forEach((file) => {
try {
const result = validator.loadGeneric(file.data)
console.log(Loaded generic file${file.path})
}
catch (error) {
console.error(Error while loading file ${file.path} : ${fromZodError(error).message})
}
})

ddfFiles.forEach((filePath) => {
const data = await readFile(filePath, 'utf-8')
const decoded = JSON.parse(data)
try {
const result = validator.validate(decoded)
console.log(Validated file ${file.path})
}
catch (error) {
console.error(Error while validating file ${file.path} : ${fromZodError(error).message})
}
})
})()
`

API

$3

Main function to validate the DDF data object.

#### Arguments
- generics - : GenericsData; Base generic data to validate DDF.

#### Return
Return a new validator instance.

#### Example

`typescript
import { createValidator } from '@deconz-community/ddf-validator'

const validator = createValidator({
attributes: ['attr/id']
manufacturers: { "$MF_FOO": "Foo inc." }
deviceTypes: { "$TYPE_COLOR_LIGHT": "Color light" }
})

`

$3

Currently loaded generics.

#### Return
- generics - : GenericsData; Generic data to validate DDF.

$3

Load generic data from an object.
Support files with schema constants1.schema.json, constants2.schema.json, resourceitem1.schema.json and subdevice1.schema.json.

#### Arguments
- data - : object; File data.

#### Return
- data - : object; File data.

Or throw Zod Error

#### Example

`typescript
import { createValidator } from '@deconz-community/ddf-validator'

const validator = createValidator()
validator.loadGeneric({
"schema": "constants1.schema.json",
"manufacturers" : {
"$MF_FOO": "Foo inc."
},
"device-types": {
"$TYPE_COLOR_LIGHT": "Color light"
}
})

`

$3

Validate DDF data from an object.
Support files with schema constants1.schema.json, constants2.schema.json, resourceitem1.schema.json, subdevice1.schema.json and devcap1.schema.json.
Make sure to load any need generic first.

#### Arguments
- data - : object; File data.

#### Return
- data - : object; File data.

Or throw Zod Error

#### Example

`typescript
import { createValidator } from '@deconz-community/ddf-validator'

const validator = createValidator()
validator.validate({
"schema": "constants1.schema.json",
"manufacturers" : {
"$MF_FOO": "Foo inc."
},
"device-types": {
"$TYPE_COLOR_LIGHT": "Color light"
}
})

`

$3

Validate both generic and DDF data from two arrays

#### Arguments
- genericFiles - : FileDefinition[]; Generic files data.
- ddfFiles - : FileDefinition[]; DDF files data.
- callbacks - : object; Options.
- onSectionStart - : function; Called when a section start.
- onSectionProgress - : function; Called when a section progress.
- onSectionEnd - : function; Called when a section end.

#### Return
- errors - : FileDefinitionWithError[]; File definition with errors.

#### Example

`typescript
validator.bulkValidate(genericFiles, ddfFiles, {
onSectionStart: (type, total) => {
spinner.start(chalk.blue(Parsing ${typeFilesText(type, total)} 1 of ${total}))
},
onSectionProgress: (type, current, total) => {
spinner.text = chalk.blue(Parsing ${typeFilesText(type, total)} ${current} of ${total})
spinner.render()
},
onSectionEnd(type, total, errorFiles) {
if (errorFiles.length === 0)
return spinner.succeed(chalk.green(No errors found in ${files.length} ${typeFilesText(type, total)}))

spinner.fail(chalk.red(Found ${errorFiles.length} ${plural('error', 'errors', errorFiles.length)} in ${files.length} ${typeFilesText(type, total)}))

errorFiles.forEach(({ path, error }) => {
let message = ''
try {
message = fromZodError(error, {
issueSeparator: '\n ',
prefix: null,
}).message
}
catch (e) {
message = error.toString()
}
console.log( ${chalk.cyan('File:')}, path)
console.log( ${chalk.red(message)})
})
},
})
`

$3

Return Zod schema with loaded generic data.

#### Return
- schema - : ZodType; Zod Schema.

#### Example

`typescript
import { createValidator } from '@deconz-community/ddf-validator'
import { zodToJsonSchema } from 'zod-to-json-schema'

const validator = createValidator()
const schemaJson = zodToJsonSchema(validator.getSchema(), 'DDF')
`

$3

$3

The type definition of a valid DDF file. Contain union type for constants1.schema.json, resourceitem1.schema.json, subdevice1.schema.json and devcap1.schema.json.

#### Example

`typescript
import type { DDF } from '@deconz-community/ddf-validator'

const data = {} as DDF
``