update webuix docs

Author: DerGoogler

docs/en/guide/webuix/config.md

@@ -7,48 +7,10 @@ Location:
 - `/data/adb/modules/<ID>/webroot/config.json`
 - `/data/adb/modules/<ID>/webroot/config.mmrl.json`
 
-## Example Usage
+::: code-group
 
-```jsonc
-{
-  "require": {
-    /**
-      "packages" is available from following apps:
-      - MMRL version code 33633
-      - WebUI X Portable version code 29
-    */
-    "packages": [
-      {
-        "code": 33624,
-        "packageName": ["com.dergoogler.mmrl", "com.dergoogler.mmrl.debug"],
-        "supportText": "Update",
-        "supportLink": "https://github.com/MMRLApp/MMRL/releases"
-      },
-      {
-        "code": 26,
-        "packageName": "com.dergoogler.mmrl.wx",
-        "supportText": "Update",
-        "supportLink": "https://github.com/MMRLApp/WebUI-X-Portable/releases"
-      }
-    ],
-    /**
-      "version" is deprecated from following apps:
-      - MMRL version code 33633
-      - WebUI X Portable version code 29
-    */
-    "version": {
-      "required": 2,
-      "supportText": "Please update to the latest version.",
-      "supportLink": "https://support.example.com"
-    }
-  },
-  "permissions": ["webui.permission.PLUGIN_DEX_LOADER", "webui.permission.DSL_DEX_LOADING"],
-  "historyFallback": true,
-  "title": "My WebUI",
-  "icon": "icon.png",
-  "windowResize": true,
-  "backHandler": true,
-  "exitConfirm": true,
-  "historyFallbackFile": "fallback.html"
-}
-```
+<<< @/webui-x-types/config/Config.ts
+
+<<< @/webui-x-types/config/Require.ts
+
+:::

docs/webui-x-types/config/Config.ts

@@ -0,0 +1,70 @@
+import { Require } from "./Require";
+
+type BackInterceptor = "native" | "javascript" | boolean | null;
+
+export interface Config {
+  /**
+   * Configuration for required dependencies for the WebUI.
+   */
+  require: Require;
+
+  /**
+   * List of permissions required by the Web UI.
+   */
+  permissions: Array<string>;
+
+  /**
+   * Whether the WebUI should fallback to the `historyFallbackFile` if a route is not found.
+   * @default false
+   */
+  historyFallback: boolean;
+
+  /**
+   * The title of the WebUI window. If null, the default title of the underlying platform will be used.
+   */
+  title: string | null;
+
+  /**
+   * The path to the icon of the WebUI. If null, the default icon of the underlying platform will be used.
+   */
+  icon: string | null;
+
+  /**
+   * Whether the WebUI window should be resizable.
+   * @default true
+   */
+  windowResize: boolean;
+
+  /**
+   * @deprecated
+   * Use `backInterceptor` instead.
+   * Whether the WebUI should handle the back button/gesture events.
+   * @default true
+   */
+  backHandler: boolean | null;
+
+  /**
+   * The interceptor to use for the back button/gesture events. If set to `null` or `false`, the default behavior of the underlying platform will be used.
+   * @default null
+   */
+  backInterceptor: BackInterceptor;
+
+  /**
+   * Whether the WebUI should support pull-to-refresh functionality.
+   * This is typically used in mobile web applications to allow users to refresh the content by pulling down.
+   * @default true
+   */
+  pullToRefresh: boolean;
+
+  /**
+   * Whether the WebUI should show a confirmation dialog when the user tries to exit.
+   * @default true
+   */
+  exitConfirm: boolean;
+
+  /**
+   * The file to use as a fallback when `historyFallback` is enabled.
+   * @default "index.html"
+   */
+  historyFallbackFile: string;
+}

docs/webui-x-types/config/Require.ts

@@ -0,0 +1,24 @@
+interface Package {
+  code: number;
+  packageName: string | Array<string>;
+  supportText: string | null;
+  supportLink: string | null;
+}
+
+/**
+ * @deprecated
+ */
+interface Version {
+  required: number;
+  supportText: string | null;
+  supportLink: string | null;
+}
+
+export interface Require {
+  packages: Array<Package>;
+  /**
+   * @deprecated
+   * Use `packages` instead.
+   */
+  version: Version;
+}