wekit/templates/app/contentful-argtypes.js at main · jungvonmatt/wekit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
const splitValues = (values) => {
  if (['number', 'string'].includes(typeof values)) {
    return `\`${values}\``;
  }

  if (Array.isArray(values)) {
    return values.map((value) => `\`${value}\``).join(', ');
  }

  return Object.entries(values)
    .map(([key, value]) => `${key}: \`${value}\``)
    .join(', ');
};

const formatValidations = (validations) => {
  let formattedValidation = '';
  for (const validation of validations) {
    if (validation.size) {
      formattedValidation += `**Allowed size:** ${splitValues(validation.size)}. `;
    } else if (validation.enabledNodeTypes) {
      formattedValidation += `**Allowed node types:** ${splitValues(validation.enabledNodeTypes)}. `;
    } else if (validation.enabledMarks) {
      formattedValidation += `**Allowed marks:** ${splitValues(validation.enabledMarks)}. `;
    } else if (validation.linkContentType) {
      formattedValidation += `**Allowed content types:** ${splitValues(validation.linkContentType)}. `;
    } else if (validation.linkMimetypeGroup) {
      formattedValidation += `**Allowed file types:** ${splitValues(validation.linkMimetypeGroup)}. `;
    } else if (validation.in) {
      formattedValidation += `**Allowed values:** ${splitValues(validation.in)}. `;
    } else if (validation.regexp) {
      formattedValidation += `**Regex:** ${JSON.stringify(validation.regexp.pattern)}. `;
    } else {
      formattedValidation += `${JSON.stringify(validation)}. `;
    }
  }

  // Escape pipes
  formattedValidation = formattedValidation.replace(/\|/g, '&#124;');

  return formattedValidation;
};

const getType = (field) => {
  return field?.type ?? 'string';
};

const isFieldIncluded = (field) => {
  const ignores = ['name', 'content_type', 'id', 'sys'];
  return !field.disabled && !field.omitted && field?.id && !ignores.includes(field?.id);
};

const getDescription = (field) => {
  const validations = formatValidations(field?.validations ?? []);
  const helpText = field?.settings?.helpText ?? '';

  return [helpText, validations].filter((v) => v).join('\n');
};

const getControl = (field) => {
  const result = { control: { type: null } };
  const type = field?.type;
  const widgetId = field?.widgetId;
  const validations = field?.validations ?? [];
  const { in: options = [] } = validations.find((validation) => Boolean(validation?.in)) || {};

  if (options.length) {
    result.control.type = widgetId === 'radio' ? 'radio' : 'select';
    result.options = options;
  }

  if (type === 'Boolean') {
    result.control.type = 'boolean';
  }

  if (['singleLine', 'multipleLine', 'markdown', 'slugEditor', 'urlEditor'].includes(widgetId)) {
    result.control.type = 'text';
  }

  if (widgetId === 'numberEditor') {
    const { range } = validations.find((validation) => Boolean(validation?.range)) || {};
    const { min, max } = range;
    result.control.type = 'number';

    if (typeof min !== 'undefined') {
      result.control.min = min;
    }

    if (typeof max !== 'undefined') {
      result.control.max = max;
    }

    if (type === 'Integer') {
      result.control.step = 1;
    }
  }

  return result;
};

module.exports = async (data) => {
  const fields = data?.fields ?? [];

  const argTypes = Object.fromEntries(
    fields
      .filter((field) => isFieldIncluded(field))
      .map((field) => {
        const definition = {
          name: field.name,
          type: { name: getType(field), required: field.required },
          description: getDescription(field),
          table: {
            type: { summary: getType(field) },
          },
          ...getControl(field),
        };

        const [defaultValue] = Object.values(field?.defaultValue ?? {});
        if (defaultValue) {
          definition.defaultValue = defaultValue;
          definition.table.defaultValue = { summary: defaultValue };
        }

        return [field.id, definition];
      })
      .filter(([, definition]) => definition?.control?.type)
  );

  return JSON.stringify(argTypes, null, '  ');
};