npm - @univer-cli/unit-screenshot-command - Versions diffs - 1.0.0-beta.2 - Mend

@univer-cli/unit-screenshot-command 1.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,41 @@
+# @univer-cli/unit-screenshot-command
+English | [简体中文](./README.zh-CN.md)
+Provide a native Commander `screenshot` preset for `@univer-cli/unit-screenshot`. It parses Unit and target options, calls the capability, and saves PNGs through an injected writer.
+## Installation
+```bash
+pnpm add commander @univer-cli/unit-screenshot @univer-cli/unit-screenshot-command
+```
+## Add to application
+```ts
+import {
+  createUnitScreenshotCommand,
+  type UnitScreenshotCommandDependencies,
+} from "@univer-cli/unit-screenshot-command";
+import { Command } from "commander";
+export async function runCli(dependencies: UnitScreenshotCommandDependencies): Promise<void> {
+  const program = new Command("my-cli");
+  program.addCommand(createUnitScreenshotCommand(dependencies));
+  await program.parseAsync();
+}
+```
+The application provides dependencies including the UnitData loader, screenshot capability, and PNG writer. The package does not define how Unit IDs map to local files, Workspace, or other targets.
+## Input and output
+The command accepts a Unit ID, Unit type, and screenshot selectors such as a Sheet range, Slide pages, Board elements, scale, and output directory. Default output lists the written PNG paths; `--json` prints a structured summary, and image bytes never enter stdout.
+Commander exits non-zero when arguments are invalid or Unit loading, rendering, or file writing fails. The application still owns the runtime and other long-lived resources and closes them at the composition root.
+## Browser setup command
+`createUniverRenderBrowserSetupCommand()` provides optional browser installation and detection for environments without a system Chromium. It does not implicitly download a browser for every screenshot.
+Both factories return native Commander `Command` instances. Target selection, pagination, naming, and limits belong to the capability. This package handles only argv, presentation, and the writer adapter.

package/README.zh-CN.md ADDED Viewed

@@ -0,0 +1,47 @@
+# @univer-cli/unit-screenshot-command
+[English](./README.md) | 简体中文
+为 `@univer-cli/unit-screenshot` 提供原生 Commander `screenshot` preset：解析 Unit 与 target options，
+调用 capability，并通过注入的 writer 保存 PNG。
+## 安装
+```bash
+pnpm add commander @univer-cli/unit-screenshot @univer-cli/unit-screenshot-command
+```
+## 添加到应用
+```ts
+import {
+  createUnitScreenshotCommand,
+  type UnitScreenshotCommandDependencies,
+} from "@univer-cli/unit-screenshot-command";
+import { Command } from "commander";
+export async function runCli(dependencies: UnitScreenshotCommandDependencies): Promise<void> {
+  const program = new Command("my-cli");
+  program.addCommand(createUnitScreenshotCommand(dependencies));
+  await program.parseAsync();
+}
+```
+Dependencies 由 application 提供，包括 UnitData loader、screenshot capability 与 PNG writer。Package 不规定
+Unit ID 如何映射到本地文件、Workspace 或其他 target。
+## 输入与输出
+Command 接受 Unit ID、Unit type 和各类 screenshot selector，例如 Sheet range、Slide pages、Board elements、
+scale 与输出目录。默认输出写入的 PNG 路径；`--json` 输出结构化 summary，图片 bytes 不进入 stdout。
+参数非法、Unit 加载、渲染或写文件失败时由 Commander 失败退出。已创建的 runtime 与其他长生命周期资源仍由
+application 在 composition root 统一关闭。
+## Browser setup command
+`createUniverRenderBrowserSetupCommand()` 提供可选的 browser 安装/探测交互，适合没有系统 Chromium 的环境。
+它不会在每次截图时隐式下载 browser。
+Factory 均返回原生 Commander `Command`。Target 选择、分页、命名与限制属于 capability，本 package 只拥有
+argv、presentation 与 writer adapter。

package/dist/index.cjs ADDED Viewed

	@@ -0,0 +1 @@
1	+ 'use strict';module['exports']=require('./index.mjs');

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,43 @@
+import { UnitScreenshot, UnitScreenshotResult } from "@univer-cli/unit-screenshot";
+import { UniverRenderBrowserInstallation, UniverRenderBrowserResolution, UniverRenderUnit } from "@univer-cli/univer-render-runtime";
+import { Command } from "commander";
+//#region src/browser-setup.d.ts
+interface UniverRenderBrowserSetupCommandDependencies {
+  readonly install: () => Promise<UniverRenderBrowserInstallation>;
+  readonly probe: (input: {
+    readonly executablePath: string;
+  }) => Promise<void>;
+  readonly resolve: () => Promise<UniverRenderBrowserResolution>;
+}
+type UniverRenderBrowserSetupResult = {
+  readonly executablePath: string;
+  readonly source: "explicit" | "env" | "cache" | "system";
+  readonly status: "resolved";
+} | ({
+  readonly status: "installed";
+} & UniverRenderBrowserInstallation);
+declare function createUniverRenderBrowserSetupCommand(dependencies?: UniverRenderBrowserSetupCommandDependencies): Command;
+//#endregion
+//#region src/index.d.ts
+interface UnitScreenshotCommandDependencies {
+  readonly browserSetup?: UniverRenderBrowserSetupCommandDependencies;
+  readonly loadUnit: (input: {
+    readonly unitId?: string;
+  }) => Promise<UniverRenderUnit>;
+  readonly screenshot: UnitScreenshot;
+  readonly writeImages: (input: UnitScreenshotWriteInput) => Promise<readonly UnitScreenshotWrittenImage[]>;
+}
+interface UnitScreenshotWriteInput {
+  readonly destination?: string;
+  readonly result: UnitScreenshotResult;
+}
+interface UnitScreenshotWrittenImage {
+  readonly location: string;
+  readonly name: string;
+}
+declare class UnitScreenshotCommandInputError extends Error {
+  constructor(message: string);
+}
+declare function createUnitScreenshotCommand(dependencies: UnitScreenshotCommandDependencies): Command;
+//#endregion
+export { UnitScreenshotCommandDependencies, UnitScreenshotCommandInputError, UnitScreenshotWriteInput, UnitScreenshotWrittenImage, type UniverRenderBrowserSetupCommandDependencies, type UniverRenderBrowserSetupResult, createUnitScreenshotCommand, createUniverRenderBrowserSetupCommand };

package/dist/index.mjs ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,27 @@
+{
+  "name": "@univer-cli/unit-screenshot-command",
+  "type": "module",
+  "version": "1.0.0-beta.2",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.zh-CN.md"
+  ],
+  "dependencies": {
+    "@univer-cli/unit-screenshot": "1.0.0-beta.2",
+    "@univer-cli/univer-render-runtime": "1.0.0-beta.2"
+  },
+  "peerDependencies": {
+    "commander": "^15.0.0"
+  }
+}