buttonrig 1.0.0

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "buttonrig",
+  "version": "1.0.0",
+  "description": "API for your plugin to work with the Button Rig App.",
+  "type": "module",
+  "main": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "scripts": {
+    "build": "npx tsc"
+  },
+  "author": "Button Rig",
+  "license": "Apache 2.0",
+  "devDependencies": {
+    "@types/node": "^24.9.1",
+    "typescript": "^5.9.3"
+  }
+}

package/src/main.ts

@@ -0,0 +1,86 @@
+import {
+  newMessage,
+  type RxPayload,
+  type TxPayload,
+  ErrorPayload,
+  newSaveHandlerArgs,
+  RxLoadHandlerArgsPayload,
+  RxFilePickPayload,
+  RxFolderPickPayload,
+  RxFilesPickPayload,
+} from "./types.js";
+
+export function saveHandlerArgs(args: string[] | ErrorPayload) {
+  let txPayload: TxPayload;
+  if (args instanceof ErrorPayload) {
+    txPayload = args;
+  } else {
+    txPayload = newSaveHandlerArgs(args);
+  }
+  postMessage(txPayload);
+}
+
+export function loadHandlerArgs(fn: (handlerArgs: string[]) => void) {
+  addEventListener("loadHandlerArgs", (payload) => {
+    let loadHandlerArgsPayload = payload as RxLoadHandlerArgsPayload;
+    fn(loadHandlerArgsPayload.loadHandlerArgs.handlerArgs);
+  });
+  postMessage("readyToReceive");
+}
+
+export function pickFile(extensions: string[]): Promise<string | null> {
+  return new Promise((resolve) => {
+    postMessage({
+      pickFile: {
+        extensions,
+      },
+    });
+    addEventListener("filePick", (payload) => {
+      let filePickPayload = payload as RxFilePickPayload;
+      resolve(filePickPayload.filePick.file);
+    });
+  });
+}
+
+export function pickFiles(extensions: string[]): Promise<string[]> {
+  return new Promise((resolve) => {
+    postMessage({
+      pickFiles: {
+        extensions,
+      },
+    });
+    addEventListener("filesPick", (payload) => {
+      let filesPickPayload = payload as RxFilesPickPayload;
+      resolve(filesPickPayload.filesPick.files);
+    });
+  });
+}
+
+export function pickFolder(): Promise<string | null> {
+  return new Promise((resolve) => {
+    postMessage("pickFolder");
+    addEventListener("folderPick", (payload) => {
+      let folderPickPayload = payload as RxFolderPickPayload;
+      resolve(folderPickPayload.folderPick.folder);
+    });
+  });
+}
+
+function addEventListener(eventType: string, fn: (payload: RxPayload) => void) {
+  window.addEventListener("message", (event) => {
+    if (
+      !(
+        event.data.event == eventType ||
+        Object.keys(event.data.event)[0] == eventType
+      )
+    ) {
+      return;
+    }
+    fn(event.data.event as RxPayload);
+  });
+}
+
+function postMessage(payload: TxPayload) {
+  let message = newMessage(payload);
+  window.parent.postMessage(message, "*");
+}

package/src/types.ts

@@ -0,0 +1,117 @@
+export class ErrorPayload {
+  error: {
+    message: string | null;
+  };
+
+  constructor(message: string | null) {
+    this.error = {
+      message,
+    };
+  }
+}
+
+export interface Message {
+  buttonPluginActionId: string;
+  payload: TxPayload;
+}
+
+export function newMessage(payload: TxPayload): Message {
+  return {
+    buttonPluginActionId: window.name,
+    payload: payload,
+  };
+}
+
+export type TxPayload =
+  | TxPickFilePayload
+  | TxPickFilesPayload
+  | TxPickFolder
+  | TxReadyToReceive
+  | TxSaveHandlerArgsPayload
+  | ErrorPayload;
+
+export interface TxPickFilePayload {
+  pickFile: {
+    extensions: string[];
+  };
+}
+
+export interface TxPickFilesPayload {
+  pickFiles: {
+    extensions: string[];
+  }
+}
+
+export function newSaveHandlerArgs(
+  handlerArgs: string[]
+): TxSaveHandlerArgsPayload {
+  return {
+    saveHandlerArgs: {
+      handlerArgs,
+    },
+  };
+}
+
+export type RxPayload =
+  | RxFilePickPayload
+  | RxFilesPickPayload
+  | RxFolderPickPayload
+  | RxLoadHandlerArgsPayload
+  | null;
+
+export class RxLoadHandlerArgsPayload {
+  loadHandlerArgs: {
+    handlerArgs: string[];
+  };
+
+  constructor(handlerArgs: string[]) {
+    this.loadHandlerArgs = {
+      handlerArgs,
+    };
+  }
+}
+
+export class RxFilePickPayload {
+  filePick: {
+    file: string | null;
+  };
+
+  constructor() {
+    this.filePick = {
+      file: null,
+    };
+  }
+}
+
+export class RxFilesPickPayload {
+  filesPick: {
+    files: string[];
+  };
+
+  constructor() {
+    this.filesPick = {
+      files: [],
+    };
+  }
+}
+
+export class RxFolderPickPayload {
+  folderPick: {
+    folder: string | null;
+  };
+
+  constructor() {
+    this.folderPick = {
+      folder: null,
+    };
+  }
+}
+
+export interface TxSaveHandlerArgsPayload {
+  saveHandlerArgs: {
+    handlerArgs: string[];
+  };
+}
+
+export type TxReadyToReceive = "readyToReceive";
+export type TxPickFolder = "pickFolder";

package/tsconfig.json

@@ -0,0 +1,43 @@
+{
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  }
+}