@dtwo/schema 3.0.0-rc.14 → 3.1.0-0

package/dist/index.mjs

@@ -7,6 +7,15 @@ import createResolver from 'postcss-import-resolver';
 import { withoutLeadingSlash } from 'ufo';
 
 const adhoc = defineUntypedSchema({
+  /**
+   * Configure Dtwo component auto-registration.
+   *
+   * Any components in the directories configured here can be used throughout your
+   * pages, layouts (and other components) without needing to explicitly import them.
+   *
+   * @see https://dtwojs.web.app/docs/guide/directory-structure/components
+   * @type {boolean | typeof import('../src/types/components').ComponentsOptions | typeof import('../src/types/components').ComponentsOptions['dirs']}
+   */
   components: {
     $resolve: (val) => {
       if (Array.isArray(val)) {
@@ -18,28 +27,119 @@ const adhoc = defineUntypedSchema({
       return val;
     }
   },
+  /**
+   * Configure how Dtwo auto-imports composables into your application.
+   *
+   * @see [Dtwo 3 documentation](https://dtwojs.web.app/docs/guide/directory-structure/composables)
+   * @type {typeof import('../src/types/imports').ImportsOptions}
+   */
   imports: {
     global: false,
+    /**
+     * An array of custom directories that will be auto-imported.
+     * Note that this option will not override the default directories (~/composables, ~/utils).
+     * @example
+     * ```js
+     * imports: {
+     *   // Auto-import crabs stores defined in `~/stores`
+     *   dirs: ['stores']
+     * }
+     * ```
+     */
     dirs: []
   },
+  /**
+   * Whether to use the kdu-router integration in Dtwo 3. If you do not provide a value it will be
+   * enabled if you have a `pages/` directory in your source folder.
+   *
+   * @type {boolean}
+   */
   pages: void 0,
+  /**
+   * Manually disable dtwo telemetry.
+   *
+   * @type {boolean}
+  */
   telemetry: void 0
 });
 
 const app = defineUntypedSchema({
+  /**
+   * Kdu.js config
+   */
   kdu: {
+    /**
+     * Options for the Kdu compiler that will be passed at build time.
+     * @see [documentation](https://kdu-js.web.app/api/application.html#app-config-compileroptions)
+     * @type {typeof import('@kdujs/compiler-core').CompilerOptions}
+     */
     compilerOptions: {}
   },
+  /**
+   * Dtwo App configuration.
+   */
   app: {
+    /**
+     * The base path of your Dtwo application.
+     *
+     * This can be set at runtime by setting the DTWO_APP_BASE_URL environment variable.
+     * @example
+     * ```bash
+     * DTWO_APP_BASE_URL=/prefix/ node .output/server/index.mjs
+     * ```
+     */
     baseURL: {
       $resolve: async (val) => val || process.env.DTWO_APP_BASE_URL || "/"
     },
+    /** The folder name for the built site assets, relative to `baseURL` (or `cdnURL` if set). This is set at build time and should not be customized at runtime. */
     buildAssetsDir: {
       $resolve: async (val) => val || process.env.DTWO_APP_BUILD_ASSETS_DIR || "/_dtwo/"
     },
+    /**
+     * An absolute URL to serve the public folder from (production-only).
+     *
+     * This can be set to a different value at runtime by setting the `DTWO_APP_CDN_URL` environment variable.
+     * @example
+     * ```bash
+     * DTWO_APP_CDN_URL=https://mycdn.org/ node .output/server/index.mjs
+     * ```
+     */
     cdnURL: {
       $resolve: async (val, get) => await get("dev") ? "" : (process.env.DTWO_APP_CDN_URL ?? val) || ""
     },
+    /**
+     * Set default configuration for `<head>` on every page.
+     *
+     * @example
+     * ```js
+     * app: {
+     *   head: {
+     *     meta: [
+     *       // <meta name="viewport" content="width=device-width, initial-scale=1">
+     *       { name: 'viewport', content: 'width=device-width, initial-scale=1' }
+     *     ],
+     *     script: [
+     *       // <script src="https://myawesome-lib.js"><\/script>
+     *       { src: 'https://awesome-lib.js' }
+     *     ],
+     *     link: [
+     *       // <link rel="stylesheet" href="https://myawesome-lib.css">
+     *       { rel: 'stylesheet', href: 'https://awesome-lib.css' }
+     *     ],
+     *     // please note that this is an area that is likely to change
+     *     style: [
+     *       // <style type="text/css">:root { color: red }</style>
+     *       { children: ':root { color: red }', type: 'text/css' }
+     *     ],
+     *     noscript: [
+     *       // <noscript>JavaScript is required</noscript>
+     *       { children: 'JavaScript is required' }
+     *     ]
+     *   }
+     * }
+     * ```
+     * @type {typeof import('../src/types/config').DtwoAppConfig['head']}
+     */
     head: {
       $resolve: async (val, get) => {
         const resolved = defu(val, await get("meta"), {
@@ -63,19 +163,107 @@ const app = defineUntypedSchema({
         return resolved;
       }
     },
+    /**
+     * Default values for layout transitions.
+     *
+     * This can be overridden with `definePageMeta` on an individual page.
+     * Only JSON-serializable values are allowed.
+     *
+     * @see https://kdu-js.web.app/api/built-in-components.html#transition
+     * @type {typeof import('../src/types/config').DtwoAppConfig['layoutTransition']}
+     */
     layoutTransition: false,
+    /**
+     * Default values for page transitions.
+     *
+     * This can be overridden with `definePageMeta` on an individual page.
+     * Only JSON-serializable values are allowed.
+     *
+     * @see https://kdu-js.web.app/api/built-in-components.html#transition
+     * @type {typeof import('../src/types/config').DtwoAppConfig['pageTransition']}
+     */
     pageTransition: false,
+    /**
+     * Default values for KeepAlive configuration between pages.
+     *
+     * This can be overridden with `definePageMeta` on an individual page.
+     * Only JSON-serializable values are allowed.
+     *
+     * @see https://kdu-js.web.app/api/built-in-components.html#keepalive
+     * @type {typeof import('../src/types/config').DtwoAppConfig['keepalive']}
+     */
     keepalive: false,
+    /**
+     * Customize Dtwo root element id.
+     */
     rootId: "__dtwo",
+    /**
+     * Customize Dtwo root element tag.
+     *
+     */
     rootTag: "div"
   },
+  /**
+   * An array of dtwo app plugins.
+   *
+   * 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.
+   *
+   * It can also be an object with `src` and `mode` keys.
+   *
+   * @note Plugins are also auto-registered from the `~/plugins` directory
+   * and these plugins do not need to be listed in `dtwo.config` unless you
+   * need to customize their order. All plugins are deduplicated by their src path.
+   *
+   * @see https://dtwojs.web.app/docs/guide/directory-structure/plugins
+   *
+   * @example
+   * ```js
+   * plugins: [
+   *   '~/plugins/foo.client.js', // only in client side
+   *   '~/plugins/bar.server.js', // only in server side
+   *   '~/plugins/baz.js', // both client & server
+   *   { src: '~/plugins/both-sides.js' },
+   *   { src: '~/plugins/client-only.js', mode: 'client' }, // only on client side
+   *   { src: '~/plugins/server-only.js', mode: 'server' } // only on server side
+   * ]
+   * ```
+   * @type {(typeof import('../src/types/dtwo').DtwoPlugin | string)[]}
+   */
   plugins: [],
+  /**
+   * You can define the CSS files/modules/libraries you want to set globally
+   * (included in every page).
+   *
+   * Dtwo will automatically guess the file type by its extension and use the
+   * appropriate pre-processor. You will still need to install the required
+   * loader if you need to use them.
+   *
+   * @example
+   * ```js
+   * css: [
+   *   // Load a Node.js module directly (here it's a Sass file).
+   *   'bulma',
+   *   // CSS file in the project
+   *   '@/assets/css/main.css',
+   *   // SCSS file in the project
+   *   '@/assets/css/main.scss'
+   * ]
+   * ```
+   * @type {string[]}
+   */
   css: {
     $resolve: (val) => (val ?? []).map((c) => c.src || c)
   }
 });
 
 const build = defineUntypedSchema({
+  /**
+   * The builder to use for bundling the Kdu part of your application.
+   *
+   * @type {'wite' | 'webpack' | { bundle: (dtwo: typeof import('../src/types/dtwo').Dtwo) => Promise<void> }}
+   */
   builder: {
     $resolve: async (val, get) => {
       if (typeof val === "object") {
@@ -88,6 +276,11 @@ const build = defineUntypedSchema({
       return map[val] || val || (await get("wite") === false ? map.webpack : map.wite);
     }
   },
+  /**
+   * Whether to generate sourcemaps.
+   *
+   * @type {boolean | { server?: boolean, client?: boolean }}
+   */
   sourcemap: {
     $resolve: async (val, get) => {
       if (typeof val === "boolean") {
@@ -99,11 +292,61 @@ const build = defineUntypedSchema({
       });
     }
   },
+  /**
+   * Shared build configuration.
+   */
   build: {
+    /**
+     * If you want to transpile specific dependencies with Babel, you can add them here.
+     * Each item in transpile can be a package name, a function, a string or regex object matching the
+     * dependency's file name.
+     *
+     * You can also use a function to conditionally transpile. The function will receive an object ({ isDev, isServer, isClient, isModern, isLegacy }).
+     *
+     * @example
+     * ```js
+      transpile: [({ isLegacy }) => isLegacy && 'ky']
+     * ```
+     * @type {Array<string | RegExp | ((ctx: { isClient?: boolean; isServer?: boolean; isDev: boolean }) => string | RegExp | false)>}
+     */
     transpile: {
       $resolve: (val) => [].concat(val).filter(Boolean)
     },
+    /**
+     * You can provide your own templates which will be rendered based
+     * on Dtwo configuration. This feature is specially useful for using with modules.
+     *
+     * Templates are rendered using [`lodash.template`](https://lodash.com/docs/4.17.15#template).
+     *
+     * @example
+     * ```js
+     * templates: [
+     *   {
+     *     src: '~/modules/support/plugin.js', // `src` can be absolute or relative
+     *     dst: 'support.js', // `dst` is relative to project `.dtwo` dir
+     *     options: {
+     *       // Options are provided to template as `options` key
+     *       live_chat: false
+     *     }
+     *   }
+     * ]
+     * ```
+     */
     templates: [],
+    /**
+    * Dtwo uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
+    *
+    * Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for wite](https://github.com/btd/rollup-plugin-visualizer#options).
+    *
+    * @example
+    * ```js
+    * analyze: {
+    *   analyzerMode: 'static'
+    * }
+    * ```
+    * @type {boolean | typeof import('webpack-bundle-analyzer').BundleAnalyzerPlugin.Options | typeof import('rollup-plugin-visualizer').PluginVisualizerOptions}
+    *
+    */
     analyze: {
       $resolve: async (val, get) => {
         if (val !== true) {
@@ -121,23 +364,124 @@ const build = defineUntypedSchema({
 });
 
 const common = defineUntypedSchema({
+  /**
+   * Extend project from multiple local or remote sources.
+   *
+   * Value should be either a string or array of strings pointing to source directories or config path relative to current config.
+   *
+   * You can use `github:`, `gitlab:`, `bitbucket:` or `https://` to extend from a remote git repository.
+   *
+   * @type {string|string[]}
+   *
+   */
   extends: null,
+  /**
+   * Extend project from a local or remote source.
+   *
+   * Value should be a string pointing to source directory or config path relative to current config.
+   *
+   * You can use `github:`, `gitlab:`, `bitbucket:` or `https://` to extend from a remote git repository.
+   *
+   * @type {string}
+   *
+   */
   theme: null,
+  /**
+   * Define the root directory of your application.
+   *
+   * This property can be overwritten (for example, running `dtwo ./my-app/`
+   * will set the `rootDir` to the absolute path of `./my-app/` from the
+   * current/working directory.
+   *
+   * It is normally not needed to configure this option.
+   */
   rootDir: {
     $resolve: (val) => typeof val === "string" ? resolve(val) : process.cwd()
   },
+  /**
+   * Define the workspace directory of your application.
+   *
+   * Often this is used when in a monorepo setup. Dtwo will attempt to detect
+   * your workspace directory automatically, but you can override it here.
+   *
+   * It is normally not needed to configure this option.
+   */
   workspaceDir: {
     $resolve: async (val, get) => val ? resolve(await get("rootDir"), val) : await findWorkspaceDir(await get("rootDir")).catch(() => get("rootDir"))
   },
+  /**
+   * Define the source directory of your Dtwo application.
+   *
+   * If a relative path is specified, it will be relative to the `rootDir`.
+   *
+   * @example
+   * ```js
+   * export default {
+   *   srcDir: 'src/'
+   * }
+   * ```
+   * This would work with the following folder structure:
+   * ```bash
+   * -| app/
+   * ---| node_modules/
+   * ---| dtwo.config.js
+   * ---| package.json
+   * ---| src/
+   * ------| assets/
+   * ------| components/
+   * ------| layouts/
+   * ------| middleware/
+   * ------| pages/
+   * ------| plugins/
+   * ------| static/
+   * ------| store/
+   * ------| server/
+   * ```
+   */
   srcDir: {
     $resolve: async (val, get) => resolve(await get("rootDir"), val || ".")
   },
+  /**
+   * Define the server directory of your Dtwo application, where Hole
+   * routes, middleware and plugins are kept.
+   *
+   * If a relative path is specified, it will be relative to your `rootDir`.
+   *
+   */
   serverDir: {
     $resolve: async (val, get) => resolve(await get("rootDir"), val || resolve(await get("srcDir"), "server"))
   },
+  /**
+   * Define the directory where your built Dtwo files will be placed.
+   *
+   * Many tools assume that `.dtwo` is a hidden directory (because it starts
+   * with a `.`). If that is a problem, you can use this option to prevent that.
+   *
+   * @example
+   * ```js
+   * export default {
+   *   buildDir: 'dtwo-build'
+   * }
+   * ```
+   */
   buildDir: {
     $resolve: async (val, get) => resolve(await get("rootDir"), val || ".dtwo")
   },
+  /**
+  * Used to set the modules directories for path resolving (for example, webpack's
+  * `resolveLoading`, `nodeExternals` and `postcss`).
+  *
+  * The configuration path is relative to `options.rootDir` (default is current working directory).
+  *
+  * Setting this field may be necessary if your project is organized as a yarn workspace-styled mono-repository.
+  *
+  * @example
+  * ```js
+  * export default {
+  *   modulesDir: ['../../node_modules']
+  * }
+  * ```
+  */
   modulesDir: {
     $default: ["node_modules"],
     $resolve: async (val, get) => [
@@ -145,21 +489,91 @@ const common = defineUntypedSchema({
       resolve(process.cwd(), "node_modules")
     ]
   },
+  /**
+   * Whether Dtwo is running in development mode.
+   *
+   * Normally, you should not need to set this.
+   */
   dev: Boolean(isDevelopment),
+  /**
+   * Whether your app is being unit tested.
+   */
   test: Boolean(isDevelopment),
+  /**
+   * Set to `true` to enable debug mode.
+   *
+   * At the moment, it prints out hook names and timings on the server, and
+   * logs hook arguments as well in the browser.
+   *
+   */
   debug: {
     $resolve: async (val, get) => val ?? isDebug
   },
+  /**
+   * Whether to enable rendering of HTML - either dynamically (in server mode) or at generate time.
+   * If set to `false` and combined with `static` target, generated pages will simply display
+   * a loading screen with no content.
+   */
   ssr: {
     $resolve: (val) => val ?? true
   },
+  /**
+   * Modules are Dtwo extensions which can extend its core functionality and add endless integrations.
+   *
+   * Each module is either a string (which can refer to a package, or be a path to a file), a
+   * tuple with the module as first string and the options as a second object, or an inline module function.
+   *
+   * Dtwo tries to resolve each item in the modules array using node require path
+   * (in `node_modules`) and then will be resolved from project `srcDir` if `~` alias is used.
+   *
+   * @note Modules are executed sequentially so the order is important.
+   *
+   * @example
+   * ```js
+   * modules: [
+   *   // Using package name
+   *   '@dtwojs/axios',
+   *   // Relative to your project srcDir
+   *   '~/modules/awesome.js',
+   *   // Providing options
+   *   ['@dtwojs/google-analytics', { ua: 'X1234567' }],
+   *   // Inline definition
+   *   function () {}
+   * ]
+   * ```
+   * @type {(typeof import('../src/types/module').DtwoModule | string | [typeof import('../src/types/module').DtwoModule | string, Record<string, any>])[]}
+   */
   modules: [],
+  /**
+   * Customize default directory structure used by Dtwo.
+   *
+   * It is better to stick with defaults unless needed.
+   */
   dir: {
+    /**
+     * The assets directory (aliased as `~assets` in your build).
+     */
     assets: "assets",
+    /**
+     * The layouts directory, each file of which will be auto-registered as a Dtwo layout.
+     */
     layouts: "layouts",
+    /**
+     * The middleware directory, each file of which will be auto-registered as a Dtwo middleware.
+     */
     middleware: "middleware",
+    /**
+     * The directory which will be processed to auto-generate your application page routes.
+     */
     pages: "pages",
+    /**
+     * The plugins directory, each file of which will be auto-registered as a Dtwo plugin.
+     */
     plugins: "plugins",
+    /**
+     * The directory containing your static files, which will be directly accessible via the Dtwo server
+     * and copied across into your `dist` folder when your app is generated.
+     */
     public: {
       $resolve: async (val, get) => val || await get("dir.static") || "public"
     },
@@ -168,9 +582,56 @@ const common = defineUntypedSchema({
       $resolve: async (val, get) => val || await get("dir.public") || "public"
     }
   },
+  /**
+   * The extensions that should be resolved by the Dtwo resolver.
+   */
   extensions: {
     $resolve: (val) => [".js", ".jsx", ".mjs", ".ts", ".tsx", ".kdu"].concat(val).filter(Boolean)
   },
+  /**
+   * You can improve your DX by defining additional aliases to access custom directories
+   * within your JavaScript and CSS.
+   *
+   * @note Within a webpack context (image sources, CSS - but not JavaScript) you _must_ access
+   * your alias by prefixing it with `~`.
+   *
+   * @note These aliases will be automatically added to the generated `.dtwo/tsconfig.json` so you can get full
+   * type support and path auto-complete. In case you need to extend options provided by `./.dtwo/tsconfig.json`
+   * further, make sure to add them here or within the `typescript.tsConfig` property in `dtwo.config`.
+   *
+   * @example
+   * ```js
+   * export default {
+   *   alias: {
+   *     'images': fileURLToPath(new URL('./assets/images', import.meta.url)),
+   *     'style': fileURLToPath(new URL('./assets/style', import.meta.url)),
+   *     'data': fileURLToPath(new URL('./assets/other/data', import.meta.url))
+   *   }
+   * }
+   * ```
+   *
+   * ```html
+   * <template>
+   *   <img src="~images/main-bg.jpg">
+   * </template>
+   *
+   * <script>
+   * import data from 'data/test.json'
+   * <\/script>
+   *
+   * <style>
+   * // Uncomment the below
+   * //@import '~style/variables.scss';
+   * //@import '~style/utils.scss';
+   * //@import '~style/base.scss';
+   * body {
+   *   background-image: url('~images/main-bg.jpg');
+   * }
+   * </style>
+   * ```
+   *
+   * @type {Record<string, string>}
+   */
   alias: {
     $resolve: async (val, get) => ({
       "~~": await get("rootDir"),
@@ -182,30 +643,122 @@ const common = defineUntypedSchema({
       ...val
     })
   },
+  /**
+   * Pass options directly to `node-ignore` (which is used by Dtwo to ignore files).
+   *
+   * @see [node-ignore](https://github.com/kaelzhang/node-ignore)
+   *
+   * @example
+   * ```js
+   * ignoreOptions: {
+   *   ignorecase: false
+   * }
+   * ```
+   */
   ignoreOptions: void 0,
+  /**
+   * Any file in `pages/`, `layouts/`, `middleware/` or `store/` will be ignored during
+   * building if its filename starts with the prefix specified by `ignorePrefix`.
+   */
   ignorePrefix: "-",
+  /**
+   * More customizable than `ignorePrefix`: all files matching glob patterns specified
+   * inside the `ignore` array will be ignored in building.
+   */
   ignore: {
     $resolve: async (val, get) => [
       "**/*.stories.{js,ts,jsx,tsx}",
+      // ignore storybook files
       "**/*.{spec,test}.{js,ts,jsx,tsx}",
+      // ignore tests
       "**/*.d.ts",
+      // ignore type declarations
       ".output",
       await get("ignorePrefix") && `**/${await get("ignorePrefix")}*.*`
     ].concat(val).filter(Boolean)
   },
+  /**
+   * The watchers property lets you overwrite watchers configuration in your `dtwo.config`.
+   */
   watchers: {
+    /** An array of event types, which, when received, will cause the watcher to restart. */
     rewatchOnRawEvents: void 0,
+    /**
+     * `watchOptions` to pass directly to webpack.
+     *
+     * @see [webpack@4 watch options](https://v4.webpack.js.org/configuration/watch/#watchoptions).
+     *  */
     webpack: {
       aggregateTimeout: 1e3
     },
+    /**
+     * Options to pass directly to `chokidar`.
+     *
+     * @see [chokidar](https://github.com/paulmillr/chokidar#api)
+     */
     chokidar: {
       ignoreInitial: true
     }
   },
+  /**
+   * Hooks are listeners to Dtwo events that are typically used in modules,
+   * but are also available in `dtwo.config`.
+   *
+   * Internally, hooks follow a naming pattern using colons (e.g., build:done).
+   *
+   * For ease of configuration, you can also structure them as an hierarchical
+   * object in `dtwo.config` (as below).
+   *
+   * @example
+   * ```js'node:fs'
+   * import fs from 'node:fs'
+   * import path from 'node:path'
+   * export default {
+   *   hooks: {
+   *     build: {
+   *       done(builder) {
+   *         const extraFilePath = path.join(
+   *           builder.dtwo.options.buildDir,
+   *           'extra-file'
+   *         )
+   *         fs.writeFileSync(extraFilePath, 'Something extra')
+   *       }
+   *     }
+   *   }
+   * }
+   * ```
+   * @type {typeof import('../src/types/hooks').DtwoHooks}
+   */
   hooks: null,
+  /**
+   * Runtime config allows passing dynamic config and environment variables to the Dtwo app context.
+   *
+   * The value of this object is accessible from server only using `useRuntimeConfig`.
+   *
+   * It mainly should hold _private_ configuration which is not exposed on the frontend.
+   * This could include a reference to your API secret tokens.
+   *
+   * Anything under `public` and `app` will be exposed to the frontend as well.
+   *
+   * Values are automatically replaced by matching env variables at runtime, e.g. setting an environment
+   * variable `DTWO_API_KEY=my-api-key DTWO_PUBLIC_BASE_URL=/foo/` would overwrite the two values in the example below.
+   *
+   * @example
+   * ```js
+   * export default {
+   *  runtimeConfig: {
+   *     apiKey: '' // Default to an empty string, automatically set at runtime using process.env.DTWO_API_KEY
+   *     public: {
+   *        baseURL: '' // Exposed to the frontend as well.
+   *     }
+   *   }
+   * }
+   * ```
+   * @type {typeof import('../src/types/config').RuntimeConfig}
+   */
   runtimeConfig: {
     $resolve: async (val, get) => defu(val, {
-      public: await get("publicRuntimeConfig"),
+      public: {},
       app: {
         baseURL: (await get("app")).baseURL,
         buildAssetsDir: (await get("app")).buildAssetsDir,
@@ -213,26 +766,78 @@ const common = defineUntypedSchema({
       }
     })
   },
-  appConfig: {}
+  /**
+   * Additional app configuration
+   *
+   * For programmatic usage and type support, you can directly provide app config with this option.
+   * It will be merged with `app.config` file as default value.
+   *
+   * @type {typeof import('../src/types/config').AppConfig}
+   */
+  appConfig: {},
+  $schema: {}
 });
 
 const dev = defineUntypedSchema({
   devServer: {
+    /**
+     * Whether to enable HTTPS.
+     *
+     * @example
+     * ```
+     * import { fileURLToPath } from 'node:url'
+     * export default {
+     *   server: {
+     *     https: {
+     *       key: fs.readFileSync(fileURLToPath(new URL('./server.key', import.meta.url))),
+     *       cert: fs.readFileSync(fileURLToPath(new URL('./server.crt', import.meta.url)))
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     *
+     * @type {false | { key: string; cert: string }}
+     *
+     */
     https: false,
+    /** Dev server listening port */
     port: process.env.DTWO_PORT || process.env.HOLE_PORT || process.env.PORT || 3e3,
+    /** Dev server listening host */
     host: process.env.DTWO_HOST || process.env.HOLE_HOST || process.env.HOST || "localhost",
+    /**
+     * Listening dev server url
+     */
     url: "http://localhost:3000"
   }
 });
 
 const experimental = defineUntypedSchema({
   experimental: {
+    /**
+     * Set to true to generate an async entry point for the Kdu bundle (for module federation support).
+     */
     asyncEntry: {
       $resolve: (val) => val ?? false
     },
+    /**
+     * Enable Kdu's reactivity transform
+     * @see https://kdu-js.web.app/guide/extras/reactivity-transform.html
+     */
     reactivityTransform: false,
+    /**
+     * Externalize `kdu`, `@kdujs/*` and `kdu-router` when building.
+     */
     externalKdu: true,
+    /**
+     * Tree shakes contents of client-only components from server bundle.
+     */
     treeshakeClientOnly: true,
+    /**
+     * Use wite-node for on-demand server chunk loading
+     *
+     * @deprecated use `wite.devBundler: 'wite-node'`
+     */
     witeNode: {
       $resolve: (val) => {
         val = process.env.EXPERIMENTAL_WITE_NODE ? true : val;
@@ -244,7 +849,18 @@ const experimental = defineUntypedSchema({
         return val ?? true;
       }
     },
+    /**
+     * Split server bundle into multiple chunks and dynamically import them.
+     */
     witeServerDynamicImports: true,
+    /**
+     * Inline styles when rendering HTML (currently wite only).
+     *
+     * You can also pass a function that receives the path of a Kdu component
+     * and returns a boolean indicating whether to inline the styles for that component.
+     *
+     * @type {boolean | ((id?: string) => boolean)}
+     */
     inlineSSRStyles: {
       async $resolve(val, get) {
         if (val === false || await get("dev") || await get("ssr") === false || await get("builder") === "@dtwo/webpack-builder") {
@@ -253,7 +869,13 @@ const experimental = defineUntypedSchema({
         return val ?? true;
       }
     },
+    /**
+     * Turn off rendering of Dtwo scripts and JS resource hints.
+     */
     noScripts: false,
+    /**
+     * When this option is enabled (by default) payload of pages generated with `dtwo generate` are extracted
+     */
     payloadExtraction: {
       async $resolve(enabled, get) {
         enabled = enabled ?? false;
@@ -263,35 +885,85 @@ const experimental = defineUntypedSchema({
         return enabled;
       }
     },
+    /** Enable cross-origin prefetch using the Speculation Rules API. */
     crossOriginPrefetch: false,
-    writeEarlyHints: false
+    /**
+     * Write early hints when using node server.
+     *
+     * @note nginx does not support 103 Early hints in the current version.
+     */
+    writeEarlyHints: false,
+    /**
+     * Experimental component islands support with <DtwoIsland> and .island.kdu files.
+     */
+    componentIslands: false,
+    /**
+     * Enable experimental config schema support
+     */
+    configSchema: false
   }
 });
 
 const generate = defineUntypedSchema({
   generate: {
+    /**
+     * The routes to generate.
+     *
+     * If you are using the crawler, this will be only the starting point for route generation.
+     * This is often necessary when using dynamic routes.
+     *
+     * It is preferred to use `hole.prerender.routes`.
+     *
+     * @example
+     * ```js
+     * routes: ['/users/1', '/users/2', '/users/3']
+     * ```
+     */
     routes: [],
+    /**
+     * This option is no longer used. Instead, use `hole.prerender.ignore`.
+     */
     exclude: []
   }
 });
 
 const internal = defineUntypedSchema({
+  /** @private */
   _majorVersion: 3,
+  /** @private */
   _legacyGenerate: false,
+  /** @private */
   _start: false,
+  /** @private */
   _build: false,
+  /** @private */
   _generate: false,
+  /** @private */
   _prepare: false,
+  /** @private */
   _cli: false,
+  /** @private */
   _requiredModules: {},
+  /** @private */
   _dtwoConfigFile: void 0,
+  /** @private */
   _dtwoConfigFiles: [],
+  /** @private */
   appDir: "",
+  /** @private */
   _installedModules: [],
+  /** @private */
   _modules: []
 });
 
 const hole = defineUntypedSchema({
+  /**
+   * Configuration for Hole.
+   *
+   * @see https://holepack.web.app/config/
+   *
+   * @type {typeof import('holepack')['HoleConfig']}
+   */
   hole: {
     routeRules: {
       $resolve: async (val, get) => ({
@@ -300,15 +972,62 @@ const hole = defineUntypedSchema({
       })
     }
   },
+  /**
+   * Global route options applied to matching server routes.
+   *
+   * @experimental This is an experimental feature and API may change in the future.
+   *
+   * @see https://holepack.web.app/config/#routes
+   *
+   * @type {typeof import('holepack')['HoleConfig']['routeRules']}
+   */
   routeRules: {},
+  /**
+   * Hole server handlers.
+   *
+   * 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.
+   *
+   * @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
+   * ```js
+   * serverHandlers: [
+   *   { route: '/path/foo/**:name', handler: '~/server/foohandler.ts' }
+   * ]
+   * ```
+   *
+   * @type {typeof import('holepack')['HoleEventHandler'][]}
+   */
   serverHandlers: [],
+  /**
+   * Hole development-only server handlers.
+   *
+   * @see https://holepack.web.app/guide/introduction/routing
+   *
+   * @type {typeof import('holepack')['HoleDevEventHandler'][]}
+   */
   devServerHandlers: []
 });
 
 const postcss = defineUntypedSchema({
   postcss: {
-    config: false,
+    /**
+     * Options for configuring PostCSS plugins.
+     *
+     * https://postcss.org/
+     * @type {Record<string, any>}
+     */
     plugins: {
+      /**
+       * https://github.com/postcss/postcss-import
+       */
       "postcss-import": {
         $resolve: async (val, get) => val !== false ? defu(val || {}, {
           resolve: createResolver({
@@ -321,11 +1040,18 @@ const postcss = defineUntypedSchema({
           })
         }) : val
       },
+      /**
+       * https://github.com/postcss/postcss-url
+       */
       "postcss-url": {},
+      /**
+       * https://github.com/postcss/autoprefixer
+       */
       autoprefixer: {},
       cssnano: {
         $resolve: async (val, get) => val ?? !(await get("dev") && {
           preset: ["default", {
+            // Keep quotes in font values to prevent from HEX conversion
             minifyFontValues: { removeQuotes: false }
           }]
         })
@@ -336,21 +1062,72 @@ const postcss = defineUntypedSchema({
 
 const router = defineUntypedSchema({
   router: {
+    /**
+     * Additional options passed to `kdu-router`.
+     *
+     * Note: Only JSON serializable options should be passed by dtwo config.
+     *
+     * For more control, you can use `app/router.options.ts` file.
+     *
+     * @see [documentation](https://kdujs-router.web.app/api/interfaces/routeroptions.html).
+     * @type {import('../src/types/router').RouterConfigSerializable}
+     *
+     */
     options: {}
   }
 });
 
 const typescript = defineUntypedSchema({
+  /**
+   * Configuration for Dtwo's TypeScript integration.
+   *
+   */
   typescript: {
+    /**
+     * TypeScript comes with certain checks to give you more safety and analysis of your program.
+     * Once you’ve converted your codebase to TypeScript, you can start enabling these checks for greater safety.
+     * [Read More](https://www.typescriptlang.org/docs/handbook/migrating-from-javascript.html#getting-stricter-checks)
+     */
     strict: true,
+    /**
+     * Include parent workspace in the Dtwo project. Mostly useful for themes and module authors.
+     */
     includeWorkspace: false,
+    /**
+     * Enable build-time type checking.
+     *
+     * 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.
+     *
+     * @see https://dtwojs.web.app/docs/guide/concepts/typescript
+     *
+     * @type {boolean | 'build'}
+     */
     typeCheck: false,
+    /**
+     * You can extend generated `.dtwo/tsconfig.json` using this option.
+     * @type {typeof import('pkg-types')['readPackageJSON']}
+     */
     tsConfig: {},
+    /**
+     * Generate a `*.kdu` shim.
+     *
+     * We recommend instead either enabling [**Take Over Mode**](https://kdu-js.web.app/guide/typescript/overview.html#kocan-takeover-mode) or adding
+     * TypeScript Kdu Plugin (Kocan)** 👉 [[Download](https://marketplace.visualstudio.com/items?itemName=Kdu-Code.vscode-typescript-kdu-plugin)].
+     */
     shim: true
   }
 });
 
 const wite = defineUntypedSchema({
+  /**
+   * Configuration that will be passed directly to Wite.
+   *
+   * See https://witejs.web.app/config for more information.
+   * Please note that not all wite options are supported in Dtwo.
+   *
+   * @type {typeof import('../src/types/config').WiteConfig}
+   */
   wite: {
     root: {
       $resolve: async (val, get) => val ?? await get("srcDir")
@@ -358,7 +1135,9 @@ const wite = defineUntypedSchema({
     mode: {
       $resolve: async (val, get) => val ?? (await get("dev") ? "development" : "production")
     },
-    logLevel: "warn",
+    logLevel: {
+      $resolve: async (val, get) => val ?? (await get("dev") ? "warn" : "info")
+    },
     define: {
       $resolve: async (val, get) => ({
         "process.dev": await get("dev"),
@@ -421,6 +1200,19 @@ const wite = defineUntypedSchema({
 
 const webpack = defineUntypedSchema({
   webpack: {
+    /**
+     * Dtwo uses `webpack-bundle-analyzer` to visualize your bundles and how to optimize them.
+     *
+     * Set to `true` to enable bundle analysis, or pass an object with options: [for webpack](https://github.com/webpack-contrib/webpack-bundle-analyzer#options-for-plugin) or [for wite](https://github.com/btd/rollup-plugin-visualizer#options).
+     *
+     * @example
+     * ```js
+     * analyze: {
+     *   analyzerMode: 'static'
+     * }
+     * ```
+     * @type {boolean | typeof import('webpack-bundle-analyzer').BundleAnalyzerPlugin.Options}
+     */
     analyze: {
       $resolve: async (val, get) => {
         if (val !== true) {
@@ -434,12 +1226,93 @@ const webpack = defineUntypedSchema({
         };
       }
     },
+    /**
+     * Enable the profiler in webpackbar.
+     *
+     * It is normally enabled by CLI argument `--profile`.
+     *
+     * @see [webpackbar](https://github.com/unjs/webpackbar#profile).
+     */
     profile: process.argv.includes("--profile"),
+    /**
+     * Enables Common CSS Extraction using
+     * [Kdu Server Renderer guidelines](https://kdujs-ssr.web.app/guide/css.html).
+     *
+     * Using [extract-css-chunks-webpack-plugin](https://github.com/faceyspacey/extract-css-chunks-webpack-plugin/) under the hood, your CSS will be extracted
+     * into separate files, usually one per component. This allows caching your CSS and
+     * JavaScript separately and is worth trying if you have a lot of global or shared CSS.
+     *
+     * @example
+     * ```js
+     * export default {
+     *   webpack: {
+     *     extractCSS: true,
+     *     // or
+     *     extractCSS: {
+     *       ignoreOrder: true
+     *     }
+     *   }
+     * }
+     * ```
+     *
+     * If you want to extract all your CSS to a single file, there is a workaround for this.
+     * However, note that it is not recommended to extract everything into a single file.
+     * Extracting into multiple CSS files is better for caching and preload isolation. It
+     * can also improve page performance by downloading and resolving only those resources
+     * that are needed.
+     *
+     * @example
+     * ```js
+     * export default {
+     *   webpack: {
+     *     extractCSS: true,
+     *     optimization: {
+     *       splitChunks: {
+     *         cacheGroups: {
+     *           styles: {
+     *             name: 'styles',
+     *             test: /\.(css|kdu)$/,
+     *             chunks: 'all',
+     *             enforce: true
+     *           }
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     * ```
+     * @type {boolean | typeof import('mini-css-extract-plugin').PluginOptions}
+     */
     extractCSS: true,
+    /**
+     * Enables CSS source map support (defaults to `true` in development).
+     */
     cssSourceMap: {
       $resolve: async (val, get) => val ?? await get("dev")
     },
+    /**
+     * The polyfill library to load to provide URL and URLSearchParams.
+     *
+     * Defaults to `'url'` ([see package](https://www.npmjs.com/package/url)).
+     */
     serverURLPolyfill: "url",
+    /**
+     * Customize bundle filenames.
+     *
+     * To understand a bit more about the use of manifests, take a look at [this webpack documentation](https://webpack.js.org/guides/code-splitting/).
+     *
+     * @note Be careful when using non-hashed based filenames in production
+     * as most browsers will cache the asset and not detect the changes on first load.
+     *
+     * This example changes fancy chunk names to numerical ids:
+     *
+     * @example
+     * ```js
+     * filenames: {
+     *   chunk: ({ isDev }) => (isDev ? '[name].js' : '[id].[contenthash].js')
+     * }
+     * ```
+     */
     filenames: {
       app: ({ isDev }) => isDev ? `[name].js` : `[contenthash:7].js`,
       chunk: ({ isDev }) => isDev ? `[name].js` : `[contenthash:7].js`,
@@ -448,6 +1321,9 @@ const webpack = defineUntypedSchema({
       font: ({ isDev }) => isDev ? "[path][name].[ext]" : "fonts/[name].[contenthash:7].[ext]",
       video: ({ isDev }) => isDev ? "[path][name].[ext]" : "videos/[name].[contenthash:7].[ext]"
     },
+    /**
+     * Customize the options of Dtwo's integrated webpack loaders.
+     */
     loaders: {
       $resolve: async (val, get) => {
         const styleLoaders = [
@@ -508,15 +1384,60 @@ const webpack = defineUntypedSchema({
       stylus: {},
       kduStyle: {}
     },
+    /**
+     * Add webpack plugins.
+     *
+     * @example
+     * ```js
+     * import webpack from 'webpack'
+     * import { version } from './package.json'
+     * // ...
+     * plugins: [
+     *   new webpack.DefinePlugin({
+     *     'process.VERSION': version
+     *   })
+     * ]
+     * ```
+     */
     plugins: [],
+    /**
+     * Terser plugin options.
+     *
+     * Set to false to disable this plugin, or pass an object of options.
+     *
+     * @see [terser-webpack-plugin documentation](https://github.com/webpack-contrib/terser-webpack-plugin).
+     *
+     * @note Enabling sourceMap will leave `//# sourceMappingURL` linking comment at
+     * the end of each output file if webpack `config.devtool` is set to `source-map`.
+     *
+     * @type {false | typeof import('terser-webpack-plugin').BasePluginOptions & typeof import('terser-webpack-plugin').DefinedDefaultMinimizerAndOptions<any>}
+     */
     terser: {},
+    /**
+     * Hard-replaces `typeof process`, `typeof window` and `typeof document` to tree-shake bundle.
+     */
     aggressiveCodeRemoval: false,
+    /**
+     * OptimizeCSSAssets plugin options.
+     *
+     * Defaults to true when `extractCSS` is enabled.
+     *
+     * @see [css-minimizer-webpack-plugin documentation](https://github.com/webpack-contrib/css-minimizer-webpack-plugin).
+     *
+     * @type {false | typeof import('css-minimizer-webpack-plugin').BasePluginOptions & typeof import('css-minimizer-webpack-plugin').DefinedDefaultMinimizerAndOptions<any>}
+     */
     optimizeCSS: {
       $resolve: async (val, get) => val ?? (await get("build.extractCSS") ? {} : false)
     },
+    /**
+     * Configure [webpack optimization](https://webpack.js.org/configuration/optimization/).
+     * @type {false | typeof import('webpack').Configuration['optimization']}
+     */
     optimization: {
       runtimeChunk: "single",
+      /** Set minimize to `false` to disable all minimizers. (It is disabled in development by default). */
       minimize: { $resolve: async (val, get) => val ?? !await get("dev") },
+      /** You can set minimizer to a customized array of plugins. */
       minimizer: void 0,
       splitChunks: {
         chunks: "all",
@@ -524,6 +1445,10 @@ const webpack = defineUntypedSchema({
         cacheGroups: {}
       }
     },
+    /**
+     * Customize PostCSS Loader.
+     * Same options as https://github.com/webpack-contrib/postcss-loader#options
+     */
     postcss: {
       execute: void 0,
       postcssOptions: {
@@ -538,11 +1463,26 @@ const webpack = defineUntypedSchema({
       implementation: void 0,
       order: ""
     },
+    /**
+     * See [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) for available options.
+     * @type {typeof import('webpack-dev-middleware').Options<typeof import('http').IncomingMessage, typeof import('http').ServerResponse>}
+     */
     devMiddleware: {
       stats: "none"
     },
+    /**
+     * See [webpack-hot-middleware](https://github.com/webpack-contrib/webpack-hot-middleware) for available options.
+     * @type {typeof import('webpack-hot-middleware').MiddlewareOptions & { client?: typeof import('webpack-hot-middleware').ClientOptions }}
+     */
     hotMiddleware: {},
+    /**
+     * Set to `false` to disable the overlay provided by [FriendlyErrorsWebpackPlugin](https://www.npmjs.com/package/@d2js/friendly-errors-webpack-plugin).
+     */
     friendlyErrors: true,
+    /**
+     * Filters to hide build warnings.
+     * @type {Array<(warn: typeof import('webpack').WebpackError) => boolean>}
+     */
     warningIgnoreFilters: []
   }
 });