@opentabs-dev/opentabs-plugin-ynab 0.0.76 → 0.0.77

package/README.md

@@ -1,159 +1,80 @@
-# opentabs-plugin-ynab
+# YNAB
 
-OpenTabs plugin for YNAB (You Need A Budget)
+OpenTabs plugin for YNAB (You Need A Budget) — gives AI agents access to YNAB through your authenticated browser session.
 
-## Project Structure
+## Install
 
+```bash
+opentabs plugin install ynab
 ```
-ynab/
-├── package.json          # Plugin metadata (name, opentabs field, dependencies)
-├── icon.svg              # Optional custom icon (square SVG, max 8KB)
-├── icon-inactive.svg     # Optional manual inactive icon override
-├── src/
-│   ├── index.ts          # Plugin class (extends OpenTabsPlugin)
-│   └── tools/            # One file per tool (using defineTool)
-│       └── example.ts
-└── dist/                 # Build output (generated)
-    ├── adapter.iife.js   # Bundled adapter injected into matching tabs
-    └── tools.json        # Tool schemas for MCP registration
-```
-
-## Configuration
-
-Plugin metadata is defined in `package.json` under the `opentabs` field:
-
-```json
-{
-  "name": "opentabs-plugin-ynab",
-  "main": "dist/adapter.iife.js",
-  "opentabs": {
-    "displayName": "YNAB",
-    "description": "OpenTabs plugin for YNAB (You Need A Budget)",
-    "urlPatterns": ["*://*.app.ynab.com/*"]
-  }
-}
-```
-
-- **`main`** — entry point for the bundled adapter IIFE
-- **`opentabs.displayName`** — human-readable name shown in the side panel
-- **`opentabs.description`** — short description of what the plugin does
-- **`opentabs.urlPatterns`** — Chrome match patterns for tabs where the adapter is injected
 
-## Custom Icons
+Or install globally via npm:
 
-By default, the side panel shows a colored letter avatar for your plugin. To use a custom icon, place an `icon.svg` file in the plugin root (next to `package.json`):
-
-```
-ynab/
-├── package.json
-├── icon.svg              ← custom icon (optional)
-├── icon-inactive.svg     ← manual inactive override (optional, requires icon.svg)
-├── src/
-│   └── ...
+```bash
+npm install -g @opentabs-dev/opentabs-plugin-ynab
 ```
 
-**How it works:**
+## Setup
 
-- `opentabs-plugin build` reads `icon.svg`, validates it, auto-generates a grayscale inactive variant, and embeds both in `dist/tools.json`
-- To override the auto-generated inactive icon, provide `icon-inactive.svg` (must use only grayscale colors)
-- If no `icon.svg` is provided, the letter avatar is used automatically
+1. Open [app.ynab.com](https://app.ynab.com) in Chrome and log in
+2. Open the OpenTabs side panel — the YNAB plugin should appear as **ready**
 
-**Icon requirements:**
+## Tools (15)
 
-- Square SVG with a `viewBox` attribute (e.g., `viewBox="0 0 32 32"`)
-- Maximum 8 KB file size
-- No embedded `<image>`, `<script>`, or event handler attributes (`onclick`, etc.)
-- Manual `icon-inactive.svg` must use only achromatic (grayscale) colors
+### Account (1)
 
-## Development
+| Tool | Description | Type |
+|---|---|---|
+| `get_current_user` | Get your YNAB user profile | Read |
 
-```bash
-npm install
-npm run build       # tsc && opentabs-plugin build
-npm run dev         # watch mode (tsc --watch + opentabs-plugin build --watch)
-npm run type-check  # tsc --noEmit
-npm run lint        # biome
-```
+### Plans (1)
 
-## Adding Tools
-
-Create a new file in `src/tools/` using `defineTool`:
-
-```ts
-import { z } from 'zod';
-import { defineTool } from '@opentabs-dev/plugin-sdk';
-
-export const myTool = defineTool({
-  name: 'my_tool',
-  displayName: 'My Tool',
-  description: 'What this tool does',
-  icon: 'wrench',
-  input: z.object({ /* ... */ }),
-  output: z.object({ /* ... */ }),
-  handle: async (params) => {
-    // Tool implementation runs in the browser tab context
-    return { /* ... */ };
-  },
-});
-```
+| Tool | Description | Type |
+|---|---|---|
+| `get_plan` | Get the active plan details | Read |
 
-Then register it in `src/index.ts` by adding it to the `tools` array.
+### Accounts (2)
 
-## Authentication
+| Tool | Description | Type |
+|---|---|---|
+| `list_accounts` | List all budget accounts | Read |
+| `get_account` | Get account details by ID | Read |
 
-Plugin tools run in the browser tab context, so they can read auth tokens directly from the page. The SDK provides utilities for the most common patterns:
+### Categories (2)
 
-```ts
-import { getLocalStorage, getCookie, getPageGlobal } from '@opentabs-dev/plugin-sdk';
+| Tool | Description | Type |
+|---|---|---|
+| `list_categories` | List budget categories with balances | Read |
+| `update_category_budget` | Set budgeted amount for a category | Write |
 
-// localStorage — most common
-const token = getLocalStorage('token');
+### Payees (1)
 
-// Cookies — session tokens, JWTs
-const session = getCookie('session_id');
+| Tool | Description | Type |
+|---|---|---|
+| `list_payees` | List all payees | Read |
 
-// Page globals — SPA boot data (e.g., window.__APP_STATE__)
-const appState = getPageGlobal('__APP_STATE__');
-```
+### Transactions (6)
 
-**Iframe fallback:** Some apps (e.g., Discord) delete `window.localStorage` after boot. `getLocalStorage` automatically tries a hidden same-origin iframe fallback before returning `null`, so you don't need to handle this case manually.
+| Tool | Description | Type |
+|---|---|---|
+| `list_transactions` | List budget transactions | Read |
+| `get_transaction` | Get transaction details by ID | Read |
+| `create_transaction` | Create a new transaction | Write |
+| `update_transaction` | Update a transaction | Write |
+| `delete_transaction` | Delete a transaction | Write |
+| `list_scheduled_transactions` | List scheduled/recurring transactions | Read |
 
-**SPA hydration:** Auth tokens may not be available immediately on page load. Implement polling in `isReady()` to wait until the app has hydrated before your tools run. See the comments in `src/index.ts` for an example polling pattern.
+### Months (2)
 
-## Shared Schemas
+| Tool | Description | Type |
+|---|---|---|
+| `list_months` | List budget months with summaries | Read |
+| `get_month` | Get budget details for a month | Read |
 
-When 3 or more tools share the same input or output shape, extract common Zod schemas into a shared file to avoid duplication:
+## How It Works
 
-```ts
-// src/schemas/channel.ts
-import { z } from 'zod';
+This plugin runs inside your YNAB tab through the [OpenTabs](https://opentabs.dev) Chrome extension. It uses your existing browser session — no API tokens or OAuth apps required. All operations happen as you, with your permissions.
 
-export const channelSchema = z.object({
-  id: z.string().describe('Channel ID'),
-  name: z.string().describe('Channel name'),
-});
-
-export type Channel = z.infer<typeof channelSchema>;
-```
-
-Then import and reuse in your tools:
-
-```ts
-// src/tools/list-channels.ts
-import { channelSchema } from '../schemas/channel.js';
-
-export const listChannels = defineTool({
-  name: 'list_channels',
-  displayName: 'List Channels',
-  description: 'List all available channels',
-  icon: 'list',
-  input: z.object({}),
-  output: z.object({ channels: z.array(channelSchema) }),
-  handle: async () => {
-    // ...
-    return { channels: [] };
-  },
-});
-```
+## License
 
-This keeps your tool schemas DRY and makes it easy to evolve shared types in one place.
+MIT

package/dist/adapter.iife.js

@@ -325,6 +325,8 @@
      * (e.g., 'https://github.com'), not a match pattern.
      */
     homepage;
+    /** Typed configuration schema — declares settings that users provide via config.json or the side panel. */
+    configSchema;
   };
 
   // src/ynab-api.ts
@@ -15092,7 +15094,7 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
   };
   var src_default = new YnabPlugin();
 
-  // dist/_adapter_entry_3f87a17d-2a09-4ee7-baaa-738823c57488.ts
+  // dist/_adapter_entry_971ef58c-806d-497f-bc65-07b3013a2267.ts
   if (!globalThis.__openTabs) {
     globalThis.__openTabs = {};
   } else {
@@ -15308,5 +15310,5 @@ Set the \`cycles\` parameter to \`"ref"\` to resolve cyclical schemas with defs.
     };
     delete src_default.onDeactivate;
   }
-})();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["ynab"]){var a=o.adapters["ynab"];a.__adapterHash="101cfca804e69874ea527a3c48691c32eb268ae40ff91e5d50f4b9fe277b4d62";if(a.tools&&Array.isArray(a.tools)){for(var i=0;i<a.tools.length;i++){Object.freeze(a.tools[i]);}Object.freeze(a.tools);}Object.freeze(a);Object.defineProperty(o.adapters,"ynab",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
+})();(function(){var o=(globalThis).__openTabs;if(o&&o.adapters&&o.adapters["ynab"]){var a=o.adapters["ynab"];a.__adapterHash="a9fd44be9fa96e7406c65699f3e22afa18f8378b7e406ad85eed3c11bd226ce3";if(a.tools&&Array.isArray(a.tools)){for(var i=0;i<a.tools.length;i++){Object.freeze(a.tools[i]);}Object.freeze(a.tools);}Object.freeze(a);Object.defineProperty(o.adapters,"ynab",{value:a,writable:false,configurable:false,enumerable:true});Object.defineProperty(o,"adapters",{value:o.adapters,writable:false,configurable:false});}})();
 //# sourceMappingURL=adapter.iife.js.map