install-helper.js

/*
Copyright 2023 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/

const Ajv = require('ajv')
const ajvAddFormats = require('ajv-formats')

/**
 * Validate the file json with one of our schemas.
 *
 * @param {object} fileJson the json to validate
 * @param {string} schemaName one of config.json, app.config.yaml, deploy.yaml
 * @returns {object} with keys valid (boolean) and errors (object). errors is null if no errors
 */
function validateJsonWithSchema (fileJson, schemaName) {
  const schemas = require('../../schema/index')
  const ajv = new Ajv({
    allErrors: true,
    allowUnionTypes: true
  })
  ajvAddFormats(ajv)

  const validate = ajv.compile(schemas[schemaName])
  return { valid: validate(fileJson), errors: validate.errors }
}

module.exports = {
  validateJsonWithSchema
}