@uni-helper/pages-json-schema 0.1.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 KeJun <https://github.com/kejunmao>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@uni-helper/pages-json-schema",
+  "version": "0.1.7",
+  "description": "Schema for uni-app pages.json",
+  "author": "KeJun",
+  "license": "MIT",
+  "homepage": "https://github.com/uni-helper/vite-plugin-uni-pages#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uni-helper/vite-plugin-uni-pages.git"
+  },
+  "bugs": "https://github.com/uni-helper/vite-plugin-uni-pages/issues",
+  "keywords": [
+    "jsonschema"
+  ],
+  "devDependencies": {
+    "ts-json-schema-generator": "^1.2.0"
+  },
+  "scripts": {
+    "generate": "ts-json-schema-generator -p \"../core/src/config/types/index.ts\" -t \"PagesConfig\" -o \"schema.json\" --no-type-check"
+  }
+}

package/schema.json

@@ -0,0 +1,710 @@
+{
+  "$ref": "#/definitions/PagesConfig",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "definitions": {
+    "AppPlus": {
+      "properties": {
+        "animationDuration": {
+          "default": "300",
+          "description": "窗口显示动画的持续时间，单位为 ms。",
+          "type": "number"
+        },
+        "animationType": {
+          "default": "pop-in",
+          "description": "窗口显示的动画效果，详见：窗口动画。",
+          "type": "string"
+        },
+        "background": {
+          "$ref": "#/definitions/HEXColor",
+          "default": "#FFFFFF",
+          "description": "窗体背景色。无论vue页面还是nvue页面，在App上都有一个父级原生窗体，该窗体的背景色生效时间快于页面里的css生效时间"
+        },
+        "bounce": {
+          "description": "页面回弹效果，设置为 \"none\" 时关闭效果。",
+          "type": "string"
+        },
+        "popGesture": {
+          "default": "close",
+          "description": "侧滑返回功能，可选值：\"close\"（启用侧滑返回）、\"none\"（禁用侧滑返回）",
+          "type": "string"
+        },
+        "pullToRefresh": {
+          "description": "下拉刷新",
+          "type": "object"
+        },
+        "scrollIndicator": {
+          "description": "滚动条显示策略，设置为 \"none\" 时不显示滚动条。",
+          "type": "string"
+        },
+        "softInputMode": {
+          "default": "adjustPan",
+          "description": "软键盘弹出模式，支持 adjustResize、adjustPan 两种模式",
+          "type": "string"
+        },
+        "softInputNavBar": {
+          "default": "auto",
+          "description": "iOS软键盘上完成工具栏的显示模式，设置为 \"none\" 时关闭工具栏。",
+          "type": "string"
+        },
+        "subNVues": {
+          "description": "原生子窗体，详见?:原生子窗体",
+          "type": "object"
+        },
+        "titleNView": {
+          "description": "导航栏 ，详见?:导航栏",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "Color": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/RGBColor"
+        },
+        {
+          "$ref": "#/definitions/RGBAColor"
+        },
+        {
+          "$ref": "#/definitions/HEXColor"
+        }
+      ]
+    },
+    "Condition": {
+      "additionalProperties": false,
+      "properties": {
+        "current": {
+          "description": "当前激活的模式，list节点的索引值",
+          "type": "number"
+        },
+        "list": {
+          "description": "启动模式列表",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "name": {
+                "description": "启动模式名称",
+                "type": "string"
+              },
+              "path": {
+                "description": "启动页面路径",
+                "type": "string"
+              },
+              "query": {
+                "description": "启动参数，可在页面的 onLoad 函数里获得",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "EasyCom": {
+      "additionalProperties": false,
+      "properties": {
+        "autoscan": {
+          "type": "boolean"
+        },
+        "custom": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "type": "object"
+        }
+      },
+      "required": [
+        "autoscan",
+        "custom"
+      ],
+      "type": "object"
+    },
+    "GlobalStyle": {
+      "properties": {
+        "animationDuration": {
+          "default": "300",
+          "description": "窗口显示动画的持续时间，单位为 ms",
+          "type": "number"
+        },
+        "animationType": {
+          "default": "pop-in",
+          "description": "窗口显示的动画效果，详见：窗口动画",
+          "type": "string"
+        },
+        "app-plus": {
+          "$ref": "#/definitions/AppPlus",
+          "description": "设置编译到 App 平台的特定样式，配置项参考下方 app-plus"
+        },
+        "backgroundColor": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/HEXColor"
+            },
+            {
+              "$ref": "#/definitions/ThemeColor"
+            }
+          ],
+          "default": "#ffffff",
+          "description": "下拉显示出来的窗口的背景色"
+        },
+        "backgroundColorBottom": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/HEXColor"
+            },
+            {
+              "$ref": "#/definitions/ThemeColor"
+            }
+          ],
+          "default": "#ffffff",
+          "description": "底部窗口的背景色（bounce回弹区域）"
+        },
+        "backgroundColorTop": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/HEXColor"
+            },
+            {
+              "$ref": "#/definitions/ThemeColor"
+            }
+          ],
+          "default": "#ffffff",
+          "description": "顶部窗口的背景色（bounce回弹区域）"
+        },
+        "backgroundTextStyle": {
+          "default": "dark",
+          "description": "下拉 loading 的样式，仅支持 dark / light",
+          "type": "string"
+        },
+        "dynamicRpx": {
+          "default": "false",
+          "description": "动态 rpx，屏幕大小变化会重新渲染 rpx",
+          "type": "boolean"
+        },
+        "enablePullDownRefresh": {
+          "default": "false",
+          "description": "是否开启下拉刷新，详见页面生命周期。",
+          "type": "boolean"
+        },
+        "h5": {
+          "$ref": "#/definitions/H5",
+          "description": "设置编译到 H5 平台的特定样式，配置项参考下方 H5"
+        },
+        "leftWindow": {
+          "default": "true",
+          "description": "当存在 leftWindow 时，默认是否显示 leftWindow",
+          "type": "boolean"
+        },
+        "maxWidth": {
+          "description": "单位px，当浏览器可见区域宽度大于maxWidth时，两侧留白，当小于等于maxWidth时，页面铺满；不同页面支持配置不同的maxWidth；maxWidth = leftWindow(可选)+page(页面主体)+rightWindow(可选)",
+          "type": "number"
+        },
+        "mp-alipay": {
+          "description": "设置编译到 mp-alipay 平台的特定样式，配置项参考下方 MP-ALIPAY",
+          "type": "object"
+        },
+        "mp-baidu": {
+          "description": "设置编译到 mp-baidu 平台的特定样式",
+          "type": "object"
+        },
+        "mp-jd": {
+          "description": "设置编译到 mp-jd 平台的特定样式",
+          "type": "object"
+        },
+        "mp-kuaishou": {
+          "description": "设置编译到 mp-kuaishou 平台的特定样式",
+          "type": "object"
+        },
+        "mp-lark": {
+          "description": "设置编译到 mp-lark 平台的特定样式",
+          "type": "object"
+        },
+        "mp-qq": {
+          "description": "设置编译到 mp-qq 平台的特定样式",
+          "type": "object"
+        },
+        "mp-toutiao": {
+          "description": "设置编译到 mp-toutiao 平台的特定样式",
+          "type": "object"
+        },
+        "mp-weixin": {
+          "description": "设置编译到 mp-weixin 平台的特定样式",
+          "type": "object"
+        },
+        "navigationBarBackgroundColor": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/HEXColor"
+            },
+            {
+              "$ref": "#/definitions/ThemeColor"
+            }
+          ],
+          "default": "#F7F7F7",
+          "description": "导航栏背景颜色（同状态栏背景色）"
+        },
+        "navigationBarTextStyle": {
+          "default": "white",
+          "description": "导航栏标题颜色及状态栏前景颜色，仅支持 black/white",
+          "type": "string"
+        },
+        "navigationBarTitleText": {
+          "description": "导航栏标题文字内容",
+          "type": "string"
+        },
+        "navigationStyle": {
+          "default": "default",
+          "description": "导航栏样式，仅支持 default/custom。custom即取消默认的原生导航栏，需看使用注意",
+          "type": "string"
+        },
+        "onReachBottomDistance": {
+          "default": "50",
+          "description": "页面上拉触底事件触发时距页面底部距离，单位只支持px，详见页面生命周期",
+          "type": "number"
+        },
+        "pageOrientation": {
+          "default": "portrait",
+          "description": "横屏配置，屏幕旋转设置，仅支持 auto / portrait / landscape 详见 响应显示区域变化",
+          "type": "string"
+        },
+        "renderingMode": {
+          "description": "同层渲染，webrtc(实时音视频) 无法正常时尝试配置 seperated 强制关掉同层",
+          "type": "string"
+        },
+        "rightWindow": {
+          "default": "true",
+          "description": "当存在 rightWindow 时，默认是否显示 rightWindow",
+          "type": "boolean"
+        },
+        "rpxCalcBaseDeviceWidth": {
+          "default": "375",
+          "description": "rpx 计算使用的基准设备宽度，设备实际宽度超出 rpx 计算所支持的最大设备宽度时将按基准宽度计算，单位 px",
+          "type": "number"
+        },
+        "rpxCalcIncludeWidth": {
+          "default": "750",
+          "description": "rpx 计算特殊处理的值，始终按实际的设备宽度计算，单位 rpx",
+          "type": "number"
+        },
+        "rpxCalcMaxDeviceWidth": {
+          "default": "960",
+          "description": "rpx 计算所支持的最大设备宽度，单位 px",
+          "type": "number"
+        },
+        "titleImage": {
+          "description": "导航栏图片地址（替换当前文字标题），支付宝小程序内必须使用https的图片链接地址",
+          "type": "string"
+        },
+        "titlePenetrate": {
+          "default": "NO",
+          "description": "导航栏点击穿透",
+          "type": "string"
+        },
+        "topWindow": {
+          "default": "true",
+          "description": "当存在 topWindow 时，默认是否显示 topWindow",
+          "type": "boolean"
+        },
+        "transparentTitle": {
+          "default": "none",
+          "description": "导航栏整体（前景、背景）透明设置。支持 always 一直透明 / auto 滑动自适应 / none 不透明",
+          "type": "string"
+        },
+        "usingComponents": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "引用小程序组件，参考 小程序组件",
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "H5": {
+      "properties": {
+        "backgroundColor": {
+          "$ref": "#/definitions/HEXColor",
+          "default": "#F7F7F7",
+          "description": "背景颜色，颜色值格式为\"#RRGGBB\"。"
+        },
+        "buttons": {
+          "description": "自定义按钮，参考 buttons",
+          "items": {},
+          "type": "array"
+        },
+        "searchInput": {
+          "description": "导航栏上的搜索框样式，详见：searchInput",
+          "type": "object"
+        },
+        "titleColor": {
+          "$ref": "#/definitions/HEXColor",
+          "default": "#000000",
+          "description": "标题文字颜色"
+        },
+        "titleSize": {
+          "description": "标题文字字体大小",
+          "type": "string"
+        },
+        "titleText": {
+          "description": "标题文字内容",
+          "type": "string"
+        },
+        "type": {
+          "default": "default",
+          "description": "导航栏样式。\"default\"-默认样式；\"transparent\"-透明渐变。",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "HEXColor": {
+      "type": "string"
+    },
+    "IconFont": {
+      "additionalProperties": false,
+      "properties": {
+        "color": {
+          "description": "字体图标颜色",
+          "type": "string"
+        },
+        "fontSize": {
+          "description": "字体图标字号(px)",
+          "type": "string"
+        },
+        "selectedColor": {
+          "description": "字体图标选中颜色",
+          "type": "string"
+        },
+        "selectedText": {
+          "description": "选中后字库 Unicode 码",
+          "type": "string"
+        },
+        "text": {
+          "description": "字库 Unicode 码",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "MidButton": {
+      "additionalProperties": false,
+      "properties": {
+        "backgroundImage": {
+          "description": "中间按钮的背景图片路径",
+          "type": "string"
+        },
+        "height": {
+          "default": "50px",
+          "description": "中间按钮的高度，可以大于 tabBar 高度，达到中间凸起的效果",
+          "type": "string"
+        },
+        "iconPath": {
+          "description": "中间按钮的图片路径",
+          "type": "string"
+        },
+        "iconWidth": {
+          "default": "24px",
+          "description": "图片宽度（高度等比例缩放）",
+          "type": "string"
+        },
+        "iconfont": {
+          "$ref": "#/definitions/IconFont",
+          "description": "字体图标，优先级高于 iconPath"
+        },
+        "text": {
+          "description": "中间按钮的文字",
+          "type": "string"
+        },
+        "width": {
+          "default": "80px",
+          "description": "中间按钮的宽度，tabBar 其它项为减去此宽度后平分，默认值为与其它项平分宽度",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "PageMetaDatum": {
+      "properties": {
+        "needLogin": {
+          "description": "当前页面是否需要登录才可以访问，此配置优先级高于 uniIdRouter 下的 needLogin",
+          "type": "boolean"
+        },
+        "path": {
+          "description": "配置页面路径",
+          "type": "string"
+        },
+        "style": {
+          "$ref": "#/definitions/GlobalStyle",
+          "description": "配置页面窗口表现，配置项参考下方 pageStyle"
+        },
+        "type": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "path"
+      ],
+      "type": "object"
+    },
+    "PagesConfig": {
+      "properties": {
+        "condition": {
+          "$ref": "#/definitions/Condition",
+          "description": "启动模式配置"
+        },
+        "easycom": {
+          "$ref": "#/definitions/EasyCom",
+          "description": "组件自动引入规则"
+        },
+        "entryPagePath": {
+          "description": "默认启动首页，新增于 HBuilderX 3.7.0",
+          "type": "string"
+        },
+        "globalStyle": {
+          "$ref": "#/definitions/GlobalStyle",
+          "description": "设置默认页面的窗口表现"
+        },
+        "leftWindow": {
+          "$ref": "#/definitions/TheWindow",
+          "description": "大屏左侧窗口"
+        },
+        "pages": {
+          "description": "设置页面路径及窗口表现",
+          "items": {
+            "$ref": "#/definitions/PageMetaDatum"
+          },
+          "type": "array"
+        },
+        "preloadRule": {
+          "additionalProperties": {
+            "$ref": "#/definitions/PreloadRule"
+          },
+          "description": "分包预下载规则",
+          "type": "object"
+        },
+        "rightWindow": {
+          "$ref": "#/definitions/TheWindow",
+          "description": "大屏右侧窗口"
+        },
+        "subPackages": {
+          "description": "分包加载配置",
+          "items": {
+            "$ref": "#/definitions/SubPackage"
+          },
+          "type": "array"
+        },
+        "tabBar": {
+          "$ref": "#/definitions/TabBar",
+          "description": "设置底部 tab 的表现"
+        },
+        "topWindow": {
+          "$ref": "#/definitions/TheWindow",
+          "description": "大屏顶部窗口"
+        },
+        "uniIdRouter": {
+          "$ref": "#/definitions/UniIdRouter",
+          "description": "自动跳转相关配置，新增于 HBuilderX 3.5.0"
+        },
+        "workers": {
+          "description": "`Worker` 代码放置的目录"
+        }
+      },
+      "type": "object"
+    },
+    "PreloadRule": {
+      "additionalProperties": false,
+      "properties": {
+        "network": {
+          "default": "wifi",
+          "description": "在指定网络下预下载，可选值为：all（不限网络）、wifi（仅wifi下预下载）",
+          "type": "string"
+        },
+        "packages": {
+          "description": "进入页面后预下载分包的 root 或 name。__APP__ 表示主包。",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "RGBAColor": {
+      "type": "string"
+    },
+    "RGBColor": {
+      "type": "string"
+    },
+    "SubPackage": {
+      "additionalProperties": false,
+      "properties": {
+        "pages": {
+          "description": "子包由哪些页面组成，参数同 pages",
+          "items": {},
+          "type": "array"
+        },
+        "root": {
+          "description": "子包的根目录",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "TabBar": {
+      "properties": {
+        "backgroundColor": {
+          "$ref": "#/definitions/Color",
+          "description": "tab 的背景色"
+        },
+        "blurEffect": {
+          "default": "none",
+          "description": "iOS 高斯模糊效果，可选值 dark/extralight/light/none（参考?:使用说明）",
+          "type": "string"
+        },
+        "borderStyle": {
+          "default": "black",
+          "description": "tabbar 上边框的颜色，可选值 black/white，也支持其他颜色值",
+          "type": "string"
+        },
+        "color": {
+          "$ref": "#/definitions/Color",
+          "description": "tab 上的文字默认颜色"
+        },
+        "fontSize": {
+          "default": "10px",
+          "description": "文字默认大小",
+          "type": "string"
+        },
+        "height": {
+          "default": "50px",
+          "description": "tabBar 默认高度",
+          "type": "string"
+        },
+        "iconWidth": {
+          "default": "24px",
+          "description": "图标默认宽度（高度等比例缩放）",
+          "type": "string"
+        },
+        "iconfontSrc": {
+          "description": "list设置 iconfont 属性时，需要指定字体文件路径",
+          "type": "string"
+        },
+        "list": {
+          "description": "tab 的列表，详见 list 属性说明，最少2个、最多5个 tab",
+          "items": {
+            "$ref": "#/definitions/TabBarItem"
+          },
+          "type": "array"
+        },
+        "midButton": {
+          "$ref": "#/definitions/MidButton",
+          "description": "中间按钮 仅在 list 项为偶数时有效"
+        },
+        "position": {
+          "default": "bottom",
+          "description": "可选值 bottom、top",
+          "type": "string"
+        },
+        "selectedColor": {
+          "$ref": "#/definitions/Color",
+          "description": "tab 上的文字选中时的颜色"
+        },
+        "spacing": {
+          "default": "3px",
+          "description": "图标和文字的间距",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "TabBarItem": {
+      "properties": {
+        "iconPath": {
+          "description": "图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px， 当 position 为 top 时，此参数无效，不支持网络图片，不支持字体图标",
+          "type": "string"
+        },
+        "iconfont": {
+          "$ref": "#/definitions/IconFont",
+          "description": "字体图标，优先级高于 iconPath"
+        },
+        "pagePath": {
+          "description": "页面路径，必须在 pages 中先定义",
+          "type": "string"
+        },
+        "selectedIconPath": {
+          "description": "选中时的图片路径，icon 大小限制为40kb，建议尺寸为 81px * 81px ，当 position 为 top 时，此参数无效",
+          "type": "string"
+        },
+        "text": {
+          "description": "tab 上按钮文字，在 App 和 H5 平台为非必填。例如中间可放一个没有文字的+号图标",
+          "type": "string"
+        },
+        "visible": {
+          "description": "该项是否显示，默认显示",
+          "type": "boolean"
+        }
+      },
+      "type": "object"
+    },
+    "TheWindow": {
+      "additionalProperties": false,
+      "properties": {
+        "matchMedia": {
+          "additionalProperties": false,
+          "description": "配置显示该窗口的规则，配置项参考下方 matchMedia",
+          "properties": {
+            "minWidth": {
+              "default": "768",
+              "description": "当设备可见区域宽度 >= minWidth 时，显示该 window",
+              "type": "number"
+            }
+          },
+          "type": "object"
+        },
+        "path": {
+          "description": "配置页面路径",
+          "type": "string"
+        },
+        "style": {
+          "$ref": "#/definitions/GlobalStyle",
+          "description": "配置页面窗口表现，配置项参考下方 pageStyle"
+        }
+      },
+      "required": [
+        "path"
+      ],
+      "type": "object"
+    },
+    "ThemeColor": {
+      "type": "string"
+    },
+    "UniIdRouter": {
+      "additionalProperties": false,
+      "properties": {
+        "loginPage": {
+          "description": "登录页面路径",
+          "type": "string"
+        },
+        "needLogin": {
+          "description": "需要登录才可以访问的页面列表，可以使用正则语法",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "resToLogin": {
+          "default": true,
+          "description": "是否自动解析云对象及 clientDB 的错误码，如果是客户端 token 不正确或 token 过期则自动跳转配置的登录页面",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "loginPage",
+        "needLogin"
+      ],
+      "type": "object"
+    }
+  }
+}