@dtwo/kit 3.0.0 → 3.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 - Dtwo Project
+Copyright (c) 2022 - Dtwo Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,3 +1,7 @@
-# Dtwo Kit
+# Dtwo
 
-> Toolkit for authoring Dtwo Modules
+Dtwo 3: **The Intuitive Web Framework** ✨
+
+## License
+
+[MIT](./LICENSE)

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-import { ModuleOptions, ModuleDefinition, DtwoModule, Dtwo, DtwoConfig, DtwoOptions, ImportPresetWithDeprecation, DtwoCompatibility, DtwoCompatibilityIssues, ComponentsDir, Component, DtwoTemplate, DtwoHooks, DtwoPlugin, DtwoPluginTemplate, ResolvedDtwoTemplate } from '@dtwo/schema';
+import { ModuleOptions, ModuleDefinition, DtwoModule, Dtwo, DtwoConfig, DtwoOptions, SchemaDefinition, ImportPresetWithDeprecation, DtwoCompatibility, DtwoCompatibilityIssues, ComponentsDir, Component, DtwoTemplate, DtwoHooks, DtwoPlugin, DtwoPluginTemplate, ResolvedDtwoTemplate } from '@dtwo/schema';
 import { LoadConfigOptions } from 'c12';
 import { Import } from 'kdimport';
 import { Configuration, WebpackPluginInstance } from 'webpack';
 import { UserConfig, Plugin } from 'wite';
 import * as unctx_index from 'unctx/index';
-import { HoleEventHandler, HoleDevEventHandler, Hole } from 'holepack';
+import { HoleEventHandler, HoleDevEventHandler, Hole, HoleRouteConfig } from 'holepack';
 import * as consola from 'consola';
 import { genSafeVariableName } from 'knitwork';
 
@@ -34,6 +34,8 @@ interface LoadDtwoOptions extends LoadDtwoConfigOptions {
 declare function loadDtwo(opts: LoadDtwoOptions): Promise<Dtwo>;
 declare function buildDtwo(dtwo: Dtwo): Promise<any>;
 
+declare function extendDtwoSchema(def: SchemaDefinition | (() => SchemaDefinition)): void;
+
 declare function addImports(imports: Import | Import[]): void;
 declare function addImportsDir(dirs: string | string[]): void;
 declare function addImportsSources(presets: ImportPresetWithDeprecation | ImportPresetWithDeprecation[]): void;
@@ -69,7 +71,7 @@ interface ExtendWebpackConfigOptions extends ExtendConfigOptions {
 interface ExtendWiteConfigOptions extends ExtendConfigOptions {
 }
 /**
- * Extend Webpack config
+ * Extend webpack config
  *
  * The fallback function might be called multiple times
  * when applying to both client and server builds.
@@ -80,7 +82,7 @@ declare function extendWebpackConfig(fn: ((config: Configuration) => void), opti
  */
 declare function extendWiteConfig(fn: ((config: UserConfig) => void), options?: ExtendWiteConfigOptions): (() => void) | undefined;
 /**
- * Append Webpack plugin to the config.
+ * Append webpack plugin to the config.
  */
 declare function addWebpackPlugin(plugin: WebpackPluginInstance | WebpackPluginInstance[], options?: ExtendWebpackConfigOptions): void;
 /**
@@ -200,7 +202,16 @@ declare function isIgnored(pathname: string): boolean;
 
 declare function addLayout(this: any, template: DtwoTemplate, name?: string): void;
 
-declare function extendPages(cb: DtwoHooks['pages:extend']): void;
+declare function extendPages(cb: DtwoHooks['pages:extend']): void;
+interface ExtendRouteRulesOptions {
+    /**
+     * Override route rule config
+     *
+     * @default false
+     */
+    override?: boolean;
+}
+declare function extendRouteRules(route: string, rule: HoleRouteConfig, options?: ExtendRouteRulesOptions): void;
 
 /**
  * Normalize a dtwo plugin object
@@ -330,4 +341,4 @@ declare const templateUtils: {
     }) => string;
 };
 
-export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendWebpackConfigOptions, ExtendWiteConfigOptions, LoadDtwoConfigOptions, LoadDtwoOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addWebpackPlugin, addWitePlugin, assertDtwoCompatibility, buildDtwo, checkDtwoCompatibility, clearRequireCache, compileTemplate, createResolver, defineDtwoModule, dtwoCtx, extendPages, extendWebpackConfig, extendWiteConfig, findPath, getDtwoVersion, getRequireCacheItem, hasDtwoCompatibility, importModule, installModule, isDtwo2, isDtwo3, isIgnored, isNodeModules, loadDtwo, loadDtwoConfig, logger, normalizePlugin, normalizeTemplate, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseDtwo, updateTemplates, useDtwo, useHole, useLogger };
+export { AddComponentOptions, AddPluginOptions, ExtendConfigOptions, ExtendRouteRulesOptions, ExtendWebpackConfigOptions, ExtendWiteConfigOptions, LoadDtwoConfigOptions, LoadDtwoOptions, RequireModuleOptions, ResolveModuleOptions, ResolvePathOptions, Resolver, addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addWebpackPlugin, addWitePlugin, assertDtwoCompatibility, buildDtwo, checkDtwoCompatibility, clearRequireCache, compileTemplate, createResolver, defineDtwoModule, dtwoCtx, extendDtwoSchema, extendPages, extendRouteRules, extendWebpackConfig, extendWiteConfig, findPath, getDtwoVersion, getRequireCacheItem, hasDtwoCompatibility, importModule, installModule, isDtwo2, isDtwo3, isIgnored, isNodeModules, loadDtwo, loadDtwoConfig, logger, normalizePlugin, normalizeTemplate, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseDtwo, updateTemplates, useDtwo, useHole, useLogger };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { promises, existsSync, readFileSync } from 'node:fs';
-import defu from 'defu';
+import defu, { defu as defu$1 } from 'defu';
 import { applyDefaults } from 'untyped';
 import { dirname, join, normalize, relative, isAbsolute, resolve, basename, parse } from 'pathe';
 import consola from 'consola';
@@ -259,9 +259,11 @@ function requireModulePkg(id, opts = {}) {
 function resolveModule(id, opts = {}) {
   return normalize(_require.resolve(id, {
     paths: [].concat(
+      // @ts-ignore
       global.__DTWO_PREPATHS__,
       opts.paths || [],
       process.cwd(),
+      // @ts-ignore
       global.__DTWO_PATHS__
     ).filter(Boolean)
   }));
@@ -311,18 +313,35 @@ function isIgnored(pathname) {
   }
   if (!dtwo._ignore) {
     dtwo._ignore = ignore(dtwo.options.ignoreOptions);
-    dtwo._ignore.add(dtwo.options.ignore);
+    const resolvedIgnore = dtwo.options.ignore.flatMap((s) => resolveGroupSyntax(s));
+    dtwo._ignore.add(resolvedIgnore);
     const dtwoignoreFile = join(dtwo.options.rootDir, ".dtwoignore");
     if (existsSync(dtwoignoreFile)) {
       dtwo._ignore.add(readFileSync(dtwoignoreFile, "utf-8"));
     }
   }
-  const relativePath = relative(dtwo.options.rootDir, pathname);
+  const cwds = dtwo.options._layers?.map((layer2) => layer2.cwd).sort((a, b) => b.length - a.length);
+  const layer = cwds?.find((cwd) => pathname.startsWith(cwd));
+  const relativePath = relative(layer ?? dtwo.options.rootDir, pathname);
   if (relativePath.startsWith("..")) {
     return false;
   }
   return !!(relativePath && dtwo._ignore.ignores(relativePath));
 }
+function resolveGroupSyntax(group) {
+  let groups = [group];
+  while (groups.some((group2) => group2.includes("{"))) {
+    groups = groups.flatMap((group2) => {
+      const [head, ...tail] = group2.split("{");
+      if (tail.length) {
+        const [body, ...rest] = tail.join("{").split("}");
+        return body.split(",").map((part) => `${head}${part}${rest.join("")}`);
+      }
+      return group2;
+    });
+  }
+  return groups;
+}
 
 async function resolvePath(path, opts = {}) {
   const _path = path;
@@ -500,6 +519,7 @@ async function loadDtwo(opts) {
     configOverrides: opts.overrides,
     ready: opts.ready,
     envConfig: opts.dotenv
+    // TODO: Backward format convertion
   });
   return dtwo;
 }
@@ -513,6 +533,13 @@ async function buildDtwo(dtwo) {
   return build(dtwo);
 }
 
+function extendDtwoSchema(def) {
+  const dtwo = useDtwo();
+  dtwo.hook("schema:extend", (schemas) => {
+    schemas.push(typeof def === "function" ? def() : def);
+  });
+}
+
 function addImports(imports) {
   assertDtwoCompatibility({ bridge: true });
   useDtwo().hook("imports:extend", (_imports) => {
@@ -761,6 +788,15 @@ function extendPages(cb) {
     dtwo.hook("pages:extend", cb);
   }
 }
+function extendRouteRules(route, rule, options = {}) {
+  const dtwo = useDtwo();
+  for (const opts of [dtwo.options, dtwo.options.hole]) {
+    if (!opts.routeRules) {
+      opts.routeRules = {};
+    }
+    opts.routeRules[route] = options.override ? defu$1(rule, opts.routeRules[route]) : defu$1(opts.routeRules[route], rule);
+  }
+}
 
 function normalizePlugin(plugin) {
   if (typeof plugin === "string") {
@@ -793,4 +829,4 @@ function addPluginTemplate(plugin, opts = {}) {
   return addPlugin(normalizedPlugin, opts);
 }
 
-export { addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addWebpackPlugin, addWitePlugin, assertDtwoCompatibility, buildDtwo, checkDtwoCompatibility, clearRequireCache, compileTemplate, createResolver, defineDtwoModule, dtwoCtx, extendPages, extendWebpackConfig, extendWiteConfig, findPath, getDtwoVersion, getRequireCacheItem, hasDtwoCompatibility, importModule, installModule, isDtwo2, isDtwo3, isIgnored, isNodeModules, loadDtwo, loadDtwoConfig, logger, normalizePlugin, normalizeTemplate, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseDtwo, updateTemplates, useDtwo, useHole, useLogger };
+export { addComponent, addComponentsDir, addDevServerHandler, addImports, addImportsDir, addImportsSources, addLayout, addPlugin, addPluginTemplate, addPrerenderRoutes, addServerHandler, addServerPlugin, addTemplate, addWebpackPlugin, addWitePlugin, assertDtwoCompatibility, buildDtwo, checkDtwoCompatibility, clearRequireCache, compileTemplate, createResolver, defineDtwoModule, dtwoCtx, extendDtwoSchema, extendPages, extendRouteRules, extendWebpackConfig, extendWiteConfig, findPath, getDtwoVersion, getRequireCacheItem, hasDtwoCompatibility, importModule, installModule, isDtwo2, isDtwo3, isIgnored, isNodeModules, loadDtwo, loadDtwoConfig, logger, normalizePlugin, normalizeTemplate, requireModule, requireModulePkg, resolveAlias, resolveFiles, resolveModule, resolvePath, scanRequireTree, templateUtils, tryImportModule, tryRequireModule, tryResolveModule, tryUseDtwo, updateTemplates, useDtwo, useHole, useLogger };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dtwo/kit",
-  "version": "3.0.0",
-  "repository": "d2js/framework",
+  "version": "3.1.0",
+  "repository": "d2js/dtwo",
   "license": "MIT",
   "type": "module",
   "main": "./dist/index.mjs",
@@ -10,29 +10,29 @@
     "dist"
   ],
   "dependencies": {
-    "@dtwo/schema": "3.0.0",
-    "c12": "^1.0.1",
-    "consola": "^2.15.3",
-    "defu": "^6.1.1",
-    "globby": "^13.1.2",
-    "hash-sum": "^2.0.0",
-    "ignore": "^5.2.0",
-    "jiti": "^1.16.0",
-    "kdimport": "^1.0.0",
-    "knitwork": "^1.0.0",
-    "lodash.template": "^4.5.0",
-    "mlly": "^1.0.0",
-    "pathe": "^1.0.0",
-    "pkg-types": "^1.0.1",
-    "scule": "^1.0.0",
-    "semver": "^7.3.8",
-    "unctx": "^2.1.0",
-    "untyped": "^1.0.0"
+    "@dtwo/schema": "3.1.0",
+    "c12": "1.1.0",
+    "consola": "2.15.3",
+    "defu": "6.1.1",
+    "globby": "13.1.3",
+    "hash-sum": "2.0.0",
+    "ignore": "5.2.4",
+    "jiti": "1.16.2",
+    "kdimport": "2.0.1",
+    "knitwork": "1.0.0",
+    "lodash.template": "4.5.0",
+    "mlly": "1.1.0",
+    "pathe": "1.0.0",
+    "pkg-types": "1.0.1",
+    "scule": "1.0.0",
+    "semver": "7.3.8",
+    "unctx": "2.1.1",
+    "untyped": "1.2.2"
   },
   "devDependencies": {
-    "@types/lodash.template": "^4",
-    "@types/semver": "^7",
-    "unbuild": "latest"
+    "@types/lodash.template": "4.5.1",
+    "@types/semver": "7.3.13",
+    "unbuild": "1.1.1"
   },
   "engines": {
     "node": "^14.16.0 || ^16.10.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"