@mintlify/previewing 4.0.593 → 4.0.595

package/dist/local-preview/network.js

@@ -0,0 +1,11 @@
+import os from 'os';
+export const getLocalNetworkIp = () => {
+    const interfaces = os.networkInterfaces();
+    for (const name of Object.keys(interfaces)) {
+        for (const iface of interfaces[name] || []) {
+            if (iface.family === 'IPv4' && !iface.internal) {
+                return iface.address;
+            }
+        }
+    }
+};

package/dist/local-preview/run.js

@@ -1,11 +1,13 @@
+import { jsx as _jsx } from "react/jsx-runtime";
 import open from 'better-opn';
-import Chalk from 'chalk';
 import express from 'express';
 import { createServer } from 'http';
 import { Server as SocketServer } from 'socket.io';
 import { NEXT_PUBLIC_PATH } from '../constants.js';
+import { addLog, LaunchLog, removeLastLog } from '../logs.js';
 import { maybeFixMissingWindowsEnvVar } from '../util.js';
 import listener from './listener/index.js';
+import { getLocalNetworkIp } from './network.js';
 import { setupNext } from './setupNext.js';
 export const run = async (argv) => {
     const port = argv.port || '3000';
@@ -14,6 +16,7 @@ export const run = async (argv) => {
     const server = createServer(app);
     const io = new SocketServer(server);
     const requestHandler = await setupNext();
+    const localIp = getLocalNetworkIp();
     // next-server is bugged, public files added after starting aren't served
     app.use('/', express.static(NEXT_PUBLIC_PATH));
     app.all('*', (req, res) => requestHandler(req, res));
@@ -21,10 +24,8 @@ export const run = async (argv) => {
         io.emit('reload');
     };
     server.listen(currentPort, () => {
-        console.log(`${Chalk.green(`Your local preview is available at http://localhost:${port}`)}`);
-        // Note: We wait for this exact text to be sure the server is ready in the cli e2e test,
-        // if it changes, the test will fail/require an update.
-        console.log(`${Chalk.green('Press Ctrl+C any time to stop the local preview.')}`);
+        removeLastLog();
+        addLog(_jsx(LaunchLog, { localUrl: `http://localhost:${port}`, networkUrl: localIp ? `http://${localIp}:${port}` : undefined }));
         /**
          * We're running into a known bug with the `open` package, where Windows machines error out because process.env.SYSTEMROOT is not set:
          * https://github.com/sindresorhus/open/issues/292

package/dist/logs.d.ts

@@ -0,0 +1,44 @@
+export declare const EmptyLineLog: () => import("react/jsx-runtime").JSX.Element;
+export declare const LaunchLog: ({ localUrl, networkUrl }: {
+    localUrl: string;
+    networkUrl?: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const InfoLog: ({ message }: {
+    message: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const SuccessLog: ({ message }: {
+    message: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const SpinnerLog: ({ message }: {
+    message: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const WarningLog: ({ message }: {
+    message: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const UpdateLog: ({ updateCommand }: {
+    updateCommand: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const ErrorLog: ({ message }: {
+    message: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const AddedLog: ({ filename }: {
+    filename: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const EditedLog: ({ filename }: {
+    filename: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const DeletedLog: ({ filename }: {
+    filename: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const BrokenLinksLog: ({ brokenLinksByFile, }: {
+    brokenLinksByFile: Record<string, string[]>;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const RenamedLog: ({ before, after }: {
+    before: string;
+    after: string;
+}) => import("react/jsx-runtime").JSX.Element;
+export declare const Logs: React.FC;
+export declare const addLog: (log: React.ReactNode) => void;
+export declare const addChangeLog: (log: React.ReactNode) => void;
+export declare const clearLogs: () => void;
+export declare const removeLastLog: () => void;

package/dist/logs.js

@@ -0,0 +1,66 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { Box, Text } from 'ink';
+import Spinner from 'ink-spinner';
+import { useState, useEffect } from 'react';
+export const EmptyLineLog = () => _jsx(Text, { children: " " });
+export const LaunchLog = ({ localUrl, networkUrl }) => {
+    return (_jsxs(Box, { flexDirection: "column", alignItems: "flex-start", children: [_jsxs(Text, { children: [_jsx(Text, { color: "green", bold: true, children: "\u2713" }), ' ', _jsx(Text, { children: "preview ready" })] }), _jsx(EmptyLineLog, {}), _jsxs(Text, { children: ['\u00A0'.repeat(2), "local", '\u00A0'.repeat(3), "\u2192", '\u00A0'.repeat(1), localUrl] }), networkUrl && (_jsxs(Text, { children: ['\u00A0'.repeat(2), "network", '\u00A0'.repeat(1), "\u2192", '\u00A0'.repeat(1), networkUrl] })), _jsx(EmptyLineLog, {}), _jsxs(Text, { dimColor: true, children: ["press ", _jsx(Text, { bold: true, children: "ctrl+c" }), " to exit the preview"] }), _jsx(EmptyLineLog, {})] }));
+};
+export const InfoLog = ({ message }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "blue", bold: true, children: "info" }), _jsxs(Text, { children: [" ", message] })] }));
+};
+export const SuccessLog = ({ message }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "green", bold: true, children: "success" }), _jsxs(Text, { children: [" ", message] })] }));
+};
+export const SpinnerLog = ({ message }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "green", bold: true, children: _jsx(Spinner, { type: "dots" }) }), _jsxs(Text, { children: [" ", message] })] }));
+};
+export const WarningLog = ({ message }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "yellow", bold: true, children: "warning" }), _jsxs(Text, { children: [" ", message] })] }));
+};
+export const UpdateLog = ({ updateCommand }) => {
+    return (_jsxs(Box, { flexDirection: "column", alignItems: "flex-start", children: [_jsxs(Text, { children: [_jsx(Text, { color: "yellow", bold: true, children: "update available" }), _jsxs(Text, { children: [' ', "- run `", _jsx(Text, { bold: true, children: updateCommand }), "` to get the latest version"] })] }), _jsx(EmptyLineLog, {})] }));
+};
+export const ErrorLog = ({ message }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "red", bold: true, children: "error" }), _jsxs(Text, { children: [" ", message] })] }));
+};
+export const AddedLog = ({ filename }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "green", bold: true, children: "added" }), _jsxs(Text, { children: [" ", filename] })] }));
+};
+export const EditedLog = ({ filename }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "yellow", bold: true, children: "edited" }), _jsxs(Text, { children: [" ", filename] })] }));
+};
+export const DeletedLog = ({ filename }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "red", bold: true, children: "deleted" }), _jsxs(Text, { children: [" ", filename] })] }));
+};
+export const BrokenLinksLog = ({ brokenLinksByFile, }) => {
+    const totalBrokenLinks = Object.values(brokenLinksByFile).reduce((acc, arr) => acc + arr.length, 0);
+    const totalFiles = Object.keys(brokenLinksByFile).length;
+    return (_jsxs(Box, { flexDirection: "column", alignItems: "flex-start", children: [_jsxs(Text, { children: [_jsx(Text, { children: "found" }), _jsxs(Text, { color: "yellow", bold: true, children: [' ', totalBrokenLinks, " broken links"] }), _jsxs(Text, { children: [" in ", totalFiles, " files"] })] }), _jsx(EmptyLineLog, {}), Object.entries(brokenLinksByFile).map(([filename, brokenLinks]) => (_jsxs(Box, { flexDirection: "column", alignItems: "flex-start", children: [_jsx(Box, { children: _jsx(Text, { bold: true, children: filename }) }), brokenLinks.map((link) => (_jsxs(Text, { children: ['\u00A0'.repeat(1), "\u23BF", '\u00A0'.repeat(2), link] }, link))), _jsx(EmptyLineLog, {})] }, filename)))] }));
+};
+export const RenamedLog = ({ before, after }) => {
+    return (_jsxs(Box, { children: [_jsx(Text, { color: "green", bold: true, children: "success" }), _jsxs(Text, { children: [' ', "renamed ", before, " to ", after] })] }));
+};
+export const Logs = () => {
+    const [logs, setLogs] = useState([]);
+    const [changeLogs, setChangeLogs] = useState([]);
+    useEffect(() => {
+        global.addLog = (log) => setLogs((prev) => [...prev, log]);
+        global.addChangeLog = (log) => setChangeLogs((prev) => [...prev, log]);
+        global.clearLogs = () => setLogs([]);
+        global.removeLastLog = () => setLogs((prev) => prev.slice(0, -1));
+    }, []);
+    return (_jsxs(_Fragment, { children: [logs.map((log, idx) => (_jsx(Box, { children: log }, idx))), changeLogs.length > 0 && (_jsxs(Box, { flexDirection: "column", alignItems: "flex-start", children: [_jsxs(Text, { children: [_jsx(Text, { dimColor: true, bold: true, children: "\u00B1" }), ' ', _jsx(Text, { children: "changes" })] }), changeLogs.map((log, idx) => (_jsx(Box, { children: log }, `change-${idx}`)))] }))] }));
+};
+export const addLog = (log) => {
+    global.addLog?.(log);
+};
+export const addChangeLog = (log) => {
+    global.addChangeLog?.(log);
+};
+export const clearLogs = () => {
+    global.clearLogs?.();
+};
+export const removeLastLog = () => {
+    global.removeLastLog?.();
+};