miro-export 1.1.0 → 1.1.1

package/README.md

@@ -12,6 +12,17 @@ If accessing a private board, a personal token is required. To get a token, log
 
 ## CLI
 
+You can use this tool as a command-line tool.
+
+### Prerequisites
+
+- [Node.js >=22](https://nodejs.org/en/download)
+- npm (built-in to Node.js), yarn, or pnpm
+
+### Installation
+
+The CLI can be ran using [npx](https://docs.npmjs.com/cli/v8/commands/npx) with `npx miro-export [options]` (see options below). Alternatively, it's possible to install the package to the global scope with, for example, `npm i -g miro-export`.
+
 ### Usage
 
 ```
@@ -30,6 +41,9 @@ Options:
 # export "Frame 2" to the file "My Frame 2.svg"
 miro-export -t XYZ -b uMoVLkx8gIc= -f "Frame 2" -o "My Frame 2.svg"
 
+# using npx
+npx miro-export -t XYZ -b uMoVLkx8gIc= -f "Frame 2" -o "My Frame 2.svg"
+
 # export entire board to stdout
 miro-export -t XYZ -b uMoVLkx8gIc=
 
@@ -86,13 +100,13 @@ await using miroBoard = new MiroBoard({
 });
 
 // get all board objects of type frame and with title "Frame 1"
-const framesWithTitleFrame1 = miroBoard.getBoardObjects(
+const framesWithTitleFrame1 = await miroBoard.getBoardObjects(
   { type: "frame" }, // required (but empty object is OK too), limited field support
   { title: "Frame 1" } // optional additional filters
 );
 
 // get SVG of the first frame found above
-const svgOfFrame1 = miroBoard.getSvg([framesWithTitleFrame1[0].id]);
+const svgOfFrame1 = await miroBoard.getSvg([framesWithTitleFrame1[0].id]);
 
 // if you can't use "await using" for disposal, you can also dispose manually:
 // await miroBoard.dispose()

package/build/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
     if (value !== null && value !== void 0) {
         if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");

package/build/index.js

@@ -1,4 +1,3 @@
-#!/usr/bin/env node
 import puppeteer, { Browser, Page } from "puppeteer";
 export class MiroBoard {
     context = Promise.withResolvers();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "miro-export",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "author": "jolle <npm-contact@jolle.io>",
   "license": "MIT",
   "type": "module",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "lint": "eslint src/*.ts && prettier -c src/*.ts",
-    "build": "tsc && echo \"#!/usr/bin/env node\n$(cat ./build/index.js)\" > ./build/index.js",
+    "build": "tsc && echo \"#!/usr/bin/env node\n$(cat ./build/cli.js)\" > ./build/cli.js",
     "test": "npm run test:board-object-types && npm run test:api",
     "test:board-object-types": "tsx tests/board-object-types.ts",
     "test:api": "tsx tests/api.test.ts"