@dtwo/schema 3.0.0 → 3.1.0

package/schema/config.schema.json

@@ -5,7 +5,7 @@
       "title": "Configure Dtwo component auto-registration.",
       "description": "Any components in the directories configured here can be used throughout your pages, layouts (and other components) without needing to explicitly import them.",
       "tags": [
-        "@default {{ dirs: [`~/components`] }}"
+        "@see https://dtwojs.web.app/docs/guide/directory-structure/components"
       ],
       "tsType": "boolean | typeof import('../src/types/components').ComponentsOptions | typeof import('../src/types/components').ComponentsOptions['dirs']",
       "markdownType": "boolean | SrcTypesComponentsComponentsOptions | SrcTypesComponentsComponentsOptions['dirs']",
@@ -24,18 +24,27 @@
     "imports": {
       "title": "Configure how Dtwo auto-imports composables into your application.",
       "description": "",
-      "tags": [],
+      "tags": [
+        "@see [Dtwo 3 documentation](https://dtwojs.web.app/docs/guide/directory-structure/composables)"
+      ],
       "tsType": "typeof import('../src/types/imports').ImportsOptions",
       "markdownType": "SrcTypesImportsImportsOptions",
       "id": "#imports",
       "properties": {
         "global": {
           "type": "boolean",
+          "id": "#imports/global",
           "default": false
         },
         "dirs": {
-          "type": "array",
+          "title": "An array of custom directories that will be auto-imported. Note that this option will not override the default directories (~/composables, ~/utils).",
+          "description": "",
+          "tags": [
+            "@example\n```js\nimports: {\n  // Auto-import crabs stores defined in `~/stores`\n  dirs: ['stores']\n}\n```"
+          ],
+          "id": "#imports/dirs",
           "default": [],
+          "type": "array",
           "items": {
             "type": "any"
           }
@@ -125,7 +134,7 @@
           "title": "Set default configuration for `<head>` on every page.",
           "description": "",
           "tags": [
-            "@example\n```js\napp: {\n  head: {\n    meta: [\n      // <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n      { name: 'viewport', content: 'width=device-width, initial-scale=1' }\n    ],\n    script: [\n      // <script src=\"https://myawesome-lib.js\"></script>\n      { src: 'https://awesome-lib.js' }\n    ],\n    link: [\n      // <link rel=\"stylesheet\" href=\"https://myawesome-lib.css\">\n      { rel: 'stylesheet', href: 'https://awesome-lib.css' }\n    ],\n    // please note that this is an area that is likely to change\n    style: [\n      // <style type=\"text/css\">:root { color: red }</style>\n      { children: ':root { color: red }', type: 'text/css' }\n    ],\n    noscript: [\n      // <noscript>Javascript is required</noscript>\n      { children: 'Javascript is required' }\n    ]\n  }\n}\n```"
+            "@example\n```js\napp: {\n  head: {\n    meta: [\n      // <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n      { name: 'viewport', content: 'width=device-width, initial-scale=1' }\n    ],\n    script: [\n      // <script src=\"https://myawesome-lib.js\"></script>\n      { src: 'https://awesome-lib.js' }\n    ],\n    link: [\n      // <link rel=\"stylesheet\" href=\"https://myawesome-lib.css\">\n      { rel: 'stylesheet', href: 'https://awesome-lib.css' }\n    ],\n    // please note that this is an area that is likely to change\n    style: [\n      // <style type=\"text/css\">:root { color: red }</style>\n      { children: ':root { color: red }', type: 'text/css' }\n    ],\n    noscript: [\n      // <noscript>JavaScript is required</noscript>\n      { children: 'JavaScript is required' }\n    ]\n  }\n}\n```"
           ],
           "tsType": "typeof import('../src/types/config').DtwoAppConfig['head']",
           "markdownType": "SrcTypesConfigDtwoAppConfig['head']",
@@ -231,6 +240,8 @@
       "title": "An array of dtwo app plugins.",
       "description": "Each plugin can be a string (which can be an absolute or relative path to a file). If it ends with `.client` or `.server` then it will be automatically loaded only in the appropriate context.\nIt can also be an object with `src` and `mode` keys.",
       "tags": [
+        "@note Plugins are also auto-registered from the `~/plugins` directory\nand these plugins do not need to be listed in `dtwo.config` unless you\nneed to customize their order. All plugins are deduplicated by their src path.",
+        "@see https://dtwojs.web.app/docs/guide/directory-structure/plugins",
         "@example\n```js\nplugins: [\n  '~/plugins/foo.client.js', // only in client side\n  '~/plugins/bar.server.js', // only in server side\n  '~/plugins/baz.js', // both client & server\n  { src: '~/plugins/both-sides.js' },\n  { src: '~/plugins/client-only.js', mode: 'client' }, // only on client side\n  { src: '~/plugins/server-only.js', mode: 'server' } // only on server side\n]\n```"
       ],
       "tsType": "(typeof import('../src/types/dtwo').DtwoPlugin | string)[]",
@@ -290,7 +301,7 @@
           "tags": [
             "@example\n```js\n      transpile: [({ isLegacy }) => isLegacy && 'ky']\n```"
           ],
-          "tsType": "Array<string | RegExp | Function>",
+          "tsType": "Array<string | RegExp | ((ctx: { isClient?: boolean; isServer?: boolean; isDev: boolean }) => string | RegExp | false)>",
           "id": "#build/transpile",
           "default": [],
           "type": "array",
@@ -406,9 +417,7 @@
       ],
       "type": "array",
       "items": {
-        "type": [
-          "string"
-        ]
+        "type": "string"
       }
     },
     "dev": {
@@ -546,9 +555,7 @@
       ],
       "type": "array",
       "items": {
-        "type": [
-          "string"
-        ]
+        "type": "string"
       }
     },
     "alias": {
@@ -605,9 +612,7 @@
       ],
       "type": "array",
       "items": {
-        "type": [
-          "string"
-        ]
+        "type": "string"
       }
     },
     "watchers": {
@@ -634,6 +639,7 @@
           "properties": {
             "aggregateTimeout": {
               "type": "number",
+              "id": "#watchers/webpack/aggregateTimeout",
               "default": 1000
             }
           },
@@ -652,6 +658,7 @@
           "properties": {
             "ignoreInitial": {
               "type": "boolean",
+              "id": "#watchers/chokidar/ignoreInitial",
               "default": true
             }
           },
@@ -857,6 +864,22 @@
           "id": "#experimental/writeEarlyHints",
           "default": false,
           "type": "boolean"
+        },
+        "componentIslands": {
+          "title": "Experimental component islands support with <DtwoIsland> and .island.kdu files.",
+          "description": "",
+          "tags": [],
+          "id": "#experimental/componentIslands",
+          "default": false,
+          "type": "boolean"
+        },
+        "configSchema": {
+          "title": "Enable experimental config schema support",
+          "description": "",
+          "tags": [],
+          "id": "#experimental/configSchema",
+          "default": false,
+          "type": "boolean"
         }
       },
       "default": {
@@ -870,7 +893,9 @@
         "noScripts": false,
         "payloadExtraction": false,
         "crossOriginPrefetch": false,
-        "writeEarlyHints": false
+        "writeEarlyHints": false,
+        "componentIslands": false,
+        "configSchema": false
       },
       "type": "object"
     },
@@ -879,13 +904,9 @@
       "properties": {
         "routes": {
           "title": "The routes to generate.",
-          "description": "If you are using the crawler, this will be only the starting point for route generation. This is often necessary when using dynamic routes.\nIt can be an array or a function.",
+          "description": "If you are using the crawler, this will be only the starting point for route generation. This is often necessary when using dynamic routes.\nIt is preferred to use `hole.prerender.routes`.",
           "tags": [
-            "@example\n```js\nroutes: ['/users/1', '/users/2', '/users/3']\n```",
-            "You can pass a function that returns a promise or a function that takes a callback. It should\nreturn an array of strings or objects with `route` and (optional) `payload` keys.",
-            "@example\n```js\nexport default {\n  generate: {\n    async routes() {\n      const res = await axios.get('https://my-api/users')\n      return res.data.map(user => ({ route: '/users/' + user.id, payload: user }))\n    }\n  }\n}\n```\nOr instead:\n```js\nexport default {\n  generate: {\n    routes(callback) {\n      axios\n        .get('https://my-api/users')\n        .then(res => {\n          const routes = res.data.map(user => '/users/' + user.id)\n          callback(null, routes)\n        })\n        .catch(callback)\n    }\n  }\n}\n```",
-            "If `routes()` returns a payload, it can be accessed from the Dtwo context.",
-            "@example\n```js\nexport default {\n  async useAsyncData ({ params, error, payload }) {\n    if (payload) return { user: payload }\n    else return { user: await backend.fetchUser(params.id) }\n  }\n}\n```"
+            "@example\n```js\nroutes: ['/users/1', '/users/2', '/users/3']\n```"
           ],
           "id": "#generate/routes",
           "default": [],
@@ -895,7 +916,7 @@
           }
         },
         "exclude": {
-          "title": "An array of string or regular expressions that will prevent generation of routes matching them. The routes will still be accessible when `fallback` is set.",
+          "title": "This option is no longer used. Instead, use `hole.prerender.ignore`.",
           "description": "",
           "tags": [],
           "id": "#generate/exclude",
@@ -1089,6 +1110,7 @@
       "title": "Hole server handlers.",
       "description": "Each handler accepts the following options: - handler: The path to the file defining the handler. - route: The route under which the handler is available. This follows the conventions of https://github.com/unjs/radix3. - method: The HTTP method of requests that should be handled. - middleware: Specifies whether it is a middleware handler. - lazy: Specifies whether to use lazy loading to import the handler.",
       "tags": [
+        "@see https://dtwojs.web.app/docs/guide/directory-structure/server",
         "@note Files from `server/api`, `server/middleware` and `server/routes` will be automatically registered by Dtwo.",
         "@example\n```js\nserverHandlers: [\n  { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' }\n]\n```"
       ],
@@ -1119,14 +1141,6 @@
     "postcss": {
       "id": "#postcss",
       "properties": {
-        "config": {
-          "title": "Path to postcss config file.",
-          "description": "",
-          "tags": [],
-          "id": "#postcss/config",
-          "default": false,
-          "type": "boolean"
-        },
         "plugins": {
           "title": "Options for configuring PostCSS plugins.",
           "description": "https://postcss.org/",
@@ -1174,7 +1188,6 @@
         }
       },
       "default": {
-        "config": false,
         "plugins": {
           "postcss-import": {},
           "postcss-url": {},
@@ -1230,7 +1243,9 @@
         "typeCheck": {
           "title": "Enable build-time type checking.",
           "description": "If set to true, this will type check in development. You can restrict this to build-time type checking by setting it to `build`. Requires to install `typescript` and `kdu-tsc` as dev dependencies.",
-          "tags": [],
+          "tags": [
+            "@see https://dtwojs.web.app/docs/guide/concepts/typescript"
+          ],
           "tsType": "boolean | 'build'",
           "id": "#typescript/typeCheck",
           "default": false,
@@ -1283,8 +1298,9 @@
           "type": "string"
         },
         "logLevel": {
-          "type": "string",
-          "default": "warn"
+          "id": "#wite/logLevel",
+          "default": "info",
+          "type": "string"
         },
         "define": {
           "id": "#wite/define",
@@ -1298,6 +1314,7 @@
           "properties": {
             "extensions": {
               "type": "array",
+              "id": "#wite/resolve/extensions",
               "default": [
                 ".mjs",
                 ".js",
@@ -1308,9 +1325,7 @@
                 ".kdu"
               ],
               "items": {
-                "type": [
-                  "string"
-                ]
+                "type": "string"
               }
             }
           },
@@ -1373,9 +1388,7 @@
               ],
               "type": "array",
               "items": {
-                "type": [
-                  "string"
-                ]
+                "type": "string"
               }
             }
           },
@@ -1391,14 +1404,17 @@
           "properties": {
             "jsxFactory": {
               "type": "string",
+              "id": "#wite/esbuild/jsxFactory",
               "default": "h"
             },
             "jsxFragment": {
               "type": "string",
+              "id": "#wite/esbuild/jsxFragment",
               "default": "Fragment"
             },
             "tsconfigRaw": {
               "type": "string",
+              "id": "#wite/esbuild/tsconfigRaw",
               "default": "{}"
             }
           },
@@ -1411,6 +1427,7 @@
         },
         "clearScreen": {
           "type": "boolean",
+          "id": "#wite/clearScreen",
           "default": false
         },
         "build": {
@@ -1423,6 +1440,7 @@
             },
             "emptyOutDir": {
               "type": "boolean",
+              "id": "#wite/build/emptyOutDir",
               "default": false
             }
           },
@@ -1450,9 +1468,7 @@
                   ],
                   "type": "array",
                   "items": {
-                    "type": [
-                      "string"
-                    ]
+                    "type": "string"
                   }
                 }
               },
@@ -1488,7 +1504,7 @@
         "base": "/",
         "root": "/<rootDir>",
         "mode": "production",
-        "logLevel": "warn",
+        "logLevel": "info",
         "define": {
           "process.dev": false
         },
@@ -1606,22 +1622,28 @@
           "id": "#webpack/filenames",
           "properties": {
             "app": {
-              "type": "function"
+              "type": "function",
+              "id": "#webpack/filenames/app"
             },
             "chunk": {
-              "type": "function"
+              "type": "function",
+              "id": "#webpack/filenames/chunk"
             },
             "css": {
-              "type": "function"
+              "type": "function",
+              "id": "#webpack/filenames/css"
             },
             "img": {
-              "type": "function"
+              "type": "function",
+              "id": "#webpack/filenames/img"
             },
             "font": {
-              "type": "function"
+              "type": "function",
+              "id": "#webpack/filenames/font"
             },
             "video": {
-              "type": "function"
+              "type": "function",
+              "id": "#webpack/filenames/video"
             }
           },
           "default": {},
@@ -1638,6 +1660,7 @@
               "properties": {
                 "esModule": {
                   "type": "boolean",
+                  "id": "#webpack/loaders/file/esModule",
                   "default": false
                 }
               },
@@ -1651,10 +1674,12 @@
               "properties": {
                 "esModule": {
                   "type": "boolean",
+                  "id": "#webpack/loaders/fontUrl/esModule",
                   "default": false
                 },
                 "limit": {
                   "type": "number",
+                  "id": "#webpack/loaders/fontUrl/limit",
                   "default": 1000
                 }
               },
@@ -1669,10 +1694,12 @@
               "properties": {
                 "esModule": {
                   "type": "boolean",
+                  "id": "#webpack/loaders/imgUrl/esModule",
                   "default": false
                 },
                 "limit": {
                   "type": "number",
+                  "id": "#webpack/loaders/imgUrl/limit",
                   "default": 1000
                 }
               },
@@ -1700,18 +1727,22 @@
                   "properties": {
                     "video": {
                       "type": "string",
+                      "id": "#webpack/loaders/kdu/transformAssetUrls/video",
                       "default": "src"
                     },
                     "source": {
                       "type": "string",
+                      "id": "#webpack/loaders/kdu/transformAssetUrls/source",
                       "default": "src"
                     },
                     "object": {
                       "type": "string",
+                      "id": "#webpack/loaders/kdu/transformAssetUrls/object",
                       "default": "src"
                     },
                     "embed": {
                       "type": "string",
+                      "id": "#webpack/loaders/kdu/transformAssetUrls/embed",
                       "default": "src"
                     }
                   },
@@ -1746,13 +1777,15 @@
               "properties": {
                 "importLoaders": {
                   "type": "number",
+                  "id": "#webpack/loaders/css/importLoaders",
                   "default": 0
                 },
                 "url": {
                   "id": "#webpack/loaders/css/url",
                   "properties": {
                     "filter": {
-                      "type": "function"
+                      "type": "function",
+                      "id": "#webpack/loaders/css/url/filter"
                     }
                   },
                   "default": {},
@@ -1760,6 +1793,7 @@
                 },
                 "esModule": {
                   "type": "boolean",
+                  "id": "#webpack/loaders/css/esModule",
                   "default": false
                 }
               },
@@ -1776,13 +1810,15 @@
               "properties": {
                 "importLoaders": {
                   "type": "number",
+                  "id": "#webpack/loaders/cssModules/importLoaders",
                   "default": 0
                 },
                 "url": {
                   "id": "#webpack/loaders/cssModules/url",
                   "properties": {
                     "filter": {
-                      "type": "function"
+                      "type": "function",
+                      "id": "#webpack/loaders/cssModules/url/filter"
                     }
                   },
                   "default": {},
@@ -1790,6 +1826,7 @@
                 },
                 "esModule": {
                   "type": "boolean",
+                  "id": "#webpack/loaders/cssModules/esModule",
                   "default": false
                 },
                 "modules": {
@@ -1797,6 +1834,7 @@
                   "properties": {
                     "localIdentName": {
                       "type": "string",
+                      "id": "#webpack/loaders/cssModules/modules/localIdentName",
                       "default": "[local]_[hash:base64:5]"
                     }
                   },
@@ -1832,6 +1870,7 @@
                   "properties": {
                     "indentedSyntax": {
                       "type": "boolean",
+                      "id": "#webpack/loaders/sass/sassOptions/indentedSyntax",
                       "default": true
                     }
                   },
@@ -1986,6 +2025,7 @@
           "properties": {
             "runtimeChunk": {
               "type": "string",
+              "id": "#webpack/optimization/runtimeChunk",
               "default": "single"
             },
             "minimize": {
@@ -2009,10 +2049,12 @@
               "properties": {
                 "chunks": {
                   "type": "string",
+                  "id": "#webpack/optimization/splitChunks/chunks",
                   "default": "all"
                 },
                 "automaticNameDelimiter": {
                   "type": "string",
+                  "id": "#webpack/optimization/splitChunks/automaticNameDelimiter",
                   "default": "/"
                 },
                 "cacheGroups": {
@@ -2047,14 +2089,16 @@
           "tags": [],
           "id": "#webpack/postcss",
           "properties": {
-            "execute": {},
+            "execute": {
+              "id": "#webpack/postcss/execute"
+            },
             "postcssOptions": {
               "id": "#webpack/postcss/postcssOptions",
               "properties": {
                 "config": {
                   "id": "#webpack/postcss/postcssOptions/config",
-                  "default": false,
-                  "type": "boolean"
+                  "default": {},
+                  "type": "any"
                 },
                 "plugins": {
                   "id": "#webpack/postcss/postcssOptions/plugins",
@@ -2068,7 +2112,7 @@
                 }
               },
               "default": {
-                "config": false,
+                "config": {},
                 "plugins": {
                   "postcss-import": {},
                   "postcss-url": {},
@@ -2078,16 +2122,21 @@
               },
               "type": "object"
             },
-            "sourceMap": {},
-            "implementation": {},
+            "sourceMap": {
+              "id": "#webpack/postcss/sourceMap"
+            },
+            "implementation": {
+              "id": "#webpack/postcss/implementation"
+            },
             "order": {
               "type": "string",
+              "id": "#webpack/postcss/order",
               "default": ""
             }
           },
           "default": {
             "postcssOptions": {
-              "config": false,
+              "config": {},
               "plugins": {
                 "postcss-import": {},
                 "postcss-url": {},
@@ -2109,6 +2158,7 @@
           "properties": {
             "stats": {
               "type": "string",
+              "id": "#webpack/devMiddleware/stats",
               "default": "none"
             }
           },
@@ -2229,7 +2279,7 @@
         },
         "postcss": {
           "postcssOptions": {
-            "config": false,
+            "config": {},
             "plugins": {
               "postcss-import": {},
               "postcss-url": {},
@@ -2389,7 +2439,9 @@
       "noScripts": false,
       "payloadExtraction": false,
       "crossOriginPrefetch": false,
-      "writeEarlyHints": false
+      "writeEarlyHints": false,
+      "componentIslands": false,
+      "configSchema": false
     },
     "generate": {
       "routes": [],
@@ -2415,7 +2467,6 @@
     "serverHandlers": [],
     "devServerHandlers": [],
     "postcss": {
-      "config": false,
       "plugins": {
         "postcss-import": {},
         "postcss-url": {},
@@ -2437,7 +2488,7 @@
       "base": "/",
       "root": "/<rootDir>",
       "mode": "production",
-      "logLevel": "warn",
+      "logLevel": "info",
       "define": {
         "process.dev": false
       },
@@ -2567,7 +2618,7 @@
       },
       "postcss": {
         "postcssOptions": {
-          "config": false,
+          "config": {},
           "plugins": {
             "postcss-import": {},
             "postcss-url": {},