@kitschpatrol/tldraw-cli 4.6.28 → 4.6.30

package/dist/tldraw/translations/zh-tw.json

@@ -13,8 +13,6 @@
 	"action.convert-to-bookmark": "轉換為書籤",
 	"action.convert-to-embed": "轉換為嵌入",
 	"action.copy": "複製",
-	"action.copy-as-json": "複製為 JSON",
-	"action.copy-as-json.short": "JSON",
 	"action.copy-as-png": "複製為 PNG",
 	"action.copy-as-png.short": "PNG",
 	"action.copy-as-svg": "複製為 SVG",
@@ -28,31 +26,35 @@
 	"action.duplicate": "複製",
 	"action.edit-link": "編輯連結",
 	"action.exit-pen-mode": "退出畫筆模式",
-	"action.export-all-as-json": "全部匯出成 JSON",
-	"action.export-all-as-json.short": "JSON",
 	"action.export-all-as-png": "全部匯出成 PNG",
 	"action.export-all-as-png.short": "PNG",
 	"action.export-all-as-svg": "全部匯出成 SVG",
 	"action.export-all-as-svg.short": "SVG",
-	"action.export-as-json": "匯出成 JSON",
-	"action.export-as-json.short": "JSON",
 	"action.export-as-png": "匯出成 PNG",
 	"action.export-as-png.short": "PNG",
 	"action.export-as-svg": "匯出成 SVG",
 	"action.export-as-svg.short": "SVG",
 	"action.fit-frame-to-content": "貼合內容大小",
+	"action.flatten-to-image": "平鋪",
 	"action.flip-horizontal": "水平翻轉",
 	"action.flip-horizontal.short": "水平翻轉",
 	"action.flip-vertical": "垂直翻轉",
 	"action.flip-vertical.short": "垂直翻轉",
+	"action.fork-project": "分叉此專案",
+	"action.fork-project-on-tldraw": "在 tldraw 上分叉專案",
 	"action.group": "群組",
+	"action.insert-embed": "插入嵌入",
 	"action.insert-media": "上傳媒體檔",
+	"action.leave-shared-project": "離開共享專案",
 	"action.new-project": "新建專案",
 	"action.new-shared-project": "新建共享專案",
+	"action.open-cursor-chat": "Cursor chat",
 	"action.open-embed-link": "開啟連結",
 	"action.open-file": "開啟檔案",
 	"action.pack": "打包",
 	"action.paste": "貼上",
+	"action.paste-error-description": "由於沒有剪貼簿權限而無法貼上。請啟用權限並重試。",
+	"action.paste-error-title": "貼上失敗",
 	"action.print": "列印",
 	"action.redo": "取消復原",
 	"action.remove-frame": "移除框架",
@@ -79,10 +81,19 @@
 	"action.toggle-dark-mode.menu": "深色模式",
 	"action.toggle-debug-mode": "切換除錯模式",
 	"action.toggle-debug-mode.menu": "除錯模式",
+	"action.toggle-dynamic-size-mode": "切換動態大小",
+	"action.toggle-dynamic-size-mode.menu": "動態大小",
+	"action.toggle-edge-scrolling": "切換邊緣滾動",
+	"action.toggle-edge-scrolling.menu": "邊緣滾動",
 	"action.toggle-focus-mode": "切換專注模式",
 	"action.toggle-focus-mode.menu": "專注模式",
 	"action.toggle-grid": "切換網格",
 	"action.toggle-grid.menu": "顯示網格",
+	"action.toggle-lock": "鎖定\/解鎖",
+	"action.toggle-paste-at-cursor": "在游標位置切換貼上",
+	"action.toggle-paste-at-cursor.menu": "在游標位置貼上",
+	"action.toggle-reduce-motion": "切換減少活動",
+	"action.toggle-reduce-motion.menu": "減少活動",
 	"action.toggle-snap-mode": "切換始終貼齊",
 	"action.toggle-snap-mode.menu": "始終貼齊",
 	"action.toggle-tool-lock": "切換工具鎖定",
@@ -90,6 +101,8 @@
 	"action.toggle-transparent": "切換透明背景",
 	"action.toggle-transparent.context-menu": "透明",
 	"action.toggle-transparent.menu": "透明",
+	"action.toggle-wrap-mode": "在 wrap 切換選擇",
+	"action.toggle-wrap-mode.menu": "在 wrap 選擇",
 	"action.undo": "復原",
 	"action.ungroup": "取消群組",
 	"action.unlock-all": "全部解鎖",
@@ -121,7 +134,10 @@
 	"arrowheadStart-style.pipe": "管狀",
 	"arrowheadStart-style.square": "正方形",
 	"arrowheadStart-style.triangle": "三角形",
+	"assets.files.size-too-big": "檔案大小太大",
+	"assets.files.type-not-allowed": "檔案類型不允許",
 	"assets.files.upload-failed": "上傳失敗",
+	"assets.url.failed": "無法加載 URL 預覽",
 	"color-style.black": "黑色",
 	"color-style.blue": "藍色",
 	"color-style.green": "綠色",
@@ -133,19 +149,22 @@
 	"color-style.orange": "橘色",
 	"color-style.red": "紅色",
 	"color-style.violet": "紫色",
+	"color-style.white": "白色",
 	"color-style.yellow": "黃色",
 	"context-menu.arrange": "佈局",
 	"context-menu.copy-as": "複製成",
 	"context-menu.edit": "編輯",
+	"context-menu.export-all-as": "全部匯出為",
 	"context-menu.export-as": "匯出成",
 	"context-menu.move-to-page": "移至頁面",
 	"context-menu.reorder": "重新排序",
 	"context.pages.new-page": "新頁面",
+	"cursor-chat.type-to-chat": "輸入聊天內容...",
 	"dash-style.dashed": "虛線",
 	"dash-style.dotted": "虛點",
 	"dash-style.draw": "手繪",
 	"dash-style.solid": "實線",
-	"debug-panel.more": "更多",
+	"document-name-menu.copy-link": "複製連結",
 	"document.default-name": "無標題",
 	"edit-link-dialog.cancel": "取消",
 	"edit-link-dialog.clear": "清除",
@@ -154,8 +173,6 @@
 	"edit-link-dialog.save": "繼續",
 	"edit-link-dialog.title": "編輯連結",
 	"edit-link-dialog.url": "網址",
-	"edit-pages-dialog.move-down": "下移",
-	"edit-pages-dialog.move-up": "上移",
 	"embed-dialog.back": "返回",
 	"embed-dialog.cancel": "取消",
 	"embed-dialog.create": "建立",
@@ -179,6 +196,7 @@
 	"file-system.file-open-error.title": "無法開啟檔案",
 	"file-system.shared-document-file-open-error.description": "不支援從共享專案開啟檔案。",
 	"file-system.shared-document-file-open-error.title": "無法開啟檔案",
+	"fill-style.fill": "充滿",
 	"fill-style.none": "無",
 	"fill-style.pattern": "圖案",
 	"fill-style.semi": "半填滿",
@@ -192,6 +210,8 @@
 	"geo-style.arrow-left": "向左箭頭",
 	"geo-style.arrow-right": "向右箭頭",
 	"geo-style.arrow-up": "向上箭頭",
+	"geo-style.check-box": "勾選框",
+	"geo-style.cloud": "雲端",
 	"geo-style.diamond": "菱形 2",
 	"geo-style.ellipse": "橢圓形",
 	"geo-style.hexagon": "六邊形",
@@ -208,16 +228,19 @@
 	"help-menu.about": "關於",
 	"help-menu.discord": "Discord",
 	"help-menu.github": "GitHub",
+	"help-menu.import-tldr-file": "匯入檔案...",
 	"help-menu.keyboard-shortcuts": "鍵盤快捷鍵",
+	"help-menu.privacy": "隱私權政策",
+	"help-menu.terms": "服務條款",
 	"help-menu.title": "幫助和資源",
 	"help-menu.twitter": "Twitter",
-	"home-project-dialog.ok": "好的",
 	"menu.copy-as": "複製成",
 	"menu.edit": "編輯",
 	"menu.export-as": "匯出成",
 	"menu.file": "檔案",
 	"menu.language": "語言",
 	"menu.preferences": "選項",
+	"menu.theme": "主題",
 	"menu.title": "選單",
 	"menu.view": "檢視",
 	"navigation-zone.toggle-minimap": "切換小地圖",
@@ -243,12 +266,11 @@
 	"people-menu.change-color": "更改顏色",
 	"people-menu.change-name": "更改名稱",
 	"people-menu.follow": "追蹤",
+	"people-menu.following": "關注",
 	"people-menu.invite": "邀請其他人",
+	"people-menu.leading": "關注你",
 	"people-menu.title": "人員",
 	"people-menu.user": "（您）",
-	"rename-project-dialog.cancel": "取消",
-	"rename-project-dialog.rename": "重新命名",
-	"rename-project-dialog.title": "重新命名專案",
 	"share-menu.copied": "已複製連結！",
 	"share-menu.copy-link": "複製連結",
 	"share-menu.copy-link-note": "任何人透過連結都能檢視和編輯此專案。",
@@ -259,10 +281,17 @@
 	"share-menu.fork-note": "基於此快照建立新的共享專案。",
 	"share-menu.offline-note": "共享此專案將建立即時副本，並產生新網址。您可以分享網址，與其他至多三十人一起檢視和編輯副本。",
 	"share-menu.project-too-large": "抱歉，無法共享此專案，因為檔案過大。我們已在調整這件事！",
-	"share-menu.readonly-link": "唯讀",
 	"share-menu.save-note": "將此專案作為 .tldr 檔下載到您的電腦。",
 	"share-menu.share-project": "共享此專案",
+	"share-menu.snapshot-link-note": "將此專案作為唯讀快照連結進行擷取並共享。",
 	"share-menu.title": "共享",
+	"share-menu.upload-failed": "抱歉，我們目前無法上傳您的專案。請重試或讓我們知道問題是否持續存在。",
+	"sharing.confirm-leave.cancel": "取消",
+	"sharing.confirm-leave.description": "您確定要離開此共享專案嗎？您可以導覽到其 URL 返回。",
+	"sharing.confirm-leave.dont-show-again": "不再詢問",
+	"sharing.confirm-leave.leave": "離開",
+	"sharing.confirm-leave.title": "離開當前專案？",
+	"shortcuts-dialog.collaboration": "合作",
 	"shortcuts-dialog.edit": "編輯",
 	"shortcuts-dialog.file": "檔案",
 	"shortcuts-dialog.preferences": "選項",
@@ -277,7 +306,6 @@
 	"spline-style.cubic": "立方體",
 	"spline-style.line": "直線",
 	"status.offline": "斷線",
-	"status.online": "已連線",
 	"style-panel.align": "對齊",
 	"style-panel.arrowhead-end": "末端",
 	"style-panel.arrowhead-start": "前端",
@@ -287,26 +315,31 @@
 	"style-panel.fill": "填充",
 	"style-panel.font": "字型",
 	"style-panel.geo": "形狀",
+	"style-panel.label-align": "標籤對齊",
 	"style-panel.mixed": "混合",
 	"style-panel.opacity": "不透明度",
 	"style-panel.position": "位置",
 	"style-panel.size": "大小",
 	"style-panel.spline": "曲線",
 	"style-panel.title": "樣式",
+	"style-panel.vertical-align": "垂直對齊",
+	"theme.dark": "黑暗",
+	"theme.light": "明亮",
+	"theme.system": "系統",
 	"toast.close": "關閉",
 	"toast.error.copy-fail.desc": "圖片複製失敗",
 	"toast.error.copy-fail.title": "複製失敗",
 	"toast.error.export-fail.desc": "圖片匯出失敗",
 	"toast.error.export-fail.title": "匯出失敗",
-	"tool-panel.drawing": "繪圖",
 	"tool-panel.more": "更多",
-	"tool-panel.shapes": "形狀",
 	"tool.arrow": "箭頭",
 	"tool.arrow-down": "向下箭頭",
 	"tool.arrow-left": "向左箭頭",
 	"tool.arrow-right": "向右箭頭",
 	"tool.arrow-up": "向上箭頭",
 	"tool.asset": "資源",
+	"tool.check-box": "勾選框",
+	"tool.cloud": "雲端",
 	"tool.diamond": "菱形 2",
 	"tool.draw": "手繪",
 	"tool.ellipse": "橢圓形",
@@ -315,11 +348,14 @@
 	"tool.frame": "框架",
 	"tool.hand": "抓取",
 	"tool.hexagon": "六邊形",
+	"tool.highlight": "醒目提醒",
+	"tool.laser": "雷射",
 	"tool.line": "直線",
 	"tool.note": "便利貼",
 	"tool.octagon": "八邊形",
 	"tool.oval": "卵形",
 	"tool.pentagon": "五邊形",
+	"tool.pointer-down": "指針向下",
 	"tool.rectangle": "矩形",
 	"tool.rhombus": "菱形",
 	"tool.select": "選取",

package/license.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Eric Mika
+Copyright (c) 2024-2025 Eric Mika
 
 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/package.json

@@ -1,65 +1,62 @@
 {
   "name": "@kitschpatrol/tldraw-cli",
-  "version": "4.6.28",
-  "type": "module",
-  "description": "A CLI tool for exporting tldraw sketch URLs and local .tldr files to a variety of image formats.",
-  "repository": "github:kitschpatrol/tldraw-cli",
+  "version": "4.6.30",
+  "description": "A CLI tool and TypeScript library for exporting tldraw sketches to PNG or SVG images.",
+  "keywords": [
+    "tldraw",
+    "tldr",
+    "cli",
+    "diagram",
+    "drawing",
+    "sketch",
+    "export",
+    "npm-package"
+  ],
   "homepage": "https://github.com/kitschpatrol/tldraw-cli",
   "bugs": "https://github.com/kitschpatrol/tldraw-cli/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/github:kitschpatrol/tldraw-cli"
+  },
+  "license": "MIT",
   "author": {
     "name": "Eric Mika",
     "email": "eric@ericmika.com",
     "url": "https://ericmika.com"
   },
-  "license": "MIT",
-  "engines": {
-    "node": ">=18.0.0",
-    "pnpm": ">=9.0.0"
-  },
-  "bin": {
-    "tldraw-cli": "bin/cli.js",
-    "tldraw": "bin/cli.js"
-  },
+  "type": "module",
   "main": "./dist/lib/index.js",
   "module": "./dist/lib/index.js",
   "types": "./dist/lib/index.d.ts",
+  "bin": {
+    "tldraw": "bin/cli.js",
+    "tldraw-cli": "bin/cli.js"
+  },
   "files": [
     "bin/*",
     "dist/*"
   ],
-  "keywords": [
-    "tldraw",
-    "tldr",
-    "cli",
-    "diagram",
-    "drawing",
-    "sketch",
-    "export",
-    "npm-package"
-  ],
   "dependencies": {
     "@fontsource/inter": "^5.1.1",
     "express": "^4.21.2",
-    "puppeteer": "^23.11.1",
+    "puppeteer": "^24.2.0",
     "uint8array-extras": "^1.4.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^4.7.12",
+    "@kitschpatrol/shared-config": "^5.0.5",
     "@sindresorhus/slugify": "^2.2.1",
-    "@tldraw/assets": "3.7.2",
+    "@tldraw/assets": "3.8.0-canary.3f23e0d4c913",
     "@types/express": "^4.17.21",
     "@types/node": "18.0.0",
     "@types/react": "^18.3.18",
     "@types/react-dom": "^18.3.5",
     "@types/yargs": "^17.0.33",
-    "@vitejs/plugin-react-swc": "^3.7.2",
-    "bumpp": "^9.10.1",
+    "@vitejs/plugin-react-swc": "^3.8.0",
+    "bumpp": "^10.0.2",
     "chalk": "^5.4.1",
     "cheerio": "^1.0.0",
-    "esbuild": "^0.24.2",
-    "eslint-plugin-react-hooks": "^4.6.2",
-    "eslint-plugin-react-refresh": "^0.4.18",
+    "esbuild": "^0.25.0",
     "get-port": "^7.1.0",
     "nanoid": "^5.0.9",
     "open": "^10.1.0",
@@ -72,26 +69,39 @@
     "sharp": "^0.33.5",
     "sharp-phash": "^2.2.0",
     "strip-ansi": "^7.1.0",
-    "tldraw": "3.7.2",
+    "tldraw": "3.8.0-canary.3f23e0d4c913",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3",
     "untildify": "^5.0.0",
-    "vite": "^5.4.13",
-    "vitest": "^2.1.8"
+    "vite": "^6.1.0",
+    "vitest": "^3.0.5"
+  },
+  "engines": {
+    "node": ">=18.0.0",
+    "pnpm": ">=10.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
+  "mdat": {
+    "$import": "node_modules/@kitschpatrol/mdat-config/dist/index.js"
+  },
+  "prettier": "@kitschpatrol/prettier-config",
+  "remarkConfig": {
+    "plugins": [
+      "@kitschpatrol/remark-config"
+    ]
+  },
   "scripts": {
     "build": "pnpm run build:tldraw && pnpm run build:lib && pnpm run build:cli",
-    "build:cli": "tsx ./scripts/build-cli.ts",
+    "build:cli": "tsx ./scripts/build-cli.ts && tsc -p tsconfig.build.json",
     "build:lib": "tsx ./scripts/build-lib.ts && tsc -p tsconfig.lib.json",
     "build:tldraw": "pnpm run tldraw:copy-assets && vite build",
     "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
     "dev": "pnpm run dev:tldraw",
     "dev:tldraw": "pnpm run tldraw:copy-assets && vite",
-    "fix": "shared-config --fix",
-    "lint": "shared-config --lint",
+    "fix": "kpi fix",
+    "lint": "kpi lint",
     "preview": "pnpm run preview:tldraw",
     "preview:tldraw": "vite preview",
     "release": "bumpp --commit 'Release: %s' && pnpm run build && pnpm publish --otp $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')",

package/readme.md

@@ -15,10 +15,14 @@
 
 <!-- description -->
 
-**A CLI tool for exporting tldraw sketch URLs and local .tldr files to a variety of image formats.**
+**A CLI tool and TypeScript library for exporting tldraw sketches to PNG or SVG images.**
 
 <!-- /description -->
 
+> [!IMPORTANT]
+>
+> The tldraw project and website are rapidly evolving, and time is not always available to keep `tldraw-cli`'s abstractions up to date, particularly for commands that interface directly with sketch URLs. Working with local `.tldr` files should be relatively stable, but caveat emptor.
+
 <!-- table-of-contents { maxDepth: 2 } -->
 
 ## Table of contents
@@ -115,22 +119,22 @@ tldraw export <files-or-urls..>
 | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
 | `files-or-urls`     | The tldraw sketch to export. May be one or more paths to local `.tldr` files, or tldraw\.com sketch URLs. Accepts a mix of both file paths and URLs, and supports glob matching via your shell. Prints the absolute path(s) to the exported image(s) to `stdout`. _(Required.)_ | `array` |
 
-| Option                  | Description                                                                                                                                                                                                                                                          | Type                              | Default                                   |
-| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----------------------------------------- |
-| `--format`<br>`-f`      | Output image format.                                                                                                                                                                                                                                                 | `"png"` `"svg"` `"json"` `"tldr"` | `"svg"`                                   |
-| `--output`<br>`-o`      | Output image directory.                                                                                                                                                                                                                                              | `string`                          | `"./"`                                    |
-| `--name`<br>`-n`        | Output image name (without extension).                                                                                                                                                                                                                               | `string`                          | The original file name or URL id is used. |
-| `--frames`              | Export each sketch "frame" as a separate image. Pass one or more frame names or IDs to export specific frames, or pass the flag without the arguments to export all frames. By default, the entire first page is exported with all frames.                           | `array`                           | `false`                                   |
-| `--pages`               | Export each sketch "page" as a separate image. Pass one or more page names or IDs to export specific page, or pass one or more page index numbers (from 0), or pass the flag without the arguments to export all pages. By default, only the first page is exported. | `array`                           | `false`                                   |
-| `--transparent`<br>`-t` | Export an image with a transparent background.                                                                                                                                                                                                                       | `boolean`                         | `false`                                   |
-| `--dark`<br>`-d`        | Export a dark theme version of the image.                                                                                                                                                                                                                            | `boolean`                         | `false`                                   |
-| `--padding`             | Set a specific padding amount around the exported image.                                                                                                                                                                                                             | `number`                          | `32`                                      |
-| `--scale`               | Set a sampling factor for raster image exports.                                                                                                                                                                                                                      | `number`                          | `1`                                       |
-| `--strip-style`         | Remove `<style>` elements from SVG output, useful to lighten the load of embedded fonts if you intend to provide your own stylesheets. Applies to SVG output only.                                                                                                   | `boolean`                         | `false`                                   |
-| `--print`<br>`-p`       | Print the exported image(s) to stdout instead of saving to a file. Incompatible with `--output`, and disregards `--name`. PNGs are printed as base64-encoded strings.                                                                                                | `boolean`                         | `false`                                   |
-| `--verbose`             | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to `stderr` for ease of redirection.                                                                                                                                      | `boolean`                         | `false`                                   |
-| `--help`<br>`-h`        | Show help                                                                                                                                                                                                                                                            | `boolean`                         |                                           |
-| `--version`<br>`-v`     | Show version number                                                                                                                                                                                                                                                  | `boolean`                         |                                           |
+| Option                  | Description                                                                                                                                                                                                                                                          | Type                     | Default                                   |
+| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ----------------------------------------- |
+| `--format`<br>`-f`      | Output image format.                                                                                                                                                                                                                                                 | `"png"` `"svg"` `"tldr"` | `"svg"`                                   |
+| `--output`<br>`-o`      | Output image directory.                                                                                                                                                                                                                                              | `string`                 | `"./"`                                    |
+| `--name`<br>`-n`        | Output image name (without extension).                                                                                                                                                                                                                               | `string`                 | The original file name or URL id is used. |
+| `--frames`              | Export each sketch "frame" as a separate image. Pass one or more frame names or IDs to export specific frames, or pass the flag without the arguments to export all frames. By default, the entire first page is exported with all frames.                           | `array`                  | `false`                                   |
+| `--pages`               | Export each sketch "page" as a separate image. Pass one or more page names or IDs to export specific page, or pass one or more page index numbers (from 0), or pass the flag without the arguments to export all pages. By default, only the first page is exported. | `array`                  | `false`                                   |
+| `--transparent`<br>`-t` | Export an image with a transparent background.                                                                                                                                                                                                                       | `boolean`                | `false`                                   |
+| `--dark`<br>`-d`        | Export a dark theme version of the image.                                                                                                                                                                                                                            | `boolean`                | `false`                                   |
+| `--padding`             | Set a specific padding amount around the exported image.                                                                                                                                                                                                             | `number`                 | `32`                                      |
+| `--scale`               | Set a sampling factor for raster image exports.                                                                                                                                                                                                                      | `number`                 | `1`                                       |
+| `--strip-style`         | Remove `<style>` elements from SVG output, useful to lighten the load of embedded fonts if you intend to provide your own stylesheets. Applies to SVG output only.                                                                                                   | `boolean`                | `false`                                   |
+| `--print`<br>`-p`       | Print the exported image(s) to stdout instead of saving to a file. Incompatible with `--output`, and disregards `--name`. PNGs are printed as base64-encoded strings.                                                                                                | `boolean`                | `false`                                   |
+| `--verbose`             | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to `stderr` for ease of redirection.                                                                                                                                      | `boolean`                | `false`                                   |
+| `--help`<br>`-h`        | Show help                                                                                                                                                                                                                                                            | `boolean`                |                                           |
+| `--version`<br>`-v`     | Show version number                                                                                                                                                                                                                                                  | `boolean`                |                                           |
 
 #### Subcommand: `tldraw open`
 
@@ -299,24 +303,25 @@ The library exports two async function, `tldrawToImage`, and `tldrawOpen`.
 
 This mirrors the `tldraw export` CLI command.
 
-It takes an options argument mirroring the arguments available via the command line. The same default values apply:
+It takes an options argument mirroring the arguments available via the command line. Here's the full type signature of the function. The same default values from the CLI apply:
 
 ```ts
- async function tldrawToImage(
+type TldrawToImageFn = (
   tldrPathOrUrl: string,
-  {
+  options: {
     dark?: boolean
-    format?: 'svg' | 'png' | 'json' | 'tldr'
+    format?: 'png' | 'svg' | 'tldr'
     frames?: boolean | string[]
     name?: string
     output?: string
     padding?: number
-    pages?: boolean | string[] | number[]
+    pages?: boolean | number[] | string[]
     print?: boolean
     scale?: number
     stripStyle?: boolean
     transparent?: boolean
- }): Promise<string[]>;
+  },
+) => Promise<string[]>
 ```
 
 The function exports the image in the requested format and returns an array of the output image(s) or file(s).
@@ -326,7 +331,7 @@ Generally, a single file is returned — but the `string[]` return type also acc
 Assuming you've installed `@kitschpatrol/tldraw-cli` locally in your project, it may be used as follows:
 
 ```ts
-// tldraw-cli-api-test.ts
+// Tldraw-cli-api-test.ts
 
 import { tldrawToImage } from '@kitschpatrol/tldraw-cli'
 
@@ -347,8 +352,8 @@ console.log(`Wrote frames to: "${framePathsArray}"`)
 
 // Convert a specific frame from a tldraw.com URL to a PNG
 await tldrawToImage('https://www.tldraw.com/s/v2_c_FI5RYWbdpAtjsy4OIKrKw', {
-  frames: ['Frame 3'],
   format: 'png',
+  frames: ['Frame 3'],
 })
 
 // You can also use the frame id instead of the frame name, if you're into that sort of thing
@@ -361,15 +366,15 @@ await tldrawToImage('https://www.tldraw.com/s/v2_c_FI5RYWbdpAtjsy4OIKrKw', {
 By default, the Node API only logs warnings and errors. If you want to log the equivalent of the `--verbose` flag from the command line version, then you can set a flag on a logging object exported from the library:
 
 ```ts
-// tldraw-cli-api-verbose-test.ts
+// Tldraw-cli-api-verbose-test.ts
 
-import { tldrawToImage, log } from '@kitschpatrol/tldraw-cli'
+import { log, tldrawToImage } from '@kitschpatrol/tldraw-cli'
 
-// this will log extra info
+// This will log extra info
 log.verbose = true
 await tldrawToImage('https://www.tldraw.com/s/v2_c_JsxJk8dag6QsrqExukis4')
 
-// now we'll only log errors and warnings
+// Now we'll only log errors and warnings
 log.verbose = false
 await tldrawToImage('https://www.tldraw.com/s/v2_c_JsxJk8dag6QsrqExukis4')
 ```
@@ -378,8 +383,8 @@ await tldrawToImage('https://www.tldraw.com/s/v2_c_JsxJk8dag6QsrqExukis4')
 
 Mirrors the `tldraw open` CLI command.
 
-> [!CAUTION]
-> Passing a local .tldr file with the `location: 'remote'` option will upload and share your sketch on tldraw\.com.
+> [!IMPORTANT]
+> Due to recent tldraw.com requirements to login before sharing a sketch, opening a _local_ .tldr file with the `location: 'remote'` option is no longer supported.
 
 ```tsx
 async function tldrawOpen(
@@ -421,17 +426,6 @@ await tldrawOpen('./sketch.tldr', {
 })
 ```
 
-#### `tldrawToShareUrl`
-
-```ts
-async function tldrawToShareUrl(tldrPathOrUrl: string): Promise<string>
-```
-
-Returns a live "share" url for a given local or remote tldraw sketch URL.
-
-> [!CAUTION]
-> Passing a local .tldr file to this function will upload and share your local file to tldraw\.com.
-
 ### Common workflows
 
 If you're working with .tldr files and `tldraw-cli` locally, it's often convenient to automatically export image files from your sketches whenever they've changed.

package/dist/lib/tldraw-to-share-url.d.ts

@@ -1 +0,0 @@
-export declare function tldrawToShareUrl(tldrPathOrUrl: string): Promise<string>;