@es-plus/cli 1.0.0

package/schemas/index.schema.json

@@ -0,0 +1,71 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://es-plus-ui.github.io/schemas/index.schema.json",
+  "title": "ES-Plus UI Configuration Schema",
+  "description": "Complete JSON Schema for es-plus-ui component library configuration. Covers EsForm, EsTable, useDialog, and shared types.",
+  "definitions": {
+    "FormItemOption": {
+      "$ref": "form-item.schema.json"
+    },
+    "TableColumn": {
+      "$ref": "table-column.schema.json"
+    },
+    "TableOptions": {
+      "$ref": "table-options.schema.json"
+    },
+    "BtnConfig": {
+      "$ref": "btn-config.schema.json"
+    },
+    "DialogOptions": {
+      "$ref": "dialog-options.schema.json"
+    },
+    "ApiParams": {
+      "$ref": "api-params.schema.json"
+    },
+    "FormItemList": {
+      "type": "array",
+      "description": "Array of form field configurations",
+      "items": { "$ref": "form-item.schema.json" }
+    },
+    "TableColumnList": {
+      "type": "array",
+      "description": "Array of table column configurations",
+      "items": { "$ref": "table-column.schema.json" }
+    },
+    "PaginationConfig": {
+      "type": "object",
+      "description": "Pagination configuration",
+      "properties": {
+        "pageSize": {
+          "type": "integer",
+          "default": 10,
+          "description": "Number of items per page"
+        },
+        "current": {
+          "type": "integer",
+          "default": 1,
+          "description": "Current page number"
+        },
+        "total": {
+          "type": "integer",
+          "description": "Total number of records"
+        },
+        "pageSizes": {
+          "type": "array",
+          "items": { "type": "integer" },
+          "description": "Available page size options"
+        },
+        "size": {
+          "type": "string",
+          "enum": ["large", "default", "small"],
+          "default": "small"
+        },
+        "isSmall": {
+          "type": "boolean",
+          "default": true,
+          "description": "Use compact pagination style"
+        }
+      }
+    }
+  }
+}

package/schemas/table-column.schema.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://es-plus-ui.github.io/schemas/table-column.schema.json",
+  "title": "EsTable Column Configuration",
+  "description": "Configuration for a single column in es-plus-ui EsTable component",
+  "type": "object",
+  "properties": {
+    "prop": {
+      "type": "string",
+      "description": "Data field name in the row object"
+    },
+    "key": {
+      "type": "string",
+      "description": "Alternative to prop. Column unique identifier (converted to prop internally)"
+    },
+    "label": {
+      "type": "string",
+      "description": "Column header text"
+    },
+    "labelKey": {
+      "type": "string",
+      "description": "i18n translation key for the column header. When a global t() function is configured via app.use(ESPlus, { t }), the header will be translated using t(labelKey). Falls back to label when t() is not configured"
+    },
+    "width": {
+      "oneOf": [
+        { "type": "number" },
+        { "type": "string" }
+      ],
+      "description": "Column width in pixels"
+    },
+    "minWidth": {
+      "oneOf": [
+        { "type": "number" },
+        { "type": "string" }
+      ],
+      "description": "Minimum column width"
+    },
+    "align": {
+      "type": "string",
+      "enum": ["left", "center", "right"],
+      "default": "center",
+      "description": "Text alignment"
+    },
+    "fixed": {
+      "oneOf": [
+        { "type": "boolean" },
+        { "type": "string", "enum": ["left", "right"] }
+      ],
+      "description": "Fix column to left or right side"
+    },
+    "formatter": {
+      "description": "Function (row) => string. Format cell display value"
+    },
+    "render": {
+      "description": "Custom render function (h, { row, value, index }) => VNode"
+    },
+    "scopedSlots": {
+      "type": "object",
+      "description": "Named slot configuration for custom column rendering",
+      "properties": {
+        "customRender": {
+          "type": "string",
+          "description": "Slot name to use for rendering this column"
+        }
+      }
+    },
+    "groups": {
+      "type": "array",
+      "description": "Nested child columns for multi-level headers",
+      "items": { "$ref": "#" }
+    },
+    "ellipsis": {
+      "type": "boolean",
+      "description": "Enable text overflow ellipsis with tooltip"
+    },
+    "hidCol": {
+      "type": "boolean",
+      "description": "Hide this column from rendering"
+    },
+    "btns": {
+      "type": "array",
+      "description": "Row operation buttons (typically used in an 'actions' column)",
+      "items": {
+        "type": "object",
+        "required": ["name"],
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Button text"
+          },
+          "type": {
+            "type": "string",
+            "enum": ["primary", "success", "warning", "danger", "info", ""],
+            "default": "primary",
+            "description": "Button type (renders as text/link button)"
+          },
+          "clickEvent": {
+            "description": "Function (row) => void. Click handler receiving the row data"
+          },
+          "permissionValue": {
+            "type": "string",
+            "description": "Permission code for button visibility. When a global permission() function is configured, buttons with unmatched permissionValue will be hidden"
+          }
+      }
+    },
+    "type": {
+      "type": "string",
+      "enum": ["selection", "expand", "index"],
+      "description": "Special column type: selection checkbox, expand row, or row index"
+    },
+    "emptyPlaceholder": {
+      "type": "string",
+      "default": "-",
+      "description": "Placeholder text for empty cell values"
+    }
+  },
+  "additionalProperties": true
+}

package/schemas/table-options.schema.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://es-plus-ui.github.io/schemas/table-options.schema.json",
+  "title": "EsTable Options Configuration",
+  "description": "Configuration object for es-plus-ui EsTable options prop",
+  "type": "object",
+  "properties": {
+    "border": {
+      "type": "boolean",
+      "default": false,
+      "description": "Show table border"
+    },
+    "stripe": {
+      "type": "boolean",
+      "default": false,
+      "description": "Show striped rows"
+    },
+    "size": {
+      "type": "string",
+      "enum": ["large", "default", "small"],
+      "default": "small",
+      "description": "Table size"
+    },
+    "headerCellStyle": {
+      "type": "object",
+      "default": { "background": "#f5f7fa" },
+      "description": "Style object for header cells"
+    },
+    "highlightCurrentRow": {
+      "type": "boolean",
+      "default": true,
+      "description": "Highlight the currently selected row"
+    },
+    "multiSelect": {
+      "type": "boolean",
+      "default": false,
+      "description": "Show checkbox selection column"
+    },
+    "expand": {
+      "type": "boolean",
+      "default": false,
+      "description": "Show expand row column"
+    },
+    "snIndex": {
+      "type": "boolean",
+      "default": false,
+      "description": "Show row index column"
+    },
+    "loading": {
+      "type": "boolean",
+      "default": false,
+      "description": "Show loading overlay"
+    },
+    "heightType": {
+      "type": "string",
+      "enum": ["auto", "height", "maxHeight"],
+      "description": "Height calculation mode. 'height' recommended for adaptive height with ResizeObserver"
+    },
+    "tabHeight": {
+      "oneOf": [
+        { "type": "number" },
+        { "type": "string" }
+      ],
+      "description": "Container height value (used with heightType)"
+    },
+    "cachePageSelection": {
+      "type": "boolean",
+      "default": true,
+      "description": "Persist checkbox selections across page changes"
+    },
+    "rowkey": {
+      "type": "string",
+      "description": "Row unique identifier field name. Required for cross-page selection"
+    },
+    "isInitRun": {
+      "type": "boolean",
+      "default": true,
+      "description": "Auto-fetch data on component mount"
+    },
+    "httpRequest": {
+      "description": "Custom request handler. Signature: (params: { url, method, headers, formParams, pageIndex, pageSize }) => Promise<response>"
+    },
+    "apiParams": {
+      "$ref": "api-params.schema.json",
+      "description": "API request configuration"
+    },
+    "actionUrl": {
+      "type": "string",
+      "description": "API endpoint URL (shorthand for apiParams.url)"
+    },
+    "configTableOut": {
+      "type": "object",
+      "description": "Map backend response field names to internal fields. Uses recursive key lookup (no dot-path needed)",
+      "properties": {
+        "total": {
+          "type": "string",
+          "description": "Field name for total record count in response"
+        },
+        "tableData": {
+          "type": "string",
+          "description": "Field name for data array in response"
+        },
+        "pageSize": {
+          "type": "string",
+          "description": "Field name for page size in response"
+        },
+        "current": {
+          "type": "string",
+          "description": "Field name for current page number in response"
+        }
+      }
+    },
+    "listenToCallBack": {
+      "type": "object",
+      "description": "Request/response interceptor pipeline",
+      "properties": {
+        "brcb": {
+          "description": "Before Request CallBack. Function (params) => transformedParams"
+        },
+        "qrcb": {
+          "description": "Query Result CallBack. Function (response) => transformedResponse"
+        }
+      }
+    },
+    "entryQuery": {
+      "type": "object",
+      "description": "Default query parameters when no form is connected",
+      "additionalProperties": true
+    },
+    "configBtn": {
+      "type": "array",
+      "description": "Table header toolbar buttons",
+      "items": { "$ref": "btn-config.schema.json" }
+    },
+    "leftText": {
+      "type": "string",
+      "description": "Text displayed on the left side of the table toolbar"
+    }
+  },
+  "additionalProperties": true
+}