@rxap/schematic-angular 16.2.0-dev.2 → 16.2.0-dev.21

package/src/schematics/form/form-component/schema.json

@@ -1,173 +1,878 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "$id": "form-component",
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "description": "The name of form",
-      "x-prompt": "Enter the name of the form?"
+  "$id": "form-component-schematic",
+  "allOf": [
+    {
+      "$ref": "#/definitions/angular"
     },
-    "project": {
-      "type": "string",
-      "description": "The project where the module should be created",
-      "x-prompt": "Enter project name where the module should be created"
+    {
+      "$ref": "#/definitions/formComponent"
+    }
+  ],
+  "definitions": {
+    "abstractControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/property"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "The name of the control"
+            },
+            "isArray": {
+              "type": "boolean",
+              "description": "Whether the control value is an array",
+              "default": false
+            },
+            "state": {
+              "type": "string",
+              "description": "The initial state of the control"
+            },
+            "isRequired": {
+              "type": "boolean",
+              "description": "Whether the control value is required",
+              "default": false
+            },
+            "isReadonly": {
+              "type": "boolean",
+              "description": "Whether the control value is readonly",
+              "default": false
+            },
+            "isDisabled": {
+              "type": "boolean",
+              "description": "Whether the control value is disabled",
+              "default": false
+            },
+            "validatorList": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "kind": {
+              "type": "string",
+              "description": "The kind of the control",
+              "default": "default"
+            },
+            "importList": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/type"
+              }
+            },
+            "template": {
+              "type": "string",
+              "description": "The template of the control"
+            },
+            "role": {
+              "type": "string",
+              "description": "The role of the control",
+              "enum": [
+                "control",
+                "group",
+                "array"
+              ],
+              "default": "control"
+            }
+          },
+          "additionalProperties": true
+        }
+      ]
     },
-    "feature": {
-      "type": "string",
-      "description": "The feature where the module should be created",
-      "x-prompt": "Enter feature name where the module should be created"
+    "accordionIdentifier": {
+      "type": "object",
+      "properties": {
+        "property": {
+          "$ref": "#/definitions/property"
+        },
+        "source": {
+          "type": "string",
+          "enum": [
+            "route"
+          ],
+          "default": "route"
+        }
+      },
+      "required": [
+        "property"
+      ]
+    },
+    "angular": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/general"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "componentName": {
+              "type": "string"
+            },
+            "name": {
+              "type": "string"
+            },
+            "context": {
+              "type": "string",
+              "description": "The context use to generate proper names for class, files, etc"
+            },
+            "nestModule": {
+              "type": "string",
+              "description": "The module name for the table nest operations"
+            },
+            "controllerName": {
+              "type": "string"
+            },
+            "backend": {
+              "$ref": "#/definitions/backend"
+            },
+            "directory": {
+              "type": "string",
+              "description": "A directory name or absolute path where the files should be generated. Relative to the project and feature base path if a feature is defined"
+            },
+            "shared": {
+              "type": "boolean",
+              "description": "Whether the generated code is used across the project",
+              "default": false
+            },
+            "scope": {
+              "type": "string"
+            },
+            "prefix": {
+              "type": "string"
+            },
+            "openApi": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          }
+        }
+      ]
     },
     "backend": {
       "type": "string",
       "description": "The backend that should be used to handel data",
       "enum": [
         "none",
-        "local",
         "nestjs",
-        "open-api"
+        "open-api",
+        "local"
       ],
       "default": "none"
     },
-    "shared": {
-      "type": "boolean",
-      "description": "Whether the form is shared across applications"
+    "baseFormArray": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/abstractControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "controlList": {
+              "type": "array",
+              "description": "The list of controls in the group",
+              "items": {
+                "$ref": "#/definitions/control"
+              }
+            },
+            "legend": {
+              "type": "string"
+            },
+            "groupLegend": {
+              "type": "string"
+            },
+            "kind": {
+              "type": "string",
+              "description": "The kind of the array",
+              "const": "default",
+              "default": "default"
+            },
+            "role": {
+              "type": "string",
+              "const": "array"
+            }
+          }
+        }
+      ]
     },
-    "window": {
-      "type": "boolean",
-      "description": "Whether the form can be opened in a window"
+    "baseFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/abstractControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "label": {
+              "type": "string",
+              "description": "The label of the control"
+            },
+            "role": {
+              "type": "string",
+              "const": "control"
+            }
+          }
+        }
+      ]
     },
-    "directory": {
-      "type": "string",
-      "description": "A path suffix added to the base path"
+    "baseFormGroup": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/abstractControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "controlList": {
+              "type": "array",
+              "description": "The list of controls in the group",
+              "items": {
+                "$ref": "#/definitions/control"
+              }
+            },
+            "legend": {
+              "type": "string"
+            },
+            "kind": {
+              "type": "string",
+              "description": "The kind of the group",
+              "const": "default",
+              "default": "default"
+            },
+            "role": {
+              "type": "string",
+              "const": "group"
+            }
+          }
+        }
+      ]
     },
-    "role": {
-      "type": "string",
-      "description": "Define the role of the form"
+    "button": {
+      "type": "object",
+      "properties": {
+        "svgIcon": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "directiveList": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type"
+          }
+        },
+        "importList": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/type"
+          }
+        }
+      }
     },
-    "nestModule": {
-      "type": "string",
-      "description": "Name of the nest module where the controller is created"
+    "checkboxFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseFormControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "checkbox"
+            },
+            "labelPosition": {
+              "type": "string",
+              "enum": [
+                "before",
+                "after"
+              ]
+            }
+          }
+        }
+      ]
     },
-    "controllerName": {
-      "type": "string",
-      "description": "Name of the nest controller"
-    },
-    "matFormFieldDefaultOptions": {
-      "appearance": {
-        "type": "string",
-        "description": "The appearance of the mat form field",
-        "enum": [
-          "legacy",
-          "standard",
-          "fill",
-          "outline"
-        ]
+    "control": {
+      "oneOf": [
+        {
+          "$ref": "#/definitions/formGroup"
+        },
+        {
+          "$ref": "#/definitions/formArray"
+        },
+        {
+          "$ref": "#/definitions/formControl"
+        }
+      ]
+    },
+    "formArray": {
+      "allOf": [
+        {
+          "type": "object",
+          "properties": {
+            "role": {
+              "type": "string",
+              "const": "array"
+            }
+          }
+        },
+        {
+          "oneOf": [
+            {
+              "allOf": [
+                {
+                  "$ref": "#/definitions/baseFormArray"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "kind": {
+                      "type": "string",
+                      "const": "default"
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    "formComponent": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/formDefinition"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "window": {
+              "type": "boolean",
+              "description": "Whether the form can be opened in a window"
+            },
+            "role": {
+              "type": "string",
+              "description": "Define the role of the form"
+            },
+            "matFormFieldDefaultOptions": {
+              "appearance": {
+                "type": "string",
+                "description": "The appearance of the mat form field",
+                "enum": [
+                  "legacy",
+                  "standard",
+                  "fill",
+                  "outline"
+                ]
+              }
+            },
+            "identifier": {
+              "$ref": "#/definitions/accordionIdentifier"
+            }
+          }
+        }
+      ]
+    },
+    "formControl": {
+      "allOf": [
+        {
+          "type": "object",
+          "properties": {
+            "role": {
+              "type": "string",
+              "const": "control",
+              "default": "control"
+            }
+          }
+        },
+        {
+          "oneOf": [
+            {
+              "allOf": [
+                {
+                  "$ref": "#/definitions/baseFormControl"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "kind": {
+                      "type": "string",
+                      "const": "default"
+                    }
+                  }
+                }
+              ]
+            },
+            {
+              "$ref": "#/definitions/inputFormControl"
+            },
+            {
+              "$ref": "#/definitions/selectFormControl"
+            },
+            {
+              "$ref": "#/definitions/checkboxFormControl"
+            },
+            {
+              "$ref": "#/definitions/textareaFormControl"
+            },
+            {
+              "$ref": "#/definitions/tableSelectFormControl"
+            },
+            {
+              "$ref": "#/definitions/slideToggleFormControl"
+            }
+          ]
+        }
+      ]
+    },
+    "formDefinition": {
+      "type": "object",
+      "properties": {
+        "controlList": {
+          "alias": "control",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/control"
+          }
+        }
+      },
+      "required": [
+        "controlList"
+      ]
+    },
+    "formField": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string"
+        },
+        "prefixButton": {
+          "$ref": "#/definitions/button"
+        },
+        "suffixButton": {
+          "$ref": "#/definitions/button"
+        },
+        "hasClearButton": {
+          "type": "boolean"
+        }
       }
     },
-    "controlList": {
-      "alias": "control",
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "The name of the control"
-          },
-          "type": {
-            "oneOf": [
-              {
+    "formGroup": {
+      "allOf": [
+        {
+          "type": "object",
+          "properties": {
+            "role": {
+              "type": "string",
+              "const": "group"
+            }
+          }
+        },
+        {
+          "oneOf": [
+            {
+              "allOf": [
+                {
+                  "$ref": "#/definitions/baseFormGroup"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "kind": {
+                      "type": "string",
+                      "const": "default"
+                    }
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    "general": {
+      "type": "object",
+      "properties": {
+        "project": {
+          "type": "string",
+          "description": "Project name where the files should be generated"
+        },
+        "feature": {
+          "type": "string",
+          "description": "Feature name where the files should be generated"
+        },
+        "overwrite": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "array",
+              "items": {
                 "type": "string"
-              },
-              {
+              }
+            }
+          ],
+          "description": "Overwrite existing files",
+          "default": false
+        },
+        "overwriteHtml": {
+          "type": "boolean",
+          "default": false
+        },
+        "replace": {
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "inputFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseFormControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "input"
+            },
+            "formField": {
+              "$ref": "#/definitions/formField"
+            },
+            "inputType": {
+              "type": "string",
+              "enum": [
+                "text",
+                "password",
+                "email",
+                "number",
+                "tel",
+                "url",
+                "checkbox",
+                "color",
+                "date",
+                "time",
+                "datetime-local",
+                "file",
+                "hidden",
+                "image",
+                "month",
+                "radio",
+                "reset",
+                "button",
+                "search",
+                "submit",
+                "week",
+                "range"
+              ]
+            },
+            "placeholder": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
+    "property": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "$ref": "#/definitions/type"
+            },
+            "isArray": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "name"
+          ]
+        }
+      ]
+    },
+    "selectFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseFormControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "formField": {
+              "$ref": "#/definitions/formField"
+            },
+            "kind": {
+              "type": "string",
+              "const": "select"
+            },
+            "optionList": {
+              "type": "array",
+              "items": {
                 "type": "object",
                 "properties": {
-                  "name": {
+                  "display": {
                     "type": "string"
                   },
-                  "isTypeOnly": {
-                    "type": "boolean"
-                  },
-                  "moduleSpecifier": {
-                    "type": "string"
+                  "value": {
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      },
+                      {
+                        "type": "boolean"
+                      },
+                      {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    ]
+                  }
+                }
+              }
+            },
+            "backend": {
+              "$ref": "#/definitions/backend"
+            },
+            "multiple": {
+              "alias": "multi",
+              "type": "boolean",
+              "description": "Whether the select form control is multiple mode"
+            }
+          }
+        }
+      ]
+    },
+    "slideToggleFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseFormControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "slide-toggle"
+            },
+            "labelPosition": {
+              "type": "string",
+              "enum": [
+                "before",
+                "after"
+              ]
+            }
+          }
+        }
+      ]
+    },
+    "tableSelectFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseFormControl"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "formField": {
+              "$ref": "#/definitions/formField"
+            },
+            "kind": {
+              "type": "string",
+              "const": "table-select"
+            },
+            "placeholder": {
+              "type": "string"
+            },
+            "columnList": {
+              "alias": "column",
+              "type": "array",
+              "items": {
+                "description": "table column name",
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "table column name"
                   },
-                  "namedImport": {
-                    "type": "string"
+                  "title": {
+                    "type": "string",
+                    "description": "table column label"
                   },
-                  "namespaceImport": {
-                    "type": "string"
+                  "hasFilter": {
+                    "type": "boolean",
+                    "description": "Whether the column has a filter"
                   },
-                  "defaultImport": {
-                    "type": "string"
+                  "kind": {
+                    "type": "string",
+                    "description": "The kind of data in the column"
                   }
-                },
-                "required": [
-                  "name"
-                ]
+                }
+              },
+              "description": "List of table column names"
+            },
+            "title": {
+              "type": "string",
+              "description": "The title of the table select window"
+            },
+            "toDisplay": {
+              "type": "object",
+              "properties": {
+                "property": {
+                  "$ref": "#/definitions/property"
+                }
               }
-            ]
-          },
-          "isArray": {
-            "type": "boolean",
-            "description": "Whether the control value is an array",
-            "default": false
-          },
-          "state": {
-            "type": "string",
-            "description": "The initial state of the control"
-          },
-          "isRequired": {
-            "type": "boolean",
-            "description": "Whether the control value is required",
-            "default": false
-          },
-          "isReadonly": {
-            "type": "boolean",
-            "description": "Whether the control value is readonly",
-            "default": false
-          },
-          "isDisabled": {
-            "type": "boolean",
-            "description": "Whether the control value is disabled",
-            "default": false
-          },
-          "validatorList": {
-            "type": "array",
-            "items": {
-              "type": "string"
-            }
-          },
-          "template": {
-            "type": "object",
-            "properties": {
-              "name": {
-                "type": "string",
-                "description": "The name of the template",
-                "enum": [
-                  "default",
-                  "input",
-                  "select"
-                ]
+            },
+            "toValue": {
+              "type": "object",
+              "properties": {
+                "property": {
+                  "$ref": "#/definitions/property"
+                }
               }
             },
-            "additionalProperties": true,
-            "required": ["name"]
+            "upstream": {
+              "$ref": "#/definitions/upstream"
+            },
+            "resolver": {
+              "type": "object",
+              "properties": {
+                "upstream": {
+                  "$ref": "#/definitions/upstream"
+                }
+              }
+            }
           }
+        }
+      ]
+    },
+    "textareaFormControl": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/baseFormControl"
         },
-        "required": [
-          "name"
-        ]
-      }
+        {
+          "type": "object",
+          "properties": {
+            "formField": {
+              "$ref": "#/definitions/formField"
+            },
+            "kind": {
+              "type": "string",
+              "const": "textarea"
+            },
+            "placeholder": {
+              "type": "string"
+            }
+          }
+        }
+      ]
     },
-    "context": {
-      "type": "string",
-      "description": "The context use to generate proper names for class, files, etc"
+    "type": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "isTypeOnly": {
+              "type": "boolean"
+            },
+            "moduleSpecifier": {
+              "type": "string"
+            },
+            "namedImport": {
+              "type": "string"
+            },
+            "namespaceImport": {
+              "type": "string"
+            },
+            "defaultImport": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "name"
+          ]
+        }
+      ]
+    },
+    "upstream": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "enum": [
+                "open-api"
+              ]
+            },
+            "operationId": {
+              "type": "string"
+            },
+            "scope": {
+              "type": "string"
+            },
+            "mapper": {
+              "type": "object",
+              "properties": {
+                "pageIndex": {
+                  "type": "string"
+                },
+                "pageSize": {
+                  "type": "string"
+                },
+                "sortBy": {
+                  "type": "string"
+                },
+                "sortDirection": {
+                  "type": "string"
+                },
+                "list": {
+                  "type": "string"
+                },
+                "total": {
+                  "type": "string"
+                },
+                "filter": {
+                  "type": "object",
+                  "properties": {
+                    "eq": {
+                      "type": "string"
+                    },
+                    "join": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "required": [
+            "kind",
+            "operationId"
+          ]
+        }
+      ]
     }
-  },
-  "required": [
-    "name",
-    "project",
-    "feature"
-  ]
-}
+  }
+}