openclaw-ynabro 2.1.0 → 2.2.1

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: import("openclaw/plugin-sdk/plugin-entry").OpenClawPluginConfigSchema;
+    register: NonNullable<import("openclaw/plugin-sdk/plugin-entry").OpenClawPluginDefinition["register"]>;
+} & Pick<import("openclaw/plugin-sdk/plugin-entry").OpenClawPluginDefinition, "kind" | "reload" | "nodeHostCommands" | "securityAuditCollectors">;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;AA0DA,wBAwQG"}

package/dist/index.js

@@ -0,0 +1,267 @@
+import { Type } from "@sinclair/typebox";
+import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
+import { approveTransaction, checkOnboardingStatus, getPendingTransactions, getPlanInfo, getRecentTransactions, getSkillState, setupYnab, updateSkillState, YnabroClient, } from "ynabro";
+function params(raw) {
+    return raw;
+}
+function ok(text) {
+    return {
+        content: [{ type: "text", text }],
+        details: undefined,
+    };
+}
+const approveSchema = Type.Object({
+    transactionId: Type.String({
+        description: "The ID of the transaction to approve",
+    }),
+});
+const saveDefaultPlanSchema = Type.Object({
+    planId: Type.String({
+        description: "The ID of the YNAB plan to set as the default",
+    }),
+});
+const skillStateSchema = Type.Object({
+    skillSlug: Type.String({
+        description: "The slug identifier for the skill",
+    }),
+});
+const updateSkillStateSchema = Type.Object({
+    skillSlug: Type.String({
+        description: "The slug identifier for the skill",
+    }),
+    updates: Type.Object({}, {
+        additionalProperties: true,
+        description: "Partial state updates to merge (e.g. { memory: [...], auto_approve_enabled: true })",
+    }),
+});
+export default definePluginEntry({
+    id: "openclaw-ynabro",
+    name: "YNABro",
+    description: "YNAB budget management tools for OpenClaw agents",
+    register(api) {
+        let cachedPlanId;
+        const openClawAdapter = {
+            async getDefaultPlanId() {
+                if (cachedPlanId !== undefined)
+                    return cachedPlanId;
+                return api.pluginConfig
+                    ?.defaultPlanId;
+            },
+            async setDefaultPlanId(planId) {
+                cachedPlanId = planId;
+                await api.runtime.config.mutateConfigFile({
+                    afterWrite: { mode: "auto" },
+                    mutate: (draft) => {
+                        // Ensure the path exists before writing
+                        if (!draft.plugins) {
+                            draft.plugins = {
+                                entries: {},
+                            };
+                        }
+                        // TypeScript flow analysis requires explicit check after conditional assignment
+                        if (draft.plugins) {
+                            if (!draft.plugins.entries) {
+                                draft.plugins.entries = {};
+                            }
+                            const existing = draft.plugins.entries["openclaw-ynabro"] ?? {};
+                            const existingConfig = existing.config ?? {};
+                            existingConfig.defaultPlanId = planId;
+                            draft.plugins.entries["openclaw-ynabro"] = {
+                                ...existing,
+                                config: existingConfig,
+                            };
+                        }
+                    },
+                });
+            },
+            async hasToken() {
+                return !!api.pluginConfig?.token;
+            },
+        };
+        function getClient() {
+            const token = api.pluginConfig?.token;
+            if (!token) {
+                throw new Error("YNAB token not configured. " +
+                    "Set it via plugins.entries.openclaw-ynabro.config.token in openclaw.json.");
+            }
+            return new YnabroClient(token);
+        }
+        async function getDefaultPlanId() {
+            const planId = await openClawAdapter.getDefaultPlanId();
+            if (!planId) {
+                throw new Error("No default plan configured. Run ynabro_setup then ynabro_save_default_plan to complete onboarding.");
+            }
+            return planId;
+        }
+        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() {
+                const status = await checkOnboardingStatus(openClawAdapter);
+                return ok(JSON.stringify(status));
+            },
+        });
+        api.registerTool({
+            name: "ynabro_setup",
+            label: "Setup YNAB",
+            description: "Fetch available YNAB plans for onboarding. Returns a list of plans. " +
+                "After the user selects one, call ynabro_save_default_plan with the chosen plan ID.",
+            parameters: Type.Object({}),
+            async execute() {
+                const client = getClient();
+                const plans = await client.getPlans();
+                if (plans.length === 0) {
+                    return ok(JSON.stringify({ error: "No plans found in your YNAB account." }));
+                }
+                return ok(JSON.stringify({
+                    plans: plans.map((p) => ({ id: p.id, name: p.name })),
+                }));
+            },
+        });
+        api.registerTool({
+            name: "ynabro_save_default_plan",
+            label: "Save Default Plan",
+            description: "Save a YNAB plan as the default for all subsequent tool calls. " +
+                "Call ynabro_setup first to get the list of available plan IDs.",
+            parameters: saveDefaultPlanSchema,
+            async execute(_id, raw) {
+                try {
+                    const p = params(raw);
+                    const client = getClient();
+                    const plans = await client.getPlans();
+                    await setupYnab(client, plans, p.planId, openClawAdapter);
+                    const saved = plans.find((plan) => plan.id === p.planId);
+                    return ok(JSON.stringify({
+                        message: `Default plan set to: ${saved?.name ?? p.planId}`,
+                        defaultPlanId: p.planId,
+                    }));
+                }
+                catch (_error) {
+                    const status = await checkOnboardingStatus(openClawAdapter);
+                    return ok(JSON.stringify({
+                        error: "onboarding_required",
+                        ...status,
+                    }));
+                }
+            },
+        });
+        api.registerTool({
+            name: "ynabro_get_pending_transactions",
+            label: "Get Pending Transactions",
+            description: "Get all pending (uncategorized) transactions for a plan",
+            parameters: Type.Object({}),
+            async execute() {
+                try {
+                    const [client, planId] = await Promise.all([
+                        Promise.resolve(getClient()),
+                        getDefaultPlanId(),
+                    ]);
+                    const result = await getPendingTransactions(client, planId);
+                    return ok(JSON.stringify(result, null, 2));
+                }
+                catch (_error) {
+                    const status = await checkOnboardingStatus(openClawAdapter);
+                    return ok(JSON.stringify({
+                        error: "onboarding_required",
+                        ...status,
+                    }));
+                }
+            },
+        });
+        api.registerTool({
+            name: "ynabro_get_recent_transactions",
+            label: "Get Recent Transactions",
+            description: "Get recent transactions for a plan",
+            parameters: Type.Object({}),
+            async execute() {
+                try {
+                    const [client, planId] = await Promise.all([
+                        Promise.resolve(getClient()),
+                        getDefaultPlanId(),
+                    ]);
+                    const result = await getRecentTransactions(client, planId);
+                    return ok(JSON.stringify(result, null, 2));
+                }
+                catch (_error) {
+                    const status = await checkOnboardingStatus(openClawAdapter);
+                    return ok(JSON.stringify({
+                        error: "onboarding_required",
+                        ...status,
+                    }));
+                }
+            },
+        });
+        api.registerTool({
+            name: "ynabro_approve_transaction",
+            label: "Approve Transaction",
+            description: "Approve a specific transaction",
+            parameters: approveSchema,
+            async execute(_id, raw) {
+                try {
+                    const p = params(raw);
+                    const [client, planId] = await Promise.all([
+                        Promise.resolve(getClient()),
+                        getDefaultPlanId(),
+                    ]);
+                    await approveTransaction(client, planId, p.transactionId);
+                    return ok(JSON.stringify({ success: true }));
+                }
+                catch (_error) {
+                    const status = await checkOnboardingStatus(openClawAdapter);
+                    return ok(JSON.stringify({
+                        error: "onboarding_required",
+                        ...status,
+                    }));
+                }
+            },
+        });
+        api.registerTool({
+            name: "ynabro_get_plan_info",
+            label: "Get Plan Info",
+            description: "Get basic information about a plan",
+            parameters: Type.Object({}),
+            async execute() {
+                try {
+                    const [client, planId] = await Promise.all([
+                        Promise.resolve(getClient()),
+                        getDefaultPlanId(),
+                    ]);
+                    const result = await getPlanInfo(client, planId);
+                    return ok(JSON.stringify(result, null, 2));
+                }
+                catch (_error) {
+                    const status = await checkOnboardingStatus(openClawAdapter);
+                    return ok(JSON.stringify({
+                        error: "onboarding_required",
+                        ...status,
+                    }));
+                }
+            },
+        });
+        api.registerTool({
+            name: "ynabro_get_skill_state",
+            label: "Get Skill State",
+            description: "Get the current state for a skill, including memory and auto_approve_enabled flag",
+            parameters: skillStateSchema,
+            async execute(_id, raw) {
+                const p = params(raw);
+                const result = await getSkillState(p.skillSlug);
+                return ok(JSON.stringify(result, null, 2));
+            },
+        });
+        api.registerTool({
+            name: "ynabro_update_skill_state",
+            label: "Update Skill State",
+            description: "Update the state for a skill — merge partial updates into existing state",
+            parameters: updateSkillStateSchema,
+            async execute(_id, raw) {
+                const p = params(raw);
+                const result = await updateSkillState(p.skillSlug, p.updates);
+                return ok(JSON.stringify(result, null, 2));
+            },
+        });
+    },
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAErE,OAAO,EACL,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,EACtB,WAAW,EACX,qBAAqB,EACrB,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,YAAY,GACb,MAAM,QAAQ,CAAC;AAEhB,SAAS,MAAM,CAAC,GAAY;IAC1B,OAAO,GAA8B,CAAC;AACxC,CAAC;AAED,SAAS,EAAE,CAAC,IAAY;IACtB,OAAO;QACL,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAe,EAAE,IAAI,EAAE,CAAC;QAC1C,OAAO,EAAE,SAAS;KACnB,CAAC;AACJ,CAAC;AAED,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC;IAChC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC;QACzB,WAAW,EAAE,sCAAsC;KACpD,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,qBAAqB,GAAG,IAAI,CAAC,MAAM,CAAC;IACxC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,WAAW,EAAE,+CAA+C;KAC7D,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC;IACnC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;QACrB,WAAW,EAAE,mCAAmC;KACjD,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,sBAAsB,GAAG,IAAI,CAAC,MAAM,CAAC;IACzC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC;QACrB,WAAW,EAAE,mCAAmC;KACjD,CAAC;IACF,OAAO,EAAE,IAAI,CAAC,MAAM,CAClB,EAAE,EACF;QACE,oBAAoB,EAAE,IAAI;QAC1B,WAAW,EACT,qFAAqF;KACxF,CACF;CACF,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC;IAC/B,EAAE,EAAE,iBAAiB;IACrB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,kDAAkD;IAC/D,QAAQ,CAAC,GAAG;QACV,IAAI,YAAgC,CAAC;QAErC,MAAM,eAAe,GAAwB;YAC3C,KAAK,CAAC,gBAAgB;gBACpB,IAAI,YAAY,KAAK,SAAS;oBAAE,OAAO,YAAY,CAAC;gBACpD,OAAQ,GAAG,CAAC,YAAuD;oBACjE,EAAE,aAAa,CAAC;YACpB,CAAC;YACD,KAAK,CAAC,gBAAgB,CAAC,MAAc;gBACnC,YAAY,GAAG,MAAM,CAAC;gBACtB,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC;oBACxC,UAAU,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;oBAC5B,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;wBAChB,wCAAwC;wBACxC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;4BAClB,KAA+B,CAAC,OAAO,GAAG;gCACzC,OAAO,EAAE,EAAE;6BACD,CAAC;wBACf,CAAC;wBACD,gFAAgF;wBAChF,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;4BAClB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;gCAC3B,KAAK,CAAC,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;4BAC7B,CAAC;4BACD,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;4BAChE,MAAM,cAAc,GACjB,QAAQ,CAAC,MAA8C,IAAI,EAAE,CAAC;4BACjE,cAAc,CAAC,aAAa,GAAG,MAAM,CAAC;4BACtC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG;gCACzC,GAAG,QAAQ;gCACX,MAAM,EAAE,cAAc;6BACvB,CAAC;wBACJ,CAAC;oBACH,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;YACD,KAAK,CAAC,QAAQ;gBACZ,OAAO,CAAC,CAAE,GAAG,CAAC,YAA+C,EAAE,KAAK,CAAC;YACvE,CAAC;SACF,CAAC;QAEF,SAAS,SAAS;YAChB,MAAM,KAAK,GAAI,GAAG,CAAC,YAA+C,EAAE,KAAK,CAAC;YAC1E,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CACb,6BAA6B;oBAC3B,2EAA2E,CAC9E,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;QACjC,CAAC;QAED,KAAK,UAAU,gBAAgB;YAC7B,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC,gBAAgB,EAAE,CAAC;YACxD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;YACJ,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,0BAA0B;YAChC,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EACT,+HAA+H;YACjI,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO;gBACX,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,CAAC;gBAC5D,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;YACpC,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,cAAc;YACpB,KAAK,EAAE,YAAY;YACnB,WAAW,EACT,sEAAsE;gBACtE,oFAAoF;YACtF,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO;gBACX,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACtC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACvB,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,sCAAsC,EAAE,CAAC,CAClE,CAAC;gBACJ,CAAC;gBACD,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;oBACb,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;iBACtD,CAAC,CACH,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,0BAA0B;YAChC,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EACT,iEAAiE;gBACjE,gEAAgE;YAClE,UAAU,EAAE,qBAAqB;YACjC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG;gBACpB,IAAI,CAAC;oBACH,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;oBACtB,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;oBAC3B,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,QAAQ,EAAE,CAAC;oBACtC,MAAM,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,MAAgB,EAAE,eAAe,CAAC,CAAC;oBACpE,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;oBACzD,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;wBACb,OAAO,EAAE,wBAAwB,KAAK,EAAE,IAAI,IAAI,CAAC,CAAC,MAAM,EAAE;wBAC1D,aAAa,EAAE,CAAC,CAAC,MAAM;qBACxB,CAAC,CACH,CAAC;gBACJ,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,CAAC;oBAC5D,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;wBACb,KAAK,EAAE,qBAAqB;wBAC5B,GAAG,MAAM;qBACV,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,iCAAiC;YACvC,KAAK,EAAE,0BAA0B;YACjC,WAAW,EAAE,yDAAyD;YACtE,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO;gBACX,IAAI,CAAC;oBACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;wBACzC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC5B,gBAAgB,EAAE;qBACnB,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBAC5D,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,CAAC;oBAC5D,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;wBACb,KAAK,EAAE,qBAAqB;wBAC5B,GAAG,MAAM;qBACV,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,gCAAgC;YACtC,KAAK,EAAE,yBAAyB;YAChC,WAAW,EAAE,oCAAoC;YACjD,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO;gBACX,IAAI,CAAC;oBACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;wBACzC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC5B,gBAAgB,EAAE;qBACnB,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBAC3D,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,CAAC;oBAC5D,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;wBACb,KAAK,EAAE,qBAAqB;wBAC5B,GAAG,MAAM;qBACV,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,4BAA4B;YAClC,KAAK,EAAE,qBAAqB;YAC5B,WAAW,EAAE,gCAAgC;YAC7C,UAAU,EAAE,aAAa;YACzB,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG;gBACpB,IAAI,CAAC;oBACH,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;oBACtB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;wBACzC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC5B,gBAAgB,EAAE;qBACnB,CAAC,CAAC;oBACH,MAAM,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,aAAuB,CAAC,CAAC;oBACpE,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC/C,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,CAAC;oBAC5D,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;wBACb,KAAK,EAAE,qBAAqB;wBAC5B,GAAG,MAAM;qBACV,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,sBAAsB;YAC5B,KAAK,EAAE,eAAe;YACtB,WAAW,EAAE,oCAAoC;YACjD,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,OAAO;gBACX,IAAI,CAAC;oBACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;wBACzC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;wBAC5B,gBAAgB,EAAE;qBACnB,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;oBACjD,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC7C,CAAC;gBAAC,OAAO,MAAM,EAAE,CAAC;oBAChB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,eAAe,CAAC,CAAC;oBAC5D,OAAO,EAAE,CACP,IAAI,CAAC,SAAS,CAAC;wBACb,KAAK,EAAE,qBAAqB;wBAC5B,GAAG,MAAM;qBACV,CAAC,CACH,CAAC;gBACJ,CAAC;YACH,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,wBAAwB;YAC9B,KAAK,EAAE,iBAAiB;YACxB,WAAW,EACT,mFAAmF;YACrF,UAAU,EAAE,gBAAgB;YAC5B,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG;gBACpB,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,CAAC,CAAC,SAAmB,CAAC,CAAC;gBAC1D,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC7C,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,YAAY,CAAC;YACf,IAAI,EAAE,2BAA2B;YACjC,KAAK,EAAE,oBAAoB;YAC3B,WAAW,EACT,0EAA0E;YAC5E,UAAU,EAAE,sBAAsB;YAClC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG;gBACpB,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBACtB,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC,CAAC,CAAC,SAAmB,EACrB,CAAC,CAAC,OAAiB,CACpB,CAAC;gBACF,OAAO,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC7C,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC"}

package/openclaw.plugin.json

@@ -35,6 +35,7 @@
   },
   "contracts": {
     "tools": [
+      "ynabro_onboarding_status",
       "ynabro_setup",
       "ynabro_save_default_plan",
       "ynabro_get_pending_transactions",

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "openclaw-ynabro",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "OpenClaw plugin that registers YNABro tools for YNAB integration",
   "type": "module",
-  "main": "./src/index.ts",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
   "files": [
+    "dist",
     "src",
     "openclaw.plugin.json",
     "full_logo.png",
@@ -18,8 +25,8 @@
     "directory": "packages/openclaw-ynabro"
   },
   "openclaw": {
-    "extensions": [
-      "./src/index.ts"
+    "hooks": [
+      "./dist/index.js"
     ],
     "compat": {
       "pluginApi": ">=2026.3.24-beta.2",
@@ -40,6 +47,7 @@
     "typescript": "^6.0.3"
   },
   "scripts": {
+    "build": "tsc -p tsconfig.build.json",
     "typecheck": "tsc --noEmit"
   }
 }

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. In OpenClaw, the preferred storage location is `plugins.entries.openclaw-ynabro.config.token` in `openclaw.json` (surfaced as a sensitive field in the settings UI). The `YNAB_TOKEN` environment variable is also accepted as a fallback.
-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

@@ -3,6 +3,7 @@ import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
 import type { YnabroConfigAdapter } from "ynabro";
 import {
   approveTransaction,
+  checkOnboardingStatus,
   getPendingTransactions,
   getPlanInfo,
   getRecentTransactions,
@@ -96,6 +97,9 @@ export default definePluginEntry({
           },
         });
       },
+      async hasToken(): Promise<boolean> {
+        return !!(api.pluginConfig as { token?: string } | undefined)?.token;
+      },
     };
 
     function getClient(): YnabroClient {
@@ -119,6 +123,18 @@ export default definePluginEntry({
       return planId;
     }
 
+    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() {
+        const status = await checkOnboardingStatus(openClawAdapter);
+        return ok(JSON.stringify(status));
+      },
+    });
+
     api.registerTool({
       name: "ynabro_setup",
       label: "Setup YNAB",
@@ -150,17 +166,27 @@ export default definePluginEntry({
         "Call ynabro_setup first to get the list of available plan IDs.",
       parameters: saveDefaultPlanSchema,
       async execute(_id, raw) {
-        const p = params(raw);
-        const client = getClient();
-        const plans = await client.getPlans();
-        await setupYnab(client, plans, p.planId as string, openClawAdapter);
-        const saved = plans.find((plan) => plan.id === p.planId);
-        return ok(
-          JSON.stringify({
-            message: `Default plan set to: ${saved?.name ?? p.planId}`,
-            defaultPlanId: p.planId,
-          }),
-        );
+        try {
+          const p = params(raw);
+          const client = getClient();
+          const plans = await client.getPlans();
+          await setupYnab(client, plans, p.planId as string, openClawAdapter);
+          const saved = plans.find((plan) => plan.id === p.planId);
+          return ok(
+            JSON.stringify({
+              message: `Default plan set to: ${saved?.name ?? p.planId}`,
+              defaultPlanId: p.planId,
+            }),
+          );
+        } catch (_error) {
+          const status = await checkOnboardingStatus(openClawAdapter);
+          return ok(
+            JSON.stringify({
+              error: "onboarding_required",
+              ...status,
+            }),
+          );
+        }
       },
     });
 
@@ -170,12 +196,22 @@ export default definePluginEntry({
       description: "Get all pending (uncategorized) transactions for a plan",
       parameters: Type.Object({}),
       async execute() {
-        const [client, planId] = await Promise.all([
-          Promise.resolve(getClient()),
-          getDefaultPlanId(),
-        ]);
-        const result = await getPendingTransactions(client, planId);
-        return ok(JSON.stringify(result, null, 2));
+        try {
+          const [client, planId] = await Promise.all([
+            Promise.resolve(getClient()),
+            getDefaultPlanId(),
+          ]);
+          const result = await getPendingTransactions(client, planId);
+          return ok(JSON.stringify(result, null, 2));
+        } catch (_error) {
+          const status = await checkOnboardingStatus(openClawAdapter);
+          return ok(
+            JSON.stringify({
+              error: "onboarding_required",
+              ...status,
+            }),
+          );
+        }
       },
     });
 
@@ -185,12 +221,22 @@ export default definePluginEntry({
       description: "Get recent transactions for a plan",
       parameters: Type.Object({}),
       async execute() {
-        const [client, planId] = await Promise.all([
-          Promise.resolve(getClient()),
-          getDefaultPlanId(),
-        ]);
-        const result = await getRecentTransactions(client, planId);
-        return ok(JSON.stringify(result, null, 2));
+        try {
+          const [client, planId] = await Promise.all([
+            Promise.resolve(getClient()),
+            getDefaultPlanId(),
+          ]);
+          const result = await getRecentTransactions(client, planId);
+          return ok(JSON.stringify(result, null, 2));
+        } catch (_error) {
+          const status = await checkOnboardingStatus(openClawAdapter);
+          return ok(
+            JSON.stringify({
+              error: "onboarding_required",
+              ...status,
+            }),
+          );
+        }
       },
     });
 
@@ -200,13 +246,23 @@ export default definePluginEntry({
       description: "Approve a specific transaction",
       parameters: approveSchema,
       async execute(_id, raw) {
-        const p = params(raw);
-        const [client, planId] = await Promise.all([
-          Promise.resolve(getClient()),
-          getDefaultPlanId(),
-        ]);
-        await approveTransaction(client, planId, p.transactionId as string);
-        return ok(JSON.stringify({ success: true }));
+        try {
+          const p = params(raw);
+          const [client, planId] = await Promise.all([
+            Promise.resolve(getClient()),
+            getDefaultPlanId(),
+          ]);
+          await approveTransaction(client, planId, p.transactionId as string);
+          return ok(JSON.stringify({ success: true }));
+        } catch (_error) {
+          const status = await checkOnboardingStatus(openClawAdapter);
+          return ok(
+            JSON.stringify({
+              error: "onboarding_required",
+              ...status,
+            }),
+          );
+        }
       },
     });
 
@@ -216,12 +272,22 @@ export default definePluginEntry({
       description: "Get basic information about a plan",
       parameters: Type.Object({}),
       async execute() {
-        const [client, planId] = await Promise.all([
-          Promise.resolve(getClient()),
-          getDefaultPlanId(),
-        ]);
-        const result = await getPlanInfo(client, planId);
-        return ok(JSON.stringify(result, null, 2));
+        try {
+          const [client, planId] = await Promise.all([
+            Promise.resolve(getClient()),
+            getDefaultPlanId(),
+          ]);
+          const result = await getPlanInfo(client, planId);
+          return ok(JSON.stringify(result, null, 2));
+        } catch (_error) {
+          const status = await checkOnboardingStatus(openClawAdapter);
+          return ok(
+            JSON.stringify({
+              error: "onboarding_required",
+              ...status,
+            }),
+          );
+        }
       },
     });