pi-ynabro 2.0.0 → 2.2.0

package/README.md

@@ -28,4 +28,4 @@ pi install npm:pi-ynabro
 
 ## Requirements
 
-- `YNAB_TOKEN` environment variable must be set
+Run `ynabro_setup` once to complete interactive onboarding. The tool will prompt for a YNAB Personal Access Token (generate at https://app.ynab.com/settings/developer) and let you select a default plan. Both are stored securely in pi's `AuthStorage` (`~/.pi/agent/auth.json`).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-ynabro",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Pi extension that registers YNABro tools for YNAB integration",
   "type": "module",
   "main": "./src/index.ts",

package/skills/ynabro/prompts/ynabro.md

@@ -8,12 +8,29 @@ You are **YNABro**, a friendly and reliable YNAB assistant designed to help user
 
 ## Onboarding & Access
 
-Before performing any YNAB operations, check whether YNAB access has been set up:
+Before performing any YNAB operations, call `ynabro_onboarding_status` to check
+whether YNAB access is configured.
 
-1. A YNAB Personal Access Token must be available (via `YNAB_TOKEN` environment variable or stored in `.ynabro/config.json`).
-2. A default plan must be selected and saved.
+If `ready` is `false`, walk the user through setup:
 
-If either is missing, call the `setupYnab()` tool first. This tool will guide the user through creating a token (if needed) and selecting a default plan. Do not attempt to read or modify transactions until setup is complete.
+1. **Missing token:** Share the `tokenInstructions` field from the status response.
+   The token must never be entered into the chat.
+   - **pi:** Call `ynabro_setup` — it presents a native TUI input popup where the
+     user enters the token directly. It goes straight to pi's AuthStorage and
+     never appears in the conversation.
+   - **OpenClaw:** Instruct the user to add the token to `openclaw.json` or via
+     the OpenClaw settings UI, then ask them to confirm when done.
+
+2. **Missing plan:** Call `ynabro_setup` to list available plans. Help the user
+   pick one. On OpenClaw, follow up with `ynabro_save_default_plan`.
+
+3. **After onboarding completes:** If the user's original message was a functional
+   request (e.g., "show my pending transactions"), fulfill it immediately.
+   Do not make them repeat themselves.
+
+If a tool returns `{ "error": "onboarding_required" }` during a conversation,
+treat it the same as a failed status check — initiate onboarding, then retry
+the original operation.
 
 ## Core Capabilities
 - Help users view, update, and manage all aspects of their YNAB budget, including:

package/src/index.ts

@@ -1,7 +1,10 @@
 import type { ExtensionAPI } from "@earendil-works/pi-coding-agent";
+import { AuthStorage } from "@earendil-works/pi-coding-agent";
 import { Type } from "typebox";
+import type { OnboardingStatus, YnabroConfigAdapter } from "ynabro";
 import {
   approveTransaction,
+  checkOnboardingStatus,
   getPendingTransactions,
   getPlanInfo,
   getRecentTransactions,
@@ -11,18 +14,45 @@ import {
   YnabroClient,
 } from "ynabro";
 
-function getClient(): YnabroClient {
-  const token = process.env.YNAB_TOKEN;
-  if (!token) throw new Error("YNAB_TOKEN environment variable is not set");
+const authStorage = AuthStorage.create();
+
+const piConfigAdapter: YnabroConfigAdapter = {
+  async getDefaultPlanId(): Promise<string | undefined> {
+    const credential = authStorage.get("ynab-plan");
+    if (credential?.type === "api_key") {
+      return credential.key;
+    }
+    return undefined;
+  },
+  async setDefaultPlanId(planId: string): Promise<void> {
+    authStorage.set("ynab-plan", { type: "api_key", key: planId });
+  },
+  async hasToken(): Promise<boolean> {
+    return !!(await authStorage.getApiKey("ynab"));
+  },
+};
+
+async function getClient(): Promise<YnabroClient> {
+  const token = await authStorage.getApiKey("ynab");
+  if (!token) throw new Error("YNAB token not configured");
   return new YnabroClient(token);
 }
 
-const planIdSchema = Type.Object({
-  planId: Type.String({ description: "The ID of the YNAB plan" }),
-});
+async function getDefaultPlanId(): Promise<string> {
+  const planId = await piConfigAdapter.getDefaultPlanId();
+  if (!planId) throw new Error("No default plan configured");
+  return planId;
+}
+
+async function checkConfigured(): Promise<OnboardingStatus | null> {
+  const status = await checkOnboardingStatus(piConfigAdapter);
+  if (!status.ready) {
+    return status;
+  }
+  return null;
+}
 
 const approveSchema = Type.Object({
-  planId: Type.String({ description: "The ID of the YNAB plan" }),
   transactionId: Type.String({
     description: "The ID of the transaction to approve",
   }),
@@ -49,13 +79,49 @@ const updateSkillStateSchema = Type.Object({
 });
 
 export default function ynabroExtension(api: ExtensionAPI): void {
+  api.registerTool({
+    name: "ynabro_onboarding_status",
+    label: "Onboarding Status",
+    description:
+      "Check whether YNABro is fully configured. Returns ready status, any missing configuration, and token generation instructions.",
+    parameters: Type.Object({}),
+    async execute(_toolCallId, _params) {
+      const status = await checkOnboardingStatus(piConfigAdapter);
+      return {
+        content: [{ type: "text", text: JSON.stringify(status) }],
+        details: undefined,
+      };
+    },
+  });
+
   api.registerTool({
     name: "ynabro_get_pending_transactions",
     label: "Get Pending Transactions",
-    description: "Get all pending (uncategorized) transactions for a plan",
-    parameters: planIdSchema,
-    async execute(_toolCallId, params) {
-      const result = await getPendingTransactions(getClient(), params.planId);
+    description:
+      "Get all pending (uncategorized) transactions for the default plan",
+    parameters: Type.Object({}),
+    async execute(_toolCallId, _params) {
+      const onboardingError = await checkConfigured();
+      if (onboardingError) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({
+                error: "onboarding_required",
+                ...onboardingError,
+              }),
+            },
+          ],
+          details: undefined,
+        };
+      }
+
+      const [client, planId] = await Promise.all([
+        getClient(),
+        getDefaultPlanId(),
+      ]);
+      const result = await getPendingTransactions(client, planId);
       return {
         content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
         details: undefined,
@@ -66,10 +132,30 @@ export default function ynabroExtension(api: ExtensionAPI): void {
   api.registerTool({
     name: "ynabro_get_recent_transactions",
     label: "Get Recent Transactions",
-    description: "Get recent transactions for a plan",
-    parameters: planIdSchema,
-    async execute(_toolCallId, params) {
-      const result = await getRecentTransactions(getClient(), params.planId);
+    description: "Get recent transactions for the default plan",
+    parameters: Type.Object({}),
+    async execute(_toolCallId, _params) {
+      const onboardingError = await checkConfigured();
+      if (onboardingError) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({
+                error: "onboarding_required",
+                ...onboardingError,
+              }),
+            },
+          ],
+          details: undefined,
+        };
+      }
+
+      const [client, planId] = await Promise.all([
+        getClient(),
+        getDefaultPlanId(),
+      ]);
+      const result = await getRecentTransactions(client, planId);
       return {
         content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
         details: undefined,
@@ -80,14 +166,30 @@ export default function ynabroExtension(api: ExtensionAPI): void {
   api.registerTool({
     name: "ynabro_approve_transaction",
     label: "Approve Transaction",
-    description: "Approve a specific transaction",
+    description: "Approve a specific transaction in the default plan",
     parameters: approveSchema,
     async execute(_toolCallId, params) {
-      await approveTransaction(
+      const onboardingError = await checkConfigured();
+      if (onboardingError) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({
+                error: "onboarding_required",
+                ...onboardingError,
+              }),
+            },
+          ],
+          details: undefined,
+        };
+      }
+
+      const [client, planId] = await Promise.all([
         getClient(),
-        params.planId,
-        params.transactionId,
-      );
+        getDefaultPlanId(),
+      ]);
+      await approveTransaction(client, planId, params.transactionId);
       return {
         content: [{ type: "text", text: JSON.stringify({ success: true }) }],
         details: undefined,
@@ -98,10 +200,30 @@ export default function ynabroExtension(api: ExtensionAPI): void {
   api.registerTool({
     name: "ynabro_get_plan_info",
     label: "Get Plan Info",
-    description: "Get basic information about a plan",
-    parameters: planIdSchema,
-    async execute(_toolCallId, params) {
-      const result = await getPlanInfo(getClient(), params.planId);
+    description: "Get basic information about the default plan",
+    parameters: Type.Object({}),
+    async execute(_toolCallId, _params) {
+      const onboardingError = await checkConfigured();
+      if (onboardingError) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({
+                error: "onboarding_required",
+                ...onboardingError,
+              }),
+            },
+          ],
+          details: undefined,
+        };
+      }
+
+      const [client, planId] = await Promise.all([
+        getClient(),
+        getDefaultPlanId(),
+      ]);
+      const result = await getPlanInfo(client, planId);
       return {
         content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
         details: undefined,
@@ -113,12 +235,83 @@ export default function ynabroExtension(api: ExtensionAPI): void {
     name: "ynabro_setup",
     label: "Setup YNAB",
     description:
-      "Set up YNAB integration — checks for token and selects a default plan",
+      "Set up or reconfigure YNAB integration — stores API token and selects a default plan",
     parameters: Type.Object({}),
-    async execute() {
-      const result = await setupYnab();
+    async execute(_toolCallId, _params, _signal, _onUpdate, ctx) {
+      // Step 1: Token check
+      let token = await authStorage.getApiKey("ynab");
+      if (!token) {
+        const input = await ctx.ui.input(
+          "YNAB Personal Access Token",
+          "Paste your token from https://app.ynab.com/settings/developer",
+        );
+        if (!input) {
+          return {
+            content: [
+              {
+                type: "text",
+                text: JSON.stringify({
+                  error: "Setup cancelled — no token provided.",
+                }),
+              },
+            ],
+            details: undefined,
+          };
+        }
+        authStorage.set("ynab", { type: "api_key", key: input });
+        token = input;
+      }
+
+      // Step 2: Fetch plans
+      const client = new YnabroClient(token);
+      const plans = await client.getPlans();
+      if (plans.length === 0) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({
+                error: "No plans found in your YNAB account.",
+              }),
+            },
+          ],
+          details: undefined,
+        };
+      }
+
+      // Step 3: Plan selector
+      const planOptions = plans.map((p) => `${p.name} (${p.id})`);
+      const selected = await ctx.ui.select(
+        "Select your default YNAB plan",
+        planOptions,
+      );
+      if (!selected) {
+        return {
+          content: [
+            {
+              type: "text",
+              text: JSON.stringify({
+                error: "Setup cancelled — no plan selected.",
+              }),
+            },
+          ],
+          details: undefined,
+        };
+      }
+
+      // Step 4: Store and return
+      const selectedPlan = plans[planOptions.indexOf(selected)];
+      await setupYnab(client, plans, selectedPlan.id, piConfigAdapter);
       return {
-        content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+        content: [
+          {
+            type: "text",
+            text: JSON.stringify({
+              message: `Setup complete! Default plan set to: ${selectedPlan.name}`,
+              defaultPlanId: selectedPlan.id,
+            }),
+          },
+        ],
         details: undefined,
       };
     },