@kitschpatrol/tldraw-cli 1.0.1 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kitschpatrol/tldraw-cli",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "module",
   "description": "A tiny little CLI tool for converting tldraw .tldr files into svg or png images.",
   "repository": {
@@ -25,6 +25,12 @@
   "bin": {
     "tldraw-cli": "bin/cli.js"
   },
+  "exports": {
+    ".": {
+      "import": "./dist/lib/index.js",
+      "types": "./dist/lib/index.d.ts"
+    }
+  },
   "files": [
     "bin/*",
     "dist/*"
@@ -69,8 +75,9 @@
     "access": "public"
   },
   "scripts": {
-    "build": "pnpm run build:tldraw && pnpm run build:cli",
+    "build": "pnpm run build:tldraw && pnpm run build:lib && pnpm run build:cli",
     "build:cli": "tsx ./scripts/build-cli.ts",
+    "build:lib": "tsx ./scripts/build-lib.ts && tsc -p tsconfig.lib.json",
     "build:tldraw": "pnpm run tldraw-copy-assets && vite build",
     "dev": "pnpm run tldraw-copy-assets && vite",
     "dev-cli": "pnpm run build:tldraw && tsx ./src/cli/tldraw-cli.ts ./test-assets/box.tldr --verbose",

package/readme.md

@@ -30,7 +30,7 @@ npm --install --save-dev @kitschpatrol/tldraw-cli
 npm --install --global @kitschpatrol/tldraw-cli
 ```
 
-## Usage
+## Command line usage
 
 ### Invocation
 
@@ -48,6 +48,33 @@ tldraw-cli file {options}
 | `-v`, `--version` | Show version number                         |         |
 | `--verbose`       | Enable verbose output                       | `false` |
 
+## API usage
+
+The conversion tool's functionality is also exposed as a module for use in TypeScript or JavaScript Node projects.
+
+The library exports a single async function, `tldrToImage` with the following type signature, mirroring the arguments available via the command line. The same default values apply:
+
+```ts
+ tldrToImage(tldrPath: string, format?: ExportFormat, destination?: string, verbose?: boolean): Promise<string>;
+```
+
+The function exports the image in the requested format returns the full path to the output image.
+
+Assuming you've installed `@kitschpatrol/tldraw-cli` locally in your project, it may be used as follows:
+
+```ts
+// tldr-cli-api-test.ts
+
+import { tldrToImage } from '@kitschpatrol/tldraw-cli'
+
+const imagePath = await tldrToImage('./some-file.tldr', 'png', './', false)
+
+// Image saved to: "[...]/some-file.png"
+console.log(`Image saved to: "${imagePath}"`)
+```
+
+_Note that the library provided is ESM only, and requires a Node-compatible runtime. TypeScript types are included._
+
 ## Examples
 
 ### Basic conversion