@dtwo/schema 3.1.2 → 3.2.0

package/dist/index.d.ts

@@ -460,71 +460,286 @@ interface ImportPresetWithDeprecation extends InlinePreset {
 interface GenerateAppOptions {
     filter?: (template: ResolvedDtwoTemplate<any>) => boolean;
 }
+/**
+ * The listeners to Dtwo build time events
+ */
 interface DtwoHooks {
+    /**
+     * Allows extending compatibility checks.
+     * @param compatibility Compatibility object
+     * @param issues Issues to be mapped
+     * @returns Promise
+     */
     'kit:compatibility': (compatibility: DtwoCompatibility, issues: DtwoCompatibilityIssues) => HookResult;
+    /**
+     * Called after Dtwo initialization, when the Dtwo instance is ready to work.
+     * @param dtwo The configured Dtwo object
+     * @returns Promise
+     */
     'ready': (dtwo: Dtwo) => HookResult;
+    /**
+     * Called when Dtwo instance is gracefully closing.
+     * @param dtwo The configured Dtwo object
+     * @returns Promise
+     */
     'close': (dtwo: Dtwo) => HookResult;
+    /**
+     * Called during Dtwo initialization, before installing user modules.
+     * @returns Promise
+     */
     'modules:before': () => HookResult;
+    /**
+     * Called during Dtwo initialization, after installing user modules.
+     * @returns Promise
+     */
     'modules:done': () => HookResult;
+    /**
+     * Called after resolving the `app` instance.
+     * @param app The resolved `DtwoApp` object
+     * @returns Promise
+     */
     'app:resolve': (app: DtwoApp) => HookResult;
+    /**
+     * Called during `DtwoApp` generation, to allow customizing, modifying or adding new files to the build directory (either virtually or to written to `.dtwo`).
+     * @param app The configured `DtwoApp` object
+     * @returns Promise
+     */
     'app:templates': (app: DtwoApp) => HookResult;
+    /**
+     * Called after templates are compiled into the [virtual file system](https://dtwojs.web.app/docs/guide/directory-structure/dtwo#virtual-file-system) (vfs).
+     * @param app The configured `DtwoApp` object
+     * @returns Promise
+     */
     'app:templatesGenerated': (app: DtwoApp) => HookResult;
+    /**
+     * Called before Dtwo bundle builder.
+     * @returns Promise
+     */
     'build:before': () => HookResult;
+    /**
+     * Called after Dtwo bundle builder is complete.
+     * @returns Promise
+     */
     'build:done': () => HookResult;
+    /**
+     * Called during the manifest build by Wite and Webpack. This allows customizing the manifest that Hole will use to render `<script>` and `<link>` tags in the final HTML.
+     * @param manifest The manifest object to build
+     * @returns Promise
+     */
     'build:manifest': (manifest: Manifest) => HookResult;
+    /**
+     * Called before generating the app.
+     * @param options GenerateAppOptions object
+     * @returns Promise
+     */
     'builder:generateApp': (options?: GenerateAppOptions) => HookResult;
+    /**
+     * Called at build time in development when the watcher spots a change to a file or directory in the project.
+     * @param event "add" | "addDir" | "change" | "unlink" | "unlinkDir"
+     * @param path the path to the watched file
+     * @returns Promise
+     */
     'builder:watch': (event: WatchEvent, path: string) => HookResult;
+    /**
+     * Called after pages routes are resolved.
+     * @param pages Array containing resolved pages
+     * @returns Promise
+     */
     'pages:extend': (pages: DtwoPage[]) => HookResult;
+    /**
+     * Called when the dev middleware is being registered on the Hole dev server.
+     * @param handler the Wite or Webpack event handler
+     * @returns Promise
+     */
     'server:devHandler': (handler: EventHandler) => HookResult;
+    /**
+     * Called at setup allowing modules to extend sources.
+     * @param presets Array containing presets objects
+     * @returns Promise
+     */
     'imports:sources': (presets: ImportPresetWithDeprecation[]) => HookResult;
+    /**
+     * Called at setup allowing modules to extend imports.
+     * @param imports Array containing the imports to extend
+     * @returns Promise
+     */
     'imports:extend': (imports: Import[]) => HookResult;
+    /**
+     * Called when the `kdimport` context is created.
+     * @param context The Kdimport context
+     * @returns Promise
+     */
     'imports:context': (context: Kdimport) => HookResult;
+    /**
+     * Allows extending import directories.
+     * @param dirs Array containing directories as string
+     * @returns Promise
+     */
     'imports:dirs': (dirs: string[]) => HookResult;
+    /**
+     * Called within `app:resolve` allowing to extend the directories that are scanned for auto-importable components.
+     * @param dirs The `dirs` option to push new items
+     * @returns Promise
+     */
     'components:dirs': (dirs: ComponentsOptions['dirs']) => HookResult;
+    /**
+     * Allows extending new components.
+     * @param components The `components` array to push new items
+     * @returns Promise
+     */
     'components:extend': (components: Component[]) => HookResult;
+    /**
+     * Called before initializing Hole, allowing customization of Hole's configuration.
+     * @param holeConfig The hole config to be extended
+     * @returns Promise
+     */
     'hole:config': (holeConfig: HoleConfig) => HookResult;
+    /**
+     * Called after Hole is initialized, which allows registering Hole hooks and interacting directly with Hole.
+     * @param hole The created hole object
+     * @returns Promise
+     */
     'hole:init': (hole: Hole) => HookResult;
+    /**
+     * Called before building the Hole instance.
+     * @param hole The created hole object
+     * @returns Promise
+     */
     'hole:build:before': (hole: Hole) => HookResult;
+    /**
+     * Allows extending the routes to be pre-rendered.
+     * @param ctx Dtwo context
+     * @returns Promise
+     */
     'prerender:routes': (ctx: {
         routes: Set<string>;
     }) => HookResult;
+    /**
+     * Called when an error occurs at build time.
+     * @param error Error object
+     * @returns Promise
+     */
     'build:error': (error: Error) => HookResult;
+    /**
+     * Called before Dtwc writes `.dtwo/tsconfig.json` and `.dtwo/dtwo.d.ts`, allowing addition of custom references and declarations in `dtwo.d.ts`, or directly modifying the options in `tsconfig.json`
+     * @param options Objects containing `references`, `declarations`, `tsConfig`
+     * @returns Promise
+     */
     'prepare:types': (options: {
         references: TSReference[];
         declarations: string[];
         tsConfig: TSConfig;
     }) => HookResult;
+    /**
+     * Called when the dev server is loading.
+     * @param listenerServer The HTTP/HTTPS server object
+     * @param listener The server's listener object
+     * @returns Promise
+     */
     'listen': (listenerServer: Server | Server$1, listener: any) => HookResult;
+    /**
+     * Allows extending default schemas.
+     * @param schemas Schemas to be extend
+     * @returns void
+     */
     'schema:extend': (schemas: SchemaDefinition[]) => void;
+    /**
+     * Allows extending resolved schema.
+     * @param schema Schema object
+     * @returns void
+     */
     'schema:resolved': (schema: Schema) => void;
+    /**
+     * Called before writing the given schema.
+     * @param schema Schema object
+     * @returns void
+     */
     'schema:beforeWrite': (schema: Schema) => void;
+    /**
+     * Called after the schema is written.
+     * @returns void
+     */
     'schema:written': () => void;
+    /**
+     * Allows to extend Wite default context.
+     * @param witeBuildContext The wite build context object
+     * @returns Promise
+     */
     'wite:extend': (witeBuildContext: {
         dtwo: Dtwo;
         config: InlineConfig;
     }) => HookResult;
+    /**
+     * Allows to extend Wite default config.
+     * @param witeInlineConfig The wite inline config object
+     * @param env Server or client
+     * @returns Promise
+     */
     'wite:extendConfig': (witeInlineConfig: InlineConfig, env: {
         isClient: boolean;
         isServer: boolean;
     }) => HookResult;
+    /**
+     * Called when the Wite server is created.
+     * @param witeServer Wite development server
+     * @param env Server or client
+     * @returns Promise
+     */
     'wite:serverCreated': (witeServer: WiteDevServer, env: {
         isClient: boolean;
         isServer: boolean;
     }) => HookResult;
+    /**
+     * Called after Wite server is compiled.
+     * @returns Promise
+     */
     'wite:compiled': () => HookResult;
+    /**
+     * Called before configuring the webpack compiler.
+     * @param webpackConfigs Configs objects to be pushed to the compiler
+     * @returns Promise
+     */
     'webpack:config': (webpackConfigs: Configuration[]) => HookResult;
+    /**
+     * Called right before compilation.
+     * @param options The options to be added
+     * @returns Promise
+     */
     'webpack:compile': (options: {
         name: string;
         compiler: Compiler;
     }) => HookResult;
+    /**
+     * Called after resources are loaded.
+     * @param options The compiler options
+     * @returns Promise
+     */
     'webpack:compiled': (options: {
         name: string;
         compiler: Compiler;
         stats: Stats;
     }) => HookResult;
+    /**
+     * Called on `change` on WebpackBar.
+     * @param shortPath the short path
+     * @returns void
+     */
     'webpack:change': (shortPath: string) => void;
+    /**
+     * Called on `done` if has errors on WebpackBar.
+     * @returns void
+     */
     'webpack:error': () => void;
+    /**
+     * Called on `allDone` on WebpackBar.
+     * @returns void
+     */
     'webpack:done': () => void;
+    /**
+     * Called on `progress` on WebpackBar.
+     * @param statesArray The array containing the states on progress
+     * @returns void
+     */
     'webpack:progress': (statesArray: any[]) => void;
 }
 type DtwoHookName = keyof DtwoHooks;
@@ -2035,9 +2250,20 @@ type AppHeadMetaObject = MetaObjectRaw & {
 type DeepPartial<T> = T extends Function ? T : T extends Record<string, any> ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
+type ExtractUpperChunk<T extends string> = T extends `${infer A}${infer B}` ? A extends Uppercase<A> ? B extends `${Uppercase<string>}${infer Rest}` ? B extends `${infer C}${Rest}` ? `${A}${C}${ExtractUpperChunk<Rest>}` : never : A : '' : never;
+type SliceLast<T extends string> = T extends `${infer A}${infer B}` ? B extends `${infer C}${infer D}` ? D extends '' ? A : `${A}${C}${SliceLast<D>}` : '' : never;
+type UpperSnakeCase<T extends string, State extends 'start' | 'lower' | 'upper' = 'start'> = T extends `${infer A}${infer B}` ? A extends Uppercase<A> ? A extends `${1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0}` ? `${A}${UpperSnakeCase<B, 'lower'>}` : State extends 'lower' | 'upper' ? B extends `${SliceLast<ExtractUpperChunk<B>>}${infer Rest}` ? SliceLast<ExtractUpperChunk<B>> extends '' ? `_${A}_${UpperSnakeCase<B, 'start'>}` : `_${A}${SliceLast<ExtractUpperChunk<B>>}_${UpperSnakeCase<Rest, 'start'>}` : B extends Uppercase<B> ? `_${A}${B}` : `_${A}${UpperSnakeCase<B, 'lower'>}` : State extends 'start' ? `${A}${UpperSnakeCase<B, 'lower'>}` : never : State extends 'start' | 'lower' ? `${Uppercase<A>}${UpperSnakeCase<B, 'lower'>}` : `_${Uppercase<A>}${UpperSnakeCase<B, 'lower'>}` : Uppercase<T>;
+declare const message: unique symbol;
+type RuntimeValue<T, B extends string> = T & {
+    [message]?: B;
+};
+type Overrideable<T extends Record<string, any>, Path extends string = ''> = {
+    [K in keyof T]?: K extends string ? T[K] extends Record<string, any> ? RuntimeValue<Overrideable<T[K], `${Path}_${UpperSnakeCase<K>}`>, `You can override this value at runtime with DTWO${Path}_${UpperSnakeCase<K>}`> : RuntimeValue<T[K], `You can override this value at runtime with DTWO${Path}_${UpperSnakeCase<K>}`> : never;
+};
 /** User configuration in `dtwo.config` file */
-interface DtwoConfig extends DeepPartial<Omit<ConfigSchema, 'wite'>> {
+interface DtwoConfig extends DeepPartial<Omit<ConfigSchema, 'wite' | 'runtimeConfig'>> {
     wite?: ConfigSchema['wite'];
+    runtimeConfig?: Overrideable<RuntimeConfig>;
     /**
      * Experimental custom config schema
     */
@@ -2109,4 +2335,4 @@ declare const _default: {
     [x: string]: untyped.SchemaDefinition | untyped.JSValue | untyped.InputObject;
 };
 
-export { AppConfig, AppConfigInput, AppHeadMetaObject, Component, ComponentsDir, ComponentsOptions, Dtwo, DtwoApp, DtwoAppConfig, DtwoCompatibility, DtwoCompatibilityIssue, DtwoCompatibilityIssues, DtwoConfig, DtwoConfigLayer, _default as DtwoConfigSchema, DtwoHookName, DtwoHooks, DtwoLayout, DtwoMiddleware, DtwoModule, DtwoOptions, DtwoPage, DtwoPlugin, DtwoPluginTemplate, DtwoTemplate, GenerateAppOptions, HeadAugmentations, HookResult, ImportPresetWithDeprecation, ImportsOptions, MetaObject, MetaObjectRaw, ModuleDefinition, ModuleMeta, ModuleOptions, PublicRuntimeConfig, ResolvedDtwoTemplate, RouterConfig, RouterConfigSerializable, RouterOptions, RuntimeConfig, ScanDir, TSReference, WatchEvent, WiteConfig };
+export { AppConfig, AppConfigInput, AppHeadMetaObject, Component, ComponentsDir, ComponentsOptions, Dtwo, DtwoApp, DtwoAppConfig, DtwoCompatibility, DtwoCompatibilityIssue, DtwoCompatibilityIssues, DtwoConfig, DtwoConfigLayer, _default as DtwoConfigSchema, DtwoHookName, DtwoHooks, DtwoLayout, DtwoMiddleware, DtwoModule, DtwoOptions, DtwoPage, DtwoPlugin, DtwoPluginTemplate, DtwoTemplate, GenerateAppOptions, HeadAugmentations, HookResult, ImportPresetWithDeprecation, ImportsOptions, MetaObject, MetaObjectRaw, ModuleDefinition, ModuleMeta, ModuleOptions, PublicRuntimeConfig, ResolvedDtwoTemplate, RouterConfig, RouterConfigSerializable, RouterOptions, RuntimeConfig, RuntimeValue, ScanDir, TSReference, WatchEvent, WiteConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dtwo/schema",
-  "version": "3.1.2",
+  "version": "3.2.0",
   "repository": "d2js/dtwo",
   "license": "MIT",
   "type": "module",
@@ -13,9 +13,9 @@
   "devDependencies": {
     "@types/lodash.template": "4.5.1",
     "@types/semver": "7.3.13",
-    "@kdhead/schema": "1.0.20",
+    "@kdhead/schema": "1.0.21",
     "@witejs/plugin-kdu": "4.0.0",
-    "holepack": "2.1.1",
+    "holepack": "2.2.1",
     "kdu-router": "4.1.6",
     "unbuild": "1.1.1",
     "wite": "4.2.0"
@@ -25,8 +25,8 @@
     "create-require": "1.1.1",
     "defu": "6.1.2",
     "hookable": "5.4.2",
-    "jiti": "1.16.2",
-    "kdimport": "2.1.0",
+    "jiti": "1.17.0",
+    "kdimport": "2.2.4",
     "pathe": "1.1.0",
     "pkg-types": "1.0.1",
     "postcss-import-resolver": "2.0.0",