index.ts

import { Ajv } from 'ajv';
import addFormats from 'ajv-formats';
import * as jsonSchema from 'ajv/lib/refs/json-schema-draft-06.json';
import * as schemaAddress from './format/address.json';
import { formats } from './format';

/**
 * validation of data
 * @param   data    object you want to validate
 * @return  object.valid == true if the json is valid, object.valid == false and object.errors otherwise.
 */
export function validate(data: any): any {
  const validationTool = new Ajv().addMetaSchema(jsonSchema).addSchema(schemaAddress);
  addFormats(validationTool);

  // Check the meta information
  if (!data.meta) {
    return { valid: false, errors: [{ message: 'meta not found' }] };
  }
  if (!data.meta.format) {
    return { valid: false, errors: [{ message: 'meta.format not found' }] };
  }
  if (!data.meta.version) {
    return { valid: false, errors: [{ message: 'meta.version not found' }] };
  }

  // Try to retrieve the schema json
  const schema = formats[data.meta.format]?.[data.meta.version];
  if (!schema) {
    return { valid: false, errors: [{ message: 'format not found' }] };
  }

  // Compile and Validate
  const validate = validationTool.compile(schema);
  const valid = validate(data);

  // If not valid return the error
  if (!valid) {
    return { valid: false, errors: validate.errors };
  }

  return { valid: true };
}

/**
 * Check if the object format is known
 * @param data the object to check
 * @return true if the object format is known
 */
export function isKnownFormat(data: any): boolean {
  return !!data.meta && data.meta.format === 'rnf_invoice';
}

// FIXME it would be better to export a subpath, ie @requestnetwork/data-format/invoice,
// using `exports` as introduced in Node 12.7.0 (https://nodejs.org/api/packages.html#packages_subpath_exports)
// but typescript doesn't currently support this (https://github.com/microsoft/TypeScript/issues/33079)
// NB: compatibilty with browser would need to be tested.
export * from './format/rnf_invoice';