@sudajs/cli 0.8.2 → 0.9.0

package/dist/index.d.ts

@@ -13,6 +13,9 @@ interface ValidatedTheme {
     clientEntryPath: string | null;
     stylesheetPath: string | null;
 }
+interface ThemeRootOptions {
+    themeRoot?: string | undefined;
+}
 interface CliAuthContext {
     baseUrl: string;
     token: string;
@@ -92,13 +95,17 @@ declare function buildTheme(root: string): Promise<ValidatedTheme>;
 declare function finalizeTheme(root: string): Promise<ValidatedTheme>;
 declare function findAnchorTagByHref(html: string, href: string): string | null;
 declare const __testUtils: {
+    createThemeProjectRequire: typeof createThemeProjectRequire;
     createRemotePageDraft: typeof createRemotePageDraft;
     findAnchorTagByHref: typeof findAnchorTagByHref;
     loadThemeScopedRenderer: typeof loadThemeScopedRenderer;
+    normalizePlaywrightModule: typeof normalizePlaywrightModule;
+    normalizeSharpModule: typeof normalizeSharpModule;
     initThemeWithKey: typeof initThemeWithKey;
     performActivateTheme: typeof performActivateTheme;
     performConfirmedPageOperation: typeof performConfirmedPageOperation;
     renderDevStarterPageHtml: typeof renderDevStarterPageHtml;
+    resolveScreenshotOptions: typeof resolveScreenshotOptions;
     slugifyThemeName: typeof slugifyThemeName;
     validateThemeKey: typeof validateThemeKey;
     validateThemeName: typeof validateThemeName;
@@ -109,8 +116,8 @@ declare function watchTheme(root: string, port: number): Promise<void>;
 /**
  * Theme-project-scoped renderer bundle. We deliberately resolve `react`,
  * `react-dom/server` and `@sudajs/theme-engine/server` through the theme
- * project's own `require` graph instead of the CLI's, because the theme
- * `dist/index.js` was already loaded against that copy of React. Importing
+ * project's own `require` graph instead of the CLI's, because the theme's
+ * local `dist/index.js` was already loaded against that copy of React. Importing
  * a different React instance from the CLI side would yield two React
  * dispatchers; client components inside the theme would call hooks against
  * the CLI's React (whose dispatcher is `null` outside a render), producing
@@ -125,6 +132,69 @@ interface ThemeRenderer {
 }
 declare function loadThemeScopedRenderer(themeRoot: string): Promise<ThemeRenderer>;
 declare function renderDevStarterPageHtml(theme: ValidatedTheme, page: ThemeStarterPage, renderer: ThemeRenderer): string;
+interface ScreenshotOptions extends ThemeRootOptions {
+    device?: string[] | string;
+    output?: string;
+    width?: string;
+    height?: string;
+    port?: string;
+    fullPage?: boolean;
+}
+interface ResolvedScreenshotOptions {
+    targets: ScreenshotTarget[];
+    port: number;
+    fullPage: boolean;
+}
+declare const SCREENSHOT_DEVICES: readonly ["desktop", "tablet", "mobile"];
+type ScreenshotDevice = (typeof SCREENSHOT_DEVICES)[number];
+interface ScreenshotTarget {
+    device: ScreenshotDevice;
+    outputPath: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+}
+declare function resolveScreenshotOptions(root: string, options: ScreenshotOptions): ResolvedScreenshotOptions;
+interface PlaywrightModule {
+    chromium: {
+        launch: (options?: {
+            headless?: boolean;
+        }) => Promise<{
+            newContext: (options: {
+                viewport: {
+                    width: number;
+                    height: number;
+                };
+                deviceScaleFactor?: number;
+            }) => Promise<{
+                newPage: () => Promise<{
+                    goto: (url: string, options?: {
+                        waitUntil?: string;
+                    }) => Promise<unknown>;
+                    screenshot: (options: {
+                        path: string;
+                        fullPage?: boolean;
+                    }) => Promise<unknown>;
+                    close: () => Promise<void>;
+                }>;
+                close: () => Promise<void>;
+            }>;
+            close: () => Promise<void>;
+        }>;
+    };
+}
+type SharpOptimizer = (input: string) => {
+    png: (options?: {
+        compressionLevel?: number;
+        palette?: boolean;
+    }) => {
+        toBuffer: () => Promise<Buffer>;
+    };
+};
+declare function createThemeProjectRequire(themeRoot: string): NodeJS.Require;
+declare function normalizePlaywrightModule(moduleValue: unknown): PlaywrightModule | null;
+declare function normalizeSharpModule(moduleValue: unknown): SharpOptimizer | null;
 /**
  * 解析人机交互的 `key@version` 格式。允许仅 `key`，也允许带 version。
  * 注意：theme key 现行约束不含 `@`，所以从右侧第一个 `@` 之后视为 version。