| 6dd74de | | | 1 | import { load, JSON_SCHEMA } from 'js-yaml'; |
| 6dd74de | | | 2 | import assert from 'node:assert'; |
| 6dd74de | | | 3 | import Ajv2019, { type JSONSchemaType } from 'ajv/dist/2019.js'; |
| 6dd74de | | | 4 | import type { MermaidConfig, BaseDiagramConfig } from '../packages/mermaid/src/config.type.js'; |
| 6dd74de | | | 5 | |
| 6dd74de | | | 6 | /** |
| 6dd74de | | | 7 | * All of the keys in the mermaid config that have a mermaid diagram config. |
| 6dd74de | | | 8 | */ |
| 6dd74de | | | 9 | const MERMAID_CONFIG_DIAGRAM_KEYS = [ |
| 6dd74de | | | 10 | 'flowchart', |
| 6dd74de | | | 11 | 'sequence', |
| 6dd74de | | | 12 | 'gantt', |
| 6dd74de | | | 13 | 'journey', |
| 6dd74de | | | 14 | 'class', |
| 6dd74de | | | 15 | 'state', |
| 6dd74de | | | 16 | 'er', |
| 6dd74de | | | 17 | 'pie', |
| 6dd74de | | | 18 | 'quadrantChart', |
| 6dd74de | | | 19 | 'xyChart', |
| 6dd74de | | | 20 | 'requirement', |
| 6dd74de | | | 21 | 'mindmap', |
| 6dd74de | | | 22 | 'kanban', |
| 6dd74de | | | 23 | 'timeline', |
| 6dd74de | | | 24 | 'gitGraph', |
| 6dd74de | | | 25 | 'c4', |
| 6dd74de | | | 26 | 'sankey', |
| 6dd74de | | | 27 | 'block', |
| 6dd74de | | | 28 | 'packet', |
| 6dd74de | | | 29 | 'architecture', |
| 6dd74de | | | 30 | 'radar', |
| 6dd74de | | | 31 | ] as const; |
| 6dd74de | | | 32 | |
| 6dd74de | | | 33 | /** |
| 6dd74de | | | 34 | * Generate default values from the JSON Schema. |
| 6dd74de | | | 35 | * |
| 6dd74de | | | 36 | * AJV does not support nested default values yet (or default values with $ref), |
| 6dd74de | | | 37 | * so we need to manually find them (this may be fixed in ajv v9). |
| 6dd74de | | | 38 | * |
| 6dd74de | | | 39 | * @param mermaidConfigSchema - The Mermaid JSON Schema to use. |
| 6dd74de | | | 40 | * @returns The default mermaid config object. |
| 6dd74de | | | 41 | */ |
| 6dd74de | | | 42 | function generateDefaults(mermaidConfigSchema: JSONSchemaType<MermaidConfig>) { |
| 6dd74de | | | 43 | const ajv = new Ajv2019({ |
| 6dd74de | | | 44 | useDefaults: true, |
| 6dd74de | | | 45 | allowUnionTypes: true, |
| 6dd74de | | | 46 | strict: true, |
| 6dd74de | | | 47 | }); |
| 6dd74de | | | 48 | |
| 6dd74de | | | 49 | ajv.addKeyword({ |
| 6dd74de | | | 50 | keyword: 'meta:enum', // used by jsonschema2md |
| 6dd74de | | | 51 | errors: false, |
| 6dd74de | | | 52 | }); |
| 6dd74de | | | 53 | ajv.addKeyword({ |
| 6dd74de | | | 54 | keyword: 'tsType', // used by json-schema-to-typescript |
| 6dd74de | | | 55 | errors: false, |
| 6dd74de | | | 56 | }); |
| 6dd74de | | | 57 | |
| 6dd74de | | | 58 | // ajv currently doesn't support nested default values, see https://github.com/ajv-validator/ajv/issues/1718 |
| 6dd74de | | | 59 | // (may be fixed in v9) so we need to manually use sub-schemas |
| 6dd74de | | | 60 | const mermaidDefaultConfig = {}; |
| 6dd74de | | | 61 | |
| 6dd74de | | | 62 | assert.ok(mermaidConfigSchema.$defs); |
| 6dd74de | | | 63 | const baseDiagramConfig = mermaidConfigSchema.$defs.BaseDiagramConfig; |
| 6dd74de | | | 64 | |
| 6dd74de | | | 65 | for (const key of MERMAID_CONFIG_DIAGRAM_KEYS) { |
| 6dd74de | | | 66 | const subSchemaRef = mermaidConfigSchema.properties[key].$ref; |
| 6dd74de | | | 67 | const [root, defs, defName] = subSchemaRef.split('/'); |
| 6dd74de | | | 68 | assert.strictEqual(root, '#'); |
| 6dd74de | | | 69 | assert.strictEqual(defs, '$defs'); |
| 6dd74de | | | 70 | const subSchema = { |
| 6dd74de | | | 71 | $schema: mermaidConfigSchema.$schema, |
| 6dd74de | | | 72 | $defs: mermaidConfigSchema.$defs, |
| 6dd74de | | | 73 | ...mermaidConfigSchema.$defs[defName], |
| 6dd74de | | | 74 | } as JSONSchemaType<BaseDiagramConfig>; |
| 6dd74de | | | 75 | |
| 6dd74de | | | 76 | const validate = ajv.compile(subSchema); |
| 6dd74de | | | 77 | |
| 6dd74de | | | 78 | mermaidDefaultConfig[key] = {}; |
| 6dd74de | | | 79 | |
| 6dd74de | | | 80 | for (const required of subSchema.required ?? []) { |
| 6dd74de | | | 81 | if (subSchema.properties[required] === undefined && baseDiagramConfig.properties[required]) { |
| 6dd74de | | | 82 | mermaidDefaultConfig[key][required] = baseDiagramConfig.properties[required].default; |
| 6dd74de | | | 83 | } |
| 6dd74de | | | 84 | } |
| 6dd74de | | | 85 | if (!validate(mermaidDefaultConfig[key])) { |
| 6dd74de | | | 86 | throw new Error( |
| 6dd74de | | | 87 | `schema for subconfig ${key} does not have valid defaults! Errors were ${JSON.stringify( |
| 6dd74de | | | 88 | validate.errors, |
| 6dd74de | | | 89 | undefined, |
| 6dd74de | | | 90 | 2 |
| 6dd74de | | | 91 | )}` |
| 6dd74de | | | 92 | ); |
| 6dd74de | | | 93 | } |
| 6dd74de | | | 94 | } |
| 6dd74de | | | 95 | |
| 6dd74de | | | 96 | const validate = ajv.compile(mermaidConfigSchema); |
| 6dd74de | | | 97 | |
| 6dd74de | | | 98 | if (!validate(mermaidDefaultConfig)) { |
| 6dd74de | | | 99 | throw new Error( |
| 6dd74de | | | 100 | `Mermaid config JSON Schema does not have valid defaults! Errors were ${JSON.stringify( |
| 6dd74de | | | 101 | validate.errors, |
| 6dd74de | | | 102 | undefined, |
| 6dd74de | | | 103 | 2 |
| 6dd74de | | | 104 | )}` |
| 6dd74de | | | 105 | ); |
| 6dd74de | | | 106 | } |
| 6dd74de | | | 107 | |
| 6dd74de | | | 108 | return mermaidDefaultConfig; |
| 6dd74de | | | 109 | } |
| 6dd74de | | | 110 | |
| 6dd74de | | | 111 | export const loadSchema = (src: string, filename: string): JSONSchemaType<MermaidConfig> => { |
| 6dd74de | | | 112 | const jsonSchema = load(src, { |
| 6dd74de | | | 113 | filename, |
| 6dd74de | | | 114 | // only allow JSON types in our YAML doc (will probably be default in YAML 1.3) |
| 6dd74de | | | 115 | // e.g. `true` will be parsed a boolean `true`, `True` will be parsed as string `"True"`. |
| 6dd74de | | | 116 | schema: JSON_SCHEMA, |
| 6dd74de | | | 117 | }) as JSONSchemaType<MermaidConfig>; |
| 6dd74de | | | 118 | return jsonSchema; |
| 6dd74de | | | 119 | }; |
| 6dd74de | | | 120 | |
| 6dd74de | | | 121 | export const getDefaults = (schema: JSONSchemaType<MermaidConfig>) => { |
| 6dd74de | | | 122 | return `export default ${JSON.stringify(generateDefaults(schema), undefined, 2)};`; |
| 6dd74de | | | 123 | }; |
| 6dd74de | | | 124 | |
| 6dd74de | | | 125 | export const getSchema = (schema: JSONSchemaType<MermaidConfig>) => { |
| 6dd74de | | | 126 | return `export default ${JSON.stringify(schema, undefined, 2)};`; |
| 6dd74de | | | 127 | }; |