// Script that generates typescript docs for javascript/packages/react components as well as the yaml schema for the editor const fs = require('fs') const path = require('path') const {execSync} = require('child_process') const frigadeReactMap = { 'src/FrigadeChecklist/index.tsx': { officialDocFiles: ['component/checklist-condensed.mdx', 'component/checklist-carousel.mdx', 'component/checklist-classic.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/checklist_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeChecklistProps.md', }, 'src/FrigadeTour/index.tsx': { officialDocFiles: ['component/tour.mdx', 'component/hint.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/tour_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeTourProps.md', }, 'src/FrigadeForm/index.tsx': { officialDocFiles: ['component/form.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/form_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeFormProps.md', }, 'src/FrigadeNPSSurvey/index.tsx': { officialDocFiles: ['component/nps-survey.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/nps_survey_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeNPSSurveyProps.md', }, 'src/FrigadeEmbeddedTip/index.tsx': { officialDocFiles: ['component/embedded-tip.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/embedded_tip_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeEmbeddedTipProps.md', }, 'src/FrigadeAnnouncement/index.tsx': { officialDocFiles: ['component/announcement.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/announcement_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeAnnouncementProps.md', }, // 'src/FrigadeSupportWidget/index.tsx': { // officialDocFiles: ['component/support-widget.mdx'], // autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeSupportWidgetProps.md', // }, 'src/FrigadeBanner/index.tsx': { officialDocFiles: ['component/banner.mdx'], yamlSchemaPath: '../app-web/public/editor/schema/banner_step.json', autogenDocPath: '../javascript/packages/react/docs/interfaces/FrigadeBannerProps.md', }, } const commonYamlContent = JSON.parse(fs.readFileSync('../app-web/public/editor/schema/common_step.json', 'utf-8')); Object.entries(frigadeReactMap).forEach(([file, {officialDocFiles, autogenDocPath, yamlSchemaPath}]) => { officialDocFiles.forEach((officialDocFile) => { console.log(file) // Generate doc const command = `cd ../javascript/packages/react && yarn typedoc --plugin typedoc-plugin-markdown ${file}` execSync(command, {stdio: 'inherit'}) console.log(command) // Read content let docContent = fs.readFileSync(autogenDocPath, 'utf-8') let yamlDocContent = JSON.parse(yamlSchemaPath ? fs.readFileSync(yamlSchemaPath, 'utf-8') : '{}'); // Delete everything in content before the line "## Table of contents" (included) let regex = /[\s\S]+## Table of contents/gm docContent = docContent.replace(regex, '') regex = /[\s\S]+### Properties/gm docContent = docContent.replace(regex, '') regex = /## Properties\n/gm docContent = docContent.replace(regex, '') regex = /#### Inherited from\n\n.+\n\n/gm docContent = docContent.replaceAll(regex, '') regex = /#### Overrides\n\n.+\n\n/gm docContent = docContent.replaceAll(regex, '') regex = /#### Index signature\n/gm docContent = docContent.replaceAll(regex, '**Index signature**\n') regex = /#### Type declaration\n\n.+\n/gm docContent = docContent.replaceAll(regex, '') regex = /\(.*\.md#/gm docContent = docContent.replaceAll(regex, '(#') regex = / Object.keys(yamlProps).forEach((propName) => { yamlProps[`steps[].${propName}`] = yamlProps[propName]; delete yamlProps[propName]; }); let highLevelProps = yamlSchemaPath ? JSON.parse(fs.readFileSync(yamlSchemaPath.replace("_step", "_flow"), 'utf-8')) : {}; yamlProps = { ...(highLevelProps.properties ?? {}), ...yamlProps}; // Remove data prop as it's depreacated delete yamlProps['data']; let yamlTable = ''; if (yamlProps && Object.keys(yamlProps).length > 0) { yamlTable ='The following props are available in `config.yml` in the `steps` array:

\n'; (Object.keys(yamlProps) || []).forEach((propName) => { // Check if yamlProps[propName].properties exists if (yamlProps[propName].properties) { // If it does, loop through it and add to yamlTable yamlTable = yamlTable + `${yamlProps[propName].description}\n`; (Object.keys(yamlProps[propName].properties) || []).forEach((subPropName) => { yamlTable = yamlTable + `${yamlProps[propName].properties[subPropName].description}\n`; // Check if yamlProps[propName].properties[subPropName].items.properties exists and nest if (yamlProps[propName].properties[subPropName].items && yamlProps[propName].properties[subPropName].items.properties) { (Object.keys(yamlProps[propName].properties[subPropName].items.properties) || []).forEach((subSubPropName) => { yamlTable = yamlTable + `${yamlProps[propName].properties[subPropName].items.properties[subSubPropName].description}\n`; }); } }); return; } yamlTable = yamlTable + `${yamlProps[propName].description}\n`; }); } // Match all the lines that fit this format: - [appearance](#appearance) and put in array // const tableOfContentReactProps = docContent.match(/- \[.*\]$#.*$/gm) // // Remove them all from docContent // docContent = docContent.replace(/- \[.*\]$#.*$\n/gm, '') // let reactPropsTable = '' // if (tableOfContentReactProps) { // tableOfContentReactProps.forEach((line) => { // reactPropsTable = reactPropsTable + `\t\t\t${line // // Remove all tabs/white space surround line // .replace(/\t/gm, '') // }\n`; // }); // } // const tabs = ` // // // ${reactPropsTable} // // // ${yamlTable} // // // `; docContent = yamlTable + '\n## React component props' + docContent; // Read official doc const officialDoc = fs.readFileSync(officialDocFile, 'utf-8') // Write to official doc from the first line that contains "## Props" const lines = officialDoc.split('\n') const index = lines.findIndex((line) => line.includes('## config.yml props')) // Delete everything after the line lines.splice(index + 1, lines.length - index) // Now append the new content lines.splice(index + 1, 0, docContent) fs.writeFileSync(officialDocFile, lines.join('\n')) }) })

Overview

SDK and API

Events API

Webhooks API

Query API

Path Parameters

Response