feat: jsdocs for generated types, by using admin.description (#9917)

This makes use of admin.description to generate JSDocs for field,
collection and global generated types.


![image](https://github.com/user-attachments/assets/980d825f-49a2-426d-933a-2ff3d205ea24)


![image](https://github.com/user-attachments/assets/d0b1f288-1ea1-4d80-8c05-003d59a4e41a)

For the future, we should add a dedicated property to override these
JSDocs.

You can view the effect of this PR on our test suite generated types
here:
05f552bbbc
This commit is contained in:
Alessio Gravili
2024-12-19 20:22:43 -07:00
committed by GitHub
parent 46e50c4572
commit b3308736c4
21 changed files with 323 additions and 47 deletions

View File

@@ -216,6 +216,9 @@ export interface Form {
)[]
| null;
submitButtonLabel?: string | null;
/**
* Choose whether to display an on-page message or redirect to a different page after they submit the form.
*/
confirmationType?: ('message' | 'redirect') | null;
confirmationMessage?: {
root: {
@@ -240,6 +243,9 @@ export interface Form {
} | null;
url?: string | null;
};
/**
* Send custom emails when the form submits. Use comma separated lists to send the same email to multiple recipients. To reference a value from this form, wrap that field's name with double curly brackets, i.e. {{firstName}}. You can use a wildcard {{*}} to output all data and {{*:table}} to format it as an HTML table in the email.
*/
emails?:
| {
emailTo?: string | null;
@@ -248,6 +254,9 @@ export interface Form {
replyTo?: string | null;
emailFrom?: string | null;
subject: string;
/**
* Enter the message that should be sent in this email.
*/
message?: {
root: {
type: string;
@@ -304,6 +313,9 @@ export interface FormSubmission {
payment?: {
field?: string | null;
status?: string | null;
/**
* Amount in cents
*/
amount?: number | null;
paymentProcessor?: string | null;
creditCard?: {