/**
 * This file contains the schema that is used to validate includes within the
 * item definition using the JSON Schema specification in the compile process
 *
 * related files index.ts and checkers.ts
 *
 * @module
 */

import ConditionalRuleSetSchema from "../ConditionalRuleSet/schema";
import PropertiesValueMappingDefinitionSchema from "../PropertiesValueMappingDefiniton/schema";

/**
 * The default schema for an Include
 */
export default {
  $id: "Include",
  type: "object",
  properties: {
    id: {
      type: "string",
      pattern: "^[a-z_]+$",
    },
    definition: {
      type: "string",
      pattern: "^[a-z_/]+$",
    },
    enforcedProperties: {
      $ref: "PropertiesValueMappingDefiniton",
    },
    predefinedProperties: {
      $ref: "PropertiesValueMappingDefiniton",
    },
    excludedIf: {
      $ref: "ConditionalRuleSet",
    },
    canUserExclude: {
      type: "boolean",
    },
    canUserExcludeIf: {
      $ref: "ConditionalRuleSet",
    },
    defaultExcluded: {
      type: "boolean",
    },
    defaultExcludedIf: {
      $ref: "ConditionalRuleSet",
    },
    ternaryExclusionState: {
      type: "boolean",
    },
    exclusionIsCallout: {
      type: "boolean",
    },
    sinkIn: {
      type: "array",
      items: {
        type: "string",
      },
    },
    disableSearch: {
      type: "boolean",
    },
  },
  definitions: {
    PropertiesValueMappingDefiniton: PropertiesValueMappingDefinitionSchema,
    ConditionalRuleSet: ConditionalRuleSetSchema,
  },
  required: ["id", "name"],
  additionalProperties: false,
};