@kitschpatrol/tldraw-cli 5.0.12 → 5.0.13

package/dist/lib/index.d.ts

@@ -1,3 +1,49 @@
-export { tldrawOpen, type TldrawOpenOptions, type TldrawOpenResult } from './tldraw-open.js';
-export { type TldrawFormat, tldrawToImage, type TldrawToImageOptions } from './tldraw-to-image.js';
-export { default as log } from './utilities/log.js';
+import { ChildProcess } from "node:child_process";
+
+//#region src/lib/tldraw-open.d.ts
+type TldrawOpenOptions = {
+  location: 'local' | 'remote';
+};
+type TldrawOpenResult = {
+  browserExitPromise: Promise<ChildProcess>;
+  openedSketchUrl: string;
+};
+/**
+ * Opens a tldraw file or URL in a browser.
+ */
+declare function tldrawOpen(tldrPathOrUrl?: string, options?: Partial<TldrawOpenOptions>): Promise<TldrawOpenResult>;
+//#endregion
+//#region src/lib/tldraw-to-image.d.ts
+type TldrawFormat = 'png' | 'svg' | 'tldr';
+type TldrawToImageOptions = {
+  dark?: boolean;
+  format?: TldrawFormat;
+  frames?: boolean | string[];
+  name?: string;
+  output?: string;
+  padding?: number;
+  pages?: boolean | number[] | string[];
+  print?: boolean;
+  scale?: number;
+  stripStyle?: boolean;
+  transparent?: boolean;
+};
+/**
+ * Downloads a tldraw file or URL as an image.
+ */
+declare function tldrawToImage(tldrPathOrUrl: string, options?: TldrawToImageOptions): Promise<string[]>;
+//#endregion
+//#region src/lib/utilities/log.d.ts
+declare const log: {
+  verbose: boolean;
+  log(...data: unknown[]): void;
+  logPrefixed(prefix: string, ...data: unknown[]): void;
+  info(...data: unknown[]): void;
+  infoPrefixed(prefix: string, ...data: unknown[]): void;
+  warn(...data: unknown[]): void;
+  warnPrefixed(prefix: string, ...data: unknown[]): void;
+  error(...data: unknown[]): void;
+  errorPrefixed(prefix: string, ...data: unknown[]): void;
+};
+//#endregion
+export { type TldrawFormat, type TldrawOpenOptions, type TldrawOpenResult, type TldrawToImageOptions, log, tldrawOpen, tldrawToImage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/tldraw-cli",
-  "version": "5.0.12",
+  "version": "5.0.13",
   "description": "A CLI tool and TypeScript library for exporting tldraw sketches to PNG or SVG images.",
   "keywords": [
     "tldraw",
@@ -62,6 +62,8 @@
     "yargs": "^18.0.0"
   },
   "devDependencies": {
+    "@arethetypeswrong/core": "^0.18.2",
+    "@blazediff/vitest": "^1.1.11",
     "@fontsource/inter": "^5.2.8",
     "@kitschpatrol/shared-config": "^6.0.3",
     "@tldraw/assets": "^4.5.3",
@@ -74,12 +76,11 @@
     "mdat-plugin-cli-help": "^1.0.7",
     "node-addon-api": "^8.6.0",
     "node-gyp": "^12.2.0",
+    "publint": "^0.3.18",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
     "rolldown": "1.0.0-rc.10",
     "safe-stable-stringify": "^2.5.0",
-    "sharp": "^0.34.5",
-    "sharp-phash": "^2.2.0",
     "strip-ansi": "^7.2.0",
     "tldraw": "^4.5.3",
     "tsdown": "^0.21.4",
@@ -96,7 +97,7 @@
   },
   "scripts": {
     "build": "pnpm run build:tldraw && pnpm run build:src",
-    "build:src": "tsdown && tsc -p tsconfig.build.json",
+    "build:src": "tsdown",
     "build:tldraw": "pnpm run tldraw:copy-assets && vite build",
     "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
     "dev": "pnpm run dev:tldraw",

package/readme.md

@@ -48,6 +48,8 @@ A CLI app to automate conversion and export of [tldraw](https://tldraw.dev) URLs
 
 This could be useful in the context of a content publishing pipeline where you want to use a `.tldr` file (perhaps under version control) as the "source of truth" for assets to be embedded elsewhere, and you don't want to manage the export of that diagram manually.
 
+_Please note that this tool, which is all about image export, should not be confused with the official [tldraw project scaffolding CLI](https://www.npmjs.com/package/create-tldraw) which is all about creating new tldraw-powered projects._
+
 _For `.tldr` file import support in Vite projects, please see [@kitschpatrol/vite-plugin-tldraw](https://github.com/kitschpatrol/vite-plugin-tldraw)._
 
 ## Installation
@@ -374,7 +376,7 @@ await tldrawToImage('https://www.tldraw.com/s/v2_c_JsxJk8dag6QsrqExukis4')
 Mirrors the `tldraw open` CLI command.
 
 > [!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.
+> 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(
@@ -486,6 +488,7 @@ On GitHub:
 - [AWS Lambda-based approach](https://gist.github.com/steveruizok/c30fc99b9b3d95a14c82c59bdcc69201)
 - [Added exporting of shapes and pages as images](https://github.com/tldraw/tldraw/pull/468)
 - [\[feature\] Copy/Share as PNG](https://github.com/tldraw/tldraw-v1/issues/361)
+- [Create tldraw CLI tools](https://github.com/tldraw/tldraw/issues/7539)
 
 On Discord:
 
@@ -494,7 +497,7 @@ On Discord:
 
 ## Implementation notes
 
-This tool is not a part of the official tldraw project.
+This tool is _not_ a part of the official tldraw project.
 
 Due to the architecture of tldraw, export depends on functionality provided by a web browser. So, behind the scenes, this app serves a local instance of tldraw, then loads a `.tldr` and invokes the export download via the [Puppeteer](https://pptr.dev) headless browser automation tool.
 

package/dist/lib/inline/get-image.d.ts

@@ -1,13 +0,0 @@
-import type { Editor } from 'tldraw';
-declare global {
-    interface Window {
-        editor: Editor;
-        getImage: (options: {
-            background?: boolean;
-            darkMode?: boolean;
-            format: 'png' | 'svg';
-            padding?: number;
-            scale?: number;
-        }) => Promise<string>;
-    }
-}

package/dist/lib/inline/get-tldr.d.ts

@@ -1,7 +0,0 @@
-import type { Editor } from 'tldraw';
-declare global {
-    interface Window {
-        editor: Editor;
-        getTldr: () => Promise<string>;
-    }
-}

package/dist/lib/local-tldraw-server.d.ts

@@ -1,10 +0,0 @@
-export default class LocalTldrawServer {
-    private readonly tldrData?;
-    get href(): string;
-    private port?;
-    private server?;
-    constructor(tldrData?: string | undefined);
-    close(): void;
-    start(): Promise<void>;
-    private waitForServer;
-}

package/dist/lib/tldraw-controller.d.ts

@@ -1,22 +0,0 @@
-import type { TldrawToImageOptions } from './tldraw-to-image.js';
-export default class TldrawController {
-    private readonly href;
-    private browser?;
-    private isEmpty?;
-    private page?;
-    private get isLocal();
-    constructor(href: string);
-    close(): Promise<void>;
-    download(options: TldrawToImageOptions): Promise<string[]>;
-    start(): Promise<void>;
-    private getCurrentPage;
-    private getDownloadPlans;
-    private getPageFrames;
-    private getPages;
-    private getSketchStructure;
-    private setCurrentPage;
-    private stripStyleElement;
-    private stripUndefined;
-    private validateFrames;
-    private validatePages;
-}

package/dist/lib/tldraw-open.d.ts

@@ -1,12 +0,0 @@
-import type { ChildProcess } from 'node:child_process';
-export type TldrawOpenOptions = {
-    location: 'local' | 'remote';
-};
-export type TldrawOpenResult = {
-    browserExitPromise: Promise<ChildProcess>;
-    openedSketchUrl: string;
-};
-/**
- * Opens a tldraw file or URL in a browser.
- */
-export declare function tldrawOpen(tldrPathOrUrl?: string, options?: Partial<TldrawOpenOptions>): Promise<TldrawOpenResult>;

package/dist/lib/tldraw-to-image.d.ts

@@ -1,18 +0,0 @@
-export type TldrawFormat = 'png' | 'svg' | 'tldr';
-export type TldrawToImageOptions = {
-    dark?: boolean;
-    format?: TldrawFormat;
-    frames?: boolean | string[];
-    name?: string;
-    output?: string;
-    padding?: number;
-    pages?: boolean | number[] | string[];
-    print?: boolean;
-    scale?: number;
-    stripStyle?: boolean;
-    transparent?: boolean;
-};
-/**
- * Downloads a tldraw file or URL as an image.
- */
-export declare function tldrawToImage(tldrPathOrUrl: string, options?: TldrawToImageOptions): Promise<string[]>;

package/dist/lib/utilities/log.d.ts

@@ -1,12 +0,0 @@
-declare const log: {
-    verbose: boolean;
-    log(...data: unknown[]): void;
-    logPrefixed(prefix: string, ...data: unknown[]): void;
-    info(...data: unknown[]): void;
-    infoPrefixed(prefix: string, ...data: unknown[]): void;
-    warn(...data: unknown[]): void;
-    warnPrefixed(prefix: string, ...data: unknown[]): void;
-    error(...data: unknown[]): void;
-    errorPrefixed(prefix: string, ...data: unknown[]): void;
-};
-export default log;

package/dist/lib/validation.d.ts

@@ -1,8 +0,0 @@
-/**
- * Validates a path or URL.
- */
-export declare function validatePathOrUrl(pathOrUrl: string, options?: {
-    requireFileExistence?: boolean;
-    validFileExtensions?: string[];
-    validHostnames?: string[];
-}): string | URL;