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

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

@@ -1,259 +1,279 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "$id": "template-table-module",
+  "$id": "table-component-schematic",
   "allOf": [
     {
-      "$ref": "https://unpkg.com/@rxap/schematic-angular@16.1.0-dev.23/src/schematics/angular.schema.json"
+      "$ref": "#/definitions/angular"
     },
     {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "The name of the table",
-          "x-prompt": "Which name should the table module have?"
+      "$ref": "#/definitions/table"
+    }
+  ],
+  "definitions": {
+    "angular": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/general"
         },
-        "tableMethod": {
+        {
           "type": "object",
           "properties": {
+            "componentName": {
+              "type": "string"
+            },
             "name": {
+              "type": "string"
+            },
+            "context": {
               "type": "string",
-              "description": "The name of the table method class"
+              "description": "The context use to generate proper names for class, files, etc"
             },
-            "moduleSpecifier": {
+            "nestModule": {
               "type": "string",
-              "description": "The import path for the table method class"
+              "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
             }
-          },
-          "required": [
-            "name",
-            "moduleSpecifier"
-          ]
+          }
+        }
+      ]
+    },
+    "table": {
+      "allOf": [
+        {
+          "$ref": "#/definitions/minimumTable"
         },
-        "openApi": {
+        {
           "type": "object",
           "properties": {
-            "operationId": {
-              "type": "string",
-              "description": "The operationId for the open api operation"
+            "tableMethod": {
+              "$ref": "#/definitions/type"
             },
-            "adapter": {
+            "openApi": {
               "type": "object",
               "properties": {
-                "name": {
+                "operationId": {
                   "type": "string",
-                  "description": "The name of the open api adapter class"
+                  "description": "The operationId for the open api operation"
                 },
-                "moduleSpecifier": {
-                  "type": "string",
-                  "description": "The import path for the open api adapter class"
+                "adapter": {
+                  "$ref": "#/definitions/type"
                 }
               },
               "required": [
-                "name",
-                "moduleSpecifier"
+                "operationId"
               ]
+            },
+            "modifiers": {
+              "alias": "modifier",
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "navigation-back-header",
+                  "without-title",
+                  "show-archived-slide"
+                ]
+              },
+              "description": "The table modifiers"
+            },
+            "selectColumn": {
+              "type": "boolean",
+              "description": "Whether to add a select column to the table"
             }
-          },
-          "required": [
-            "operationId"
-          ]
+          }
+        }
+      ]
+    },
+    "backend": {
+      "type": "string",
+      "description": "The backend that should be used to handel data",
+      "enum": [
+        "none",
+        "nestjs",
+        "open-api",
+        "local"
+      ],
+      "default": "none"
+    },
+    "formControl": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the control"
         },
-        "modifiers": {
-          "alias": "modifier",
+        "type": {
+          "$ref": "#/definitions/type"
+        },
+        "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",
-            "enum": [
-              "navigation-back-header",
-              "without-title",
-              "show-archived-slide"
-            ]
-          },
-          "description": "The table modifiers"
+            "type": "string"
+          }
         },
-        "headerButton": {
-          "oneOf": [
+        "kind": {
+          "type": "string",
+          "description": "The name of the template",
+          "enum": [
+            "default",
+            "input",
+            "select",
+            "checkbox",
+            "autocomplete-table-select",
+            "table-select",
+            "textarea",
+            "slide-toggle"
+          ],
+          "default": "default"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": true
+    },
+    "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": "string"
+              "type": "boolean"
             },
             {
-              "type": "object",
-              "properties": {
-                "role": {
-                  "type": "string",
-                  "enum": [
-                    "form",
-                    "navigation",
-                    "method"
-                  ]
-                },
-                "permission": {
-                  "type": "string"
-                },
-                "icon": {
-                  "type": "string"
-                },
-                "svgIcon": {
-                  "type": "string"
-                },
-                "options": {
-                  "type": "object",
-                  "additionalProperties": true
-                }
-              },
-              "additionalProperties": true
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
             }
           ],
-          "description": "The header button configuration"
+          "description": "Overwrite existing files",
+          "default": false
+        },
+        "overwriteHtml": {
+          "type": "boolean",
+          "default": false
+        },
+        "replace": {
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
+    "headerButton": {
+      "type": "object",
+      "properties": {
+        "permission": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "svgIcon": {
+          "type": "string"
+        },
+        "refresh": {
+          "type": "boolean",
+          "description": "Whether the table action should refresh the table after execution",
+          "default": false
+        },
+        "confirm": {
+          "type": "boolean",
+          "description": "Whether the table action should confirm before execution",
+          "default": false
+        },
+        "tooltip": {
+          "type": "string",
+          "description": "The tooltip for the table action"
+        },
+        "errorMessage": {
+          "type": "string",
+          "description": "The error message for the table action"
         },
+        "successMessage": {
+          "type": "string",
+          "description": "The success message for the table action"
+        },
+        "options": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      }
+    },
+    "minimumTable": {
+      "type": "object",
+      "properties": {
         "propertyList": {
           "alias": "property",
           "type": "array",
           "items": {
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string"
-                  },
-                  "type": {
-                    "type": "string"
-                  }
-                },
-                "required": [
-                  "name"
-                ]
-              }
-            ]
+            "$ref": "#/definitions/property"
           }
         },
+        "upstream": {
+          "$ref": "#/definitions/upstream"
+        },
         "columnList": {
           "alias": "column",
           "type": "array",
           "items": {
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "object",
-                "properties": {
-                  "name": {
-                    "type": "string"
-                  },
-                  "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"
-                        ]
-                      }
-                    ]
-                  },
-                  "role": {
-                    "type": "string"
-                  },
-                  "modifiers": {
-                    "type": "array",
-                    "items": {
-                      "type": "string"
-                    }
-                  },
-                  "template": {
-                    "type": "string"
-                  },
-                  "pipeList": {
-                    "type": "array",
-                    "items": {
-                      "oneOf": [
-                        {
-                          "type": "string"
-                        },
-                        {
-                          "type": "object",
-                          "properties": {
-                            "name": {
-                              "type": "string"
-                            },
-                            "namedImport": {
-                              "type": "string"
-                            },
-                            "moduleSpecifier": {
-                              "type": "string"
-                            }
-                          },
-                          "required": [
-                            "name",
-                            "namedImport",
-                            "moduleSpecifier"
-                          ]
-                        }
-                      ]
-                    }
-                  },
-                  "hasFilter": {
-                    "type": "boolean"
-                  },
-                  "nowrap": {
-                    "type": "boolean"
-                  },
-                  "cssClass": {
-                    "type": "string"
-                  },
-                  "title": {
-                    "type": "string"
-                  },
-                  "propertyPath": {
-                    "type": "string"
-                  },
-                  "hidden": {
-                    "type": "boolean"
-                  },
-                  "active": {
-                    "type": "boolean"
-                  },
-                  "inactive": {
-                    "type": "boolean"
-                  },
-                  "show": {
-                    "type": "boolean"
-                  }
-                },
-                "required": [
-                  "name"
-                ]
-              }
-            ],
-            "description": "table column name"
+            "$ref": "#/definitions/tableColumn"
           },
           "description": "List of table column names"
         },
@@ -261,80 +281,307 @@
           "alias": "action",
           "type": "array",
           "items": {
-            "oneOf": [
-              {
-                "type": "string"
-              },
-              {
-                "type": "object",
-                "properties": {
-                  "type": {
-                    "type": "string"
-                  },
-                  "refresh": {
-                    "type": "boolean"
-                  },
-                  "confirm": {
-                    "type": "boolean"
-                  },
-                  "tooltip": {
-                    "type": "string"
-                  },
-                  "errorMessage": {
-                    "type": "string"
-                  },
-                  "successMessage": {
-                    "type": "string"
-                  },
-                  "priority": {
-                    "type": "number"
-                  },
-                  "checkFunction": {
-                    "type": "string"
-                  },
-                  "inHeader": {
-                    "type": "boolean"
-                  },
-                  "role": {
-                    "type": "string"
-                  },
-                  "icon": {
-                    "type": "string"
-                  },
-                  "svgIcon": {
-                    "type": "string"
-                  },
-                  "permission": {
-                    "type": "string"
-                  },
-                  "color": {
-                    "type": "string",
-                    "description": "Value for the color input of the mat-button / mat-icon component"
-                  },
-                  "cssClass": {
-                    "type": "string",
-                    "description": "Additional CSS classes added to the button element"
-                  },
-                  "options": {
-                    "type": "object",
-                    "additionalProperties": true
+            "$ref": "#/definitions/tableAction"
+          }
+        },
+        "headerButton": {
+          "$ref": "#/definitions/headerButton"
+        },
+        "modifiers": {
+          "alias": "modifier",
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "The table modifiers"
+        }
+      }
+    },
+    "pipe": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "allOf": [
+            {
+              "$ref": "#/definitions/type"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "argumentList": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/definitions/value"
                   }
-                },
-                "required": [
-                  "type"
-                ]
-              }
-            ]
+                }
+              },
+              "required": [
+                "name"
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    "property": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "$ref": "#/definitions/type"
+            },
+            "isArray": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "name"
+          ]
+        }
+      ]
+    },
+    "tableAction": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string"
+        },
+        "refresh": {
+          "type": "boolean"
+        },
+        "confirm": {
+          "type": "boolean"
+        },
+        "tooltip": {
+          "type": "string"
+        },
+        "errorMessage": {
+          "type": "string"
+        },
+        "successMessage": {
+          "type": "string"
+        },
+        "priority": {
+          "type": "number"
+        },
+        "checkFunction": {
+          "type": "string"
+        },
+        "inHeader": {
+          "type": "boolean"
+        },
+        "role": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "svgIcon": {
+          "type": "string"
+        },
+        "permission": {
+          "type": "string"
+        },
+        "color": {
+          "type": "string",
+          "description": "Value for the color input of the mat-button / mat-icon component"
+        },
+        "cssClass": {
+          "type": "string",
+          "description": "Additional CSS classes added to the button element"
+        },
+        "options": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      },
+      "required": [
+        "type"
+      ]
+    },
+    "tableColumn": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "$ref": "#/definitions/type"
+        },
+        "kind": {
+          "type": "string"
+        },
+        "modifiers": {
+          "type": "array",
+          "items": {
+            "type": "string"
           }
         },
-        "selectColumn": {
-          "type": "boolean",
-          "description": "Whether to add a select column to the table"
+        "template": {
+          "type": "string"
+        },
+        "pipeList": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/pipe"
+          }
+        },
+        "hasFilter": {
+          "type": "boolean"
+        },
+        "nowrap": {
+          "type": "boolean"
+        },
+        "cssClass": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        },
+        "propertyPath": {
+          "type": "string"
+        },
+        "hidden": {
+          "type": "boolean"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "inactive": {
+          "type": "boolean"
+        },
+        "show": {
+          "type": "boolean"
+        },
+        "filterControl": {
+          "$ref": "#/definitions/formControl"
         }
       },
       "required": [
         "name"
       ]
+    },
+    "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"
+          ]
+        }
+      ]
+    },
+    "value": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "$ref": "#/definitions/type"
+            },
+            "value": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "value"
+          ]
+        }
+      ]
     }
-  ]
-}
+  }
+}