dumi 2.3.0-beta.0 → 2.3.0-beta.2

package/dist/client/pages/Demo/index.js

@@ -8,19 +8,19 @@ var DemoRenderPage = function DemoRenderPage() {
     component = _ref.component;
   var _useLiveDemo = useLiveDemo(id),
     liveDemoNode = _useLiveDemo.node,
-    setSources = _useLiveDemo.setSources;
+    setSource = _useLiveDemo.setSource;
   var finalNode = liveDemoNode || component && /*#__PURE__*/createElement(component);
   useEffect(function () {
     var handler = function handler(ev) {
-      if (ev.data.type === 'dumi.liveDemo.setSources') {
-        setSources(ev.data.value);
+      if (ev.data.type === 'dumi.liveDemo.setSource') {
+        setSource(ev.data.value);
       }
     };
     window.addEventListener('message', handler);
     return function () {
       return window.removeEventListener('message', handler);
     };
-  }, [setSources]);
+  }, [setSource]);
   return finalNode;
 };
 export default DemoRenderPage;

package/dist/client/theme-api/useLiveDemo.d.ts

@@ -2,5 +2,5 @@ import { type ReactNode } from 'react';
 export declare const useLiveDemo: (id: string) => {
     node: ReactNode;
     error: Error | null;
-    setSources: (sources: Record<string, string>) => void;
+    setSource: (source: Record<string, string>) => void;
 };

package/dist/client/theme-api/useLiveDemo.js

@@ -19,11 +19,11 @@ export var useLiveDemo = function useLiveDemo(id) {
     _useState4 = _slicedToArray(_useState3, 2),
     error = _useState4[0],
     setError = _useState4[1];
-  var setSources = useCallback(function (sources) {
+  var setSource = useCallback(function (source) {
     var entryFileName = Object.keys(asset.dependencies).find(function (k) {
       return asset.dependencies[k].type === 'FILE';
     });
-    var entryFileCode = sources[entryFileName];
+    var entryFileCode = source[entryFileName];
     var require = function require(v) {
       if (v in context) return context[v];
       throw new Error("Cannot find module: ".concat(v));
@@ -54,7 +54,7 @@ export var useLiveDemo = function useLiveDemo(id) {
         renderToStaticMarkup(newDemoNode);
         console.error = oError;
 
-        // set new demo node with passing sources
+        // set new demo node with passing source
         setDemoNode(newDemoNode);
         setError(null);
       } catch (err) {
@@ -65,6 +65,6 @@ export var useLiveDemo = function useLiveDemo(id) {
   return {
     node: demoNode,
     error: error,
-    setSources: setSources
+    setSource: setSource
   };
 };

package/dist/features/configPlugins/schema.js

@@ -54,7 +54,9 @@ function getSchemas() {
     extraRemarkPlugins: getUnifiedPluginSchema,
     extraRehypePlugins: getUnifiedPluginSchema,
     themeConfig: (Joi) => Joi.object().optional(),
-    logo: (Joi) => Joi.string()
+    logo: (Joi) => Joi.string(),
+    // FIXME: remove before 2.3.0
+    live: (Joi) => Joi.bool().optional()
   };
 }
 // Annotate the CommonJS export names for ESM import in node:

package/dist/features/derivative.js

@@ -158,6 +158,11 @@ var derivative_default = (api) => {
       }
     } catch {
     }
+    if ("live" in api.config) {
+      import_plugin_utils.logger.warn(
+        "`live` config is deprecated and live demo is always enabled now, please remove it."
+      );
+    }
   });
   safeExcludeInMFSU(api, [
     new RegExp("dumi/dist/client"),

package/dist/features/theme/index.js

@@ -86,7 +86,7 @@ function checkMinor2ByPkg(pkg) {
   if ((_a = pkg.name) == null ? void 0 : _a.startsWith("@examples/"))
     return true;
   const ver = ((_b = pkg.peerDependencies) == null ? void 0 : _b.dumi) || ((_c = pkg.devDependencies) == null ? void 0 : _c.dumi) || "^2.0.0";
-  return import_plugin_utils.semver.subset(ver, import_constants.VERSION_2_LEVEL_NAV);
+  return import_plugin_utils.semver.subset(ver, import_constants.VERSION_2_LEVEL_NAV, { includePrerelease: true });
 }
 var theme_default = (api) => {
   const defaultThemeData = (0, import_loader.default)(DEFAULT_THEME_PATH);

package/dist/loaders/markdown/transformer/index.js

@@ -56,7 +56,9 @@ function keepSoftBreak(pkg) {
   if (((_a = pkg == null ? void 0 : pkg.name) == null ? void 0 : _a.startsWith("@examples/")) || (pkg == null ? void 0 : pkg.name) === "dumi")
     return false;
   const ver = ((_b = pkg == null ? void 0 : pkg.devDependencies) == null ? void 0 : _b.dumi) ?? ((_c = pkg == null ? void 0 : pkg.dependencies) == null ? void 0 : _c.dumi) ?? "^2.0.0";
-  return !import_plugin_utils.semver.subset(ver, import_constants.VERSION_2_DEPRECATE_SOFT_BREAKS);
+  return !import_plugin_utils.semver.subset(ver, import_constants.VERSION_2_DEPRECATE_SOFT_BREAKS, {
+    includePrerelease: true
+  });
 }
 async function applyUnifiedPlugin(opts) {
   const [plugin, options] = Array.isArray(opts.plugin) ? opts.plugin : [opts.plugin];

package/dist/templates/meta/exports.ts.tpl

@@ -109,7 +109,7 @@ export function getRouteMetaById<T extends { syncOnly?: boolean }>(
   ? undefined | IRouteMeta
   : Promise<undefined | IRouteMeta> | undefined {
   if (filesMeta[id]) {
-    const { frontmatter, toc, textGetter, tabs = [] } = filesMeta[id];
+    const { frontmatter, toc, textGetter, tabs } = filesMeta[id];
     const routeMeta: IRouteMeta = {
       frontmatter,
       toc: toc,
@@ -117,25 +117,30 @@ export function getRouteMetaById<T extends { syncOnly?: boolean }>(
     };
 
     if (opts?.syncOnly) {
-      routeMeta.tabs = tabs.map((tabId) =>
-        genTab(tabId, getRouteMetaById(tabId, opts)),
-      );
+      if (tabs) {
+        routeMeta.tabs = tabs.map((tabId) =>
+          genTab(tabId, getRouteMetaById(tabId, opts)),
+        );
+      }
+
+      return routeMeta;
     } else {
       return new Promise(async (resolve) => {
         if (textGetter) {
           ({ texts: routeMeta.texts } = await textGetter());
         }
 
-        routeMeta.tabs = await Promise.all(
-          tabs.map(async (tabId) =>
-            genTab(tabId, await getRouteMetaById(tabId, opts)),
-          ),
-        );
+        if (tabs) {
+          routeMeta.tabs = await Promise.all(
+            tabs.map(async (tabId) =>
+              genTab(tabId, await getRouteMetaById(tabId, opts)),
+            ),
+          );
+        }
+
         resolve(routeMeta);
       });
     }
-
-    return routeMeta;
   }
 }
 

package/dist/types.d.ts

@@ -78,9 +78,9 @@ export declare abstract class IDumiTechStack {
      */
     abstract generatePreviewerProps?(props: IDumiDemoProps['previewerProps'], opts: Parameters<NonNullable<IDumiTechStack['generateMetadata']>>[1]): Promise<IDumiDemoProps['previewerProps']> | IDumiDemoProps['previewerProps'];
     /**
-     * generator for return file path of demo sources
+     * generator for return file path of demo source
      */
-    abstract generateSources?(sources: IParsedBlockAsset['resolveMap'], opts: Parameters<NonNullable<IDumiTechStack['generateMetadata']>>[1]): Promise<IParsedBlockAsset['resolveMap']> | IParsedBlockAsset['resolveMap'];
+    abstract generateSources?(source: IParsedBlockAsset['resolveMap'], opts: Parameters<NonNullable<IDumiTechStack['generateMetadata']>>[1]): Promise<IParsedBlockAsset['resolveMap']> | IParsedBlockAsset['resolveMap'];
 }
 export type IApi = IUmiApi & {
     config: IDumiConfig & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.3.0-beta.0",
+  "version": "2.3.0-beta.2",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",

package/theme-default/builtins/Previewer/index.js

@@ -21,7 +21,7 @@ var Previewer = function Previewer(props) {
   var _useLiveDemo = useLiveDemo(props.asset.id),
     liveDemoNode = _useLiveDemo.node,
     liveDemoError = _useLiveDemo.error,
-    setLiveDemoSources = _useLiveDemo.setSources;
+    setLiveDemoSource = _useLiveDemo.setSource;
   var _useState = useState(null),
     _useState2 = _slicedToArray(_useState, 2),
     editorError = _useState2[0],
@@ -61,18 +61,18 @@ var Previewer = function Previewer(props) {
       __html: props.description
     }
   })), /*#__PURE__*/React.createElement(PreviewerActions, _extends({}, props, {
-    onSourcesTranspile: function onSourcesTranspile(_ref) {
+    onSourceTranspile: function onSourceTranspile(_ref) {
       var err = _ref.err,
-        sources = _ref.sources;
+        source = _ref.source;
       if (err) {
         setEditorError(err);
       } else {
         setEditorError(null);
-        setLiveDemoSources(sources);
+        setLiveDemoSource(source);
         if (props.iframe) {
           demoContainer.current.querySelector('iframe').contentWindow.postMessage({
-            type: 'dumi.liveDemo.setSources',
-            value: sources
+            type: 'dumi.liveDemo.setSource',
+            value: source
           });
         }
       }

package/theme-default/slots/PreviewerActions/index.d.ts

@@ -9,12 +9,12 @@ export interface IPreviewerActionsProps extends IPreviewerProps {
     extra?: ReactNode;
     forceShowCode?: boolean;
     demoContainer: HTMLDivElement | HTMLIFrameElement;
-    onSourcesTranspile?: (args: {
+    onSourceTranspile?: (args: {
         err: Error;
-        sources?: null;
+        source?: null;
     } | {
         err?: null;
-        sources: Record<string, string>;
+        source: Record<string, string>;
     }) => void;
 }
 declare const PreviewerActions: FC<IPreviewerActionsProps>;

package/theme-default/slots/PreviewerActions/index.js

@@ -182,14 +182,14 @@ var PreviewerActions = function PreviewerActions(props) {
             var err = _ref5.err,
               code = _ref5.code;
             if (err) {
-              var _props$onSourcesTrans;
-              (_props$onSourcesTrans = props.onSourcesTranspile) === null || _props$onSourcesTrans === void 0 ? void 0 : _props$onSourcesTrans.call(props, {
+              var _props$onSourceTransp;
+              (_props$onSourceTransp = props.onSourceTranspile) === null || _props$onSourceTransp === void 0 ? void 0 : _props$onSourceTransp.call(props, {
                 err: err
               });
             } else {
-              var _props$onSourcesTrans2;
-              (_props$onSourcesTrans2 = props.onSourcesTranspile) === null || _props$onSourcesTrans2 === void 0 ? void 0 : _props$onSourcesTrans2.call(props, {
-                sources: _defineProperty({}, files[i][0], code)
+              var _props$onSourceTransp2;
+              (_props$onSourceTransp2 = props.onSourceTranspile) === null || _props$onSourceTransp2 === void 0 ? void 0 : _props$onSourceTransp2.call(props, {
+                source: _defineProperty({}, files[i][0], code)
               });
             }
           },