freeCodeCamp/client/tools/external-curriculum/external-data-schema-v2.ts

import Joi from 'joi';
import { chapterBasedSuperBlocks } from '../../../shared-dist/config/curriculum';

const slugRE = new RegExp('^[a-z0-9-]+$');

const blockSchema = Joi.object().keys({
  intro: Joi.array().min(1),
  meta: Joi.object({})
    .keys({
      name: Joi.string().required(),
      isUpcomingChange: Joi.bool().required(),
      usesMultifileEditor: Joi.bool().optional(),
      hasEditableBoundaries: Joi.bool().optional(),
      dashedName: Joi.string().required(),
      helpCategory: Joi.valid(
        'JavaScript',
        'HTML-CSS',
        'Python',
        'Backend Development',
        'C-Sharp',
        'English',
        'Chinese Curriculum',
        'Spanish Curriculum',
        'Odin',
        'Euler',
        'Rosetta'
      ).required(),
      order: Joi.number().required(),
      template: Joi.string().allow(''),
      required: Joi.array(),
      superBlock: Joi.string().required(),
      blockLayout: Joi.valid(
        'challenge-list',
        'challenge-grid',
        'dialogue-grid',
        'link',
        'project-list',
        'legacy-challenge-list',
        'legacy-link',
        'legacy-challenge-grid'
      ).required(),
      blockType: Joi.valid(
        'lecture',
        'workshop',
        'lab',
        'review',
        'quiz',
        'exam',
        'warm-up',
        'learn',
        'practice'
      ).when('superBlock', {
        is: chapterBasedSuperBlocks,
        then: Joi.required(),
        otherwise: Joi.optional()
      }),
      challengeOrder: Joi.array().items(
        Joi.object({})
          .keys({
            id: Joi.string(),
            title: Joi.string()
          })
          .min(1)
          .required()
      ),
      disableLoopProtectTests: Joi.boolean(),
      disableLoopProtectPreview: Joi.boolean(),
      superOrder: Joi.number()
    })
    .required()
});

const blockBasedCurriculumSchema = Joi.object().pattern(
  Joi.string(),
  Joi.object().keys({
    intro: Joi.array(),
    blocks: Joi.array().items(blockSchema)
  })
);

const chapterBasedCurriculumSchema = Joi.object().pattern(
  Joi.string(),
  Joi.object().keys({
    intro: Joi.array(),
    chapters: Joi.array().items(
      Joi.object().keys({
        dashedName: Joi.string().regex(slugRE).required(),
        name: Joi.string().required(),
        comingSoon: Joi.boolean().optional(),
        chapterType: Joi.valid('exam').optional(),
        modules: Joi.array()
          .items(
            Joi.object().keys({
              moduleType: Joi.valid(
                'review',
                'exam',
                'cert-project'
              ).optional(),
              name: Joi.string().required(),
              comingSoon: Joi.boolean().optional(),
              dashedName: Joi.string().regex(slugRE).required(),
              blocks: Joi.array().items(blockSchema)
            })
          )
          .required()
      })
    )
  })
);

const availableSuperBlocksSchema = Joi.object({
  superblocks: Joi.object().pattern(
    Joi.string(),
    Joi.array().items(
      Joi.object({
        dashedName: Joi.string().required(),
        title: Joi.string().required(),
        public: Joi.bool().required()
      })
    )
  )
});

export const superblockSchemaValidator =
  () => (superBlock: Record<string, unknown>) => {
    const superBlockName = Object.keys(superBlock)[0];

    if (chapterBasedSuperBlocks.includes(superBlockName)) {
      return chapterBasedCurriculumSchema.validate(superBlock);
    }

    return blockBasedCurriculumSchema.validate(superBlock);
  };

export const availableSuperBlocksValidator = () => (data: unknown) =>
  availableSuperBlocksSchema.validate(data);