@troykelly/openclaw-projects 0.0.11 → 0.0.12

package/dist/utils/token-budget.js

@@ -0,0 +1,142 @@
+/**
+ * Token budget tracking utility for inbound message processing.
+ *
+ * Provides configurable daily and monthly caps on token expenditure
+ * to protect against cost overruns from bulk inbound messages.
+ *
+ * Part of Issue #1225 — rate limiting and spam protection.
+ */
+/** Default configuration (budget disabled) */
+export const DEFAULT_TOKEN_BUDGET_CONFIG = {
+    enabled: false,
+};
+/**
+ * Create a token budget tracker.
+ *
+ * Tracks daily and monthly token usage with automatic reset at
+ * UTC midnight (daily) and UTC month boundary (monthly).
+ *
+ * @param config - Token budget configuration
+ * @returns TokenBudget instance
+ */
+export function createTokenBudget(config = DEFAULT_TOKEN_BUDGET_CONFIG) {
+    let dailyUsed = 0;
+    let monthlyUsed = 0;
+    let currentDay = getCurrentDay();
+    let currentMonth = getCurrentMonth();
+    /**
+     * Get the current UTC day as YYYY-MM-DD string.
+     */
+    function getCurrentDay() {
+        return new Date().toISOString().slice(0, 10);
+    }
+    /**
+     * Get the current UTC month as YYYY-MM string.
+     */
+    function getCurrentMonth() {
+        return new Date().toISOString().slice(0, 7);
+    }
+    /**
+     * Reset counters if the day or month has changed.
+     */
+    function maybeReset() {
+        const today = getCurrentDay();
+        const thisMonth = getCurrentMonth();
+        if (today !== currentDay) {
+            dailyUsed = 0;
+            currentDay = today;
+        }
+        if (thisMonth !== currentMonth) {
+            monthlyUsed = 0;
+            currentMonth = thisMonth;
+        }
+    }
+    return {
+        check(tokens) {
+            if (!config.enabled) {
+                return { allowed: true, reason: null };
+            }
+            maybeReset();
+            // Check daily limit
+            if (config.dailyTokenLimit !== undefined) {
+                if (dailyUsed + tokens > config.dailyTokenLimit) {
+                    return {
+                        allowed: false,
+                        reason: `daily token budget exceeded (${dailyUsed}/${config.dailyTokenLimit} used, requested ${tokens})`,
+                        remainingDaily: Math.max(0, config.dailyTokenLimit - dailyUsed),
+                        remainingMonthly: config.monthlyTokenLimit !== undefined ? Math.max(0, config.monthlyTokenLimit - monthlyUsed) : undefined,
+                    };
+                }
+            }
+            // Check monthly limit
+            if (config.monthlyTokenLimit !== undefined) {
+                if (monthlyUsed + tokens > config.monthlyTokenLimit) {
+                    return {
+                        allowed: false,
+                        reason: `monthly token budget exceeded (${monthlyUsed}/${config.monthlyTokenLimit} used, requested ${tokens})`,
+                        remainingDaily: config.dailyTokenLimit !== undefined ? Math.max(0, config.dailyTokenLimit - dailyUsed) : undefined,
+                        remainingMonthly: Math.max(0, config.monthlyTokenLimit - monthlyUsed),
+                    };
+                }
+            }
+            return {
+                allowed: true,
+                reason: null,
+                remainingDaily: config.dailyTokenLimit !== undefined ? config.dailyTokenLimit - dailyUsed : undefined,
+                remainingMonthly: config.monthlyTokenLimit !== undefined ? config.monthlyTokenLimit - monthlyUsed : undefined,
+            };
+        },
+        record(tokens) {
+            maybeReset();
+            dailyUsed += tokens;
+            monthlyUsed += tokens;
+        },
+        tryConsume(tokens) {
+            if (!config.enabled) {
+                return { allowed: true, reason: null };
+            }
+            maybeReset();
+            // Check daily limit
+            if (config.dailyTokenLimit !== undefined) {
+                if (dailyUsed + tokens > config.dailyTokenLimit) {
+                    return {
+                        allowed: false,
+                        reason: `daily token budget exceeded (${dailyUsed}/${config.dailyTokenLimit} used, requested ${tokens})`,
+                        remainingDaily: Math.max(0, config.dailyTokenLimit - dailyUsed),
+                        remainingMonthly: config.monthlyTokenLimit !== undefined ? Math.max(0, config.monthlyTokenLimit - monthlyUsed) : undefined,
+                    };
+                }
+            }
+            // Check monthly limit
+            if (config.monthlyTokenLimit !== undefined) {
+                if (monthlyUsed + tokens > config.monthlyTokenLimit) {
+                    return {
+                        allowed: false,
+                        reason: `monthly token budget exceeded (${monthlyUsed}/${config.monthlyTokenLimit} used, requested ${tokens})`,
+                        remainingDaily: config.dailyTokenLimit !== undefined ? Math.max(0, config.dailyTokenLimit - dailyUsed) : undefined,
+                        remainingMonthly: Math.max(0, config.monthlyTokenLimit - monthlyUsed),
+                    };
+                }
+            }
+            // Atomically record usage since check passed
+            dailyUsed += tokens;
+            monthlyUsed += tokens;
+            return {
+                allowed: true,
+                reason: null,
+                remainingDaily: config.dailyTokenLimit !== undefined ? config.dailyTokenLimit - dailyUsed : undefined,
+                remainingMonthly: config.monthlyTokenLimit !== undefined ? config.monthlyTokenLimit - monthlyUsed : undefined,
+            };
+        },
+        getStats() {
+            maybeReset();
+            return {
+                dailyUsed,
+                monthlyUsed,
+                dailyLimit: config.dailyTokenLimit,
+                monthlyLimit: config.monthlyTokenLimit,
+            };
+        },
+    };
+}
+//# sourceMappingURL=token-budget.js.map

package/dist/utils/token-budget.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-budget.js","sourceRoot":"","sources":["../../src/utils/token-budget.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAqDH,8CAA8C;AAC9C,MAAM,CAAC,MAAM,2BAA2B,GAAsB;IAC5D,OAAO,EAAE,KAAK;CACf,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,iBAAiB,CAAC,SAA4B,2BAA2B;IACvF,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,UAAU,GAAG,aAAa,EAAE,CAAC;IACjC,IAAI,YAAY,GAAG,eAAe,EAAE,CAAC;IAErC;;OAEG;IACH,SAAS,aAAa;QACpB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,SAAS,eAAe;QACtB,OAAO,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,SAAS,UAAU;QACjB,MAAM,KAAK,GAAG,aAAa,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,eAAe,EAAE,CAAC;QAEpC,IAAI,KAAK,KAAK,UAAU,EAAE,CAAC;YACzB,SAAS,GAAG,CAAC,CAAC;YACd,UAAU,GAAG,KAAK,CAAC;QACrB,CAAC;QAED,IAAI,SAAS,KAAK,YAAY,EAAE,CAAC;YAC/B,WAAW,GAAG,CAAC,CAAC;YAChB,YAAY,GAAG,SAAS,CAAC;QAC3B,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK,CAAC,MAAc;YAClB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YACzC,CAAC;YAED,UAAU,EAAE,CAAC;YAEb,oBAAoB;YACpB,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;gBACzC,IAAI,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;oBAChD,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,MAAM,EAAE,gCAAgC,SAAS,IAAI,MAAM,CAAC,eAAe,oBAAoB,MAAM,GAAG;wBACxG,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC;wBAC/D,gBAAgB,EAAE,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;qBAC3H,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,sBAAsB;YACtB,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAC3C,IAAI,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;oBACpD,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,MAAM,EAAE,kCAAkC,WAAW,IAAI,MAAM,CAAC,iBAAiB,oBAAoB,MAAM,GAAG;wBAC9G,cAAc,EAAE,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;wBAClH,gBAAgB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC;qBACtE,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,IAAI;gBACZ,cAAc,EAAE,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrG,gBAAgB,EAAE,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC,SAAS;aAC9G,CAAC;QACJ,CAAC;QAED,MAAM,CAAC,MAAc;YACnB,UAAU,EAAE,CAAC;YACb,SAAS,IAAI,MAAM,CAAC;YACpB,WAAW,IAAI,MAAM,CAAC;QACxB,CAAC;QAED,UAAU,CAAC,MAAc;YACvB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YACzC,CAAC;YAED,UAAU,EAAE,CAAC;YAEb,oBAAoB;YACpB,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;gBACzC,IAAI,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;oBAChD,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,MAAM,EAAE,gCAAgC,SAAS,IAAI,MAAM,CAAC,eAAe,oBAAoB,MAAM,GAAG;wBACxG,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC;wBAC/D,gBAAgB,EAAE,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS;qBAC3H,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,sBAAsB;YACtB,IAAI,MAAM,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;gBAC3C,IAAI,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC;oBACpD,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,MAAM,EAAE,kCAAkC,WAAW,IAAI,MAAM,CAAC,iBAAiB,oBAAoB,MAAM,GAAG;wBAC9G,cAAc,EAAE,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;wBAClH,gBAAgB,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC;qBACtE,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,6CAA6C;YAC7C,SAAS,IAAI,MAAM,CAAC;YACpB,WAAW,IAAI,MAAM,CAAC;YAEtB,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,IAAI;gBACZ,cAAc,EAAE,MAAM,CAAC,eAAe,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS;gBACrG,gBAAgB,EAAE,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,iBAAiB,GAAG,WAAW,CAAC,CAAC,CAAC,SAAS;aAC9G,CAAC;QACJ,CAAC;QAED,QAAQ;YACN,UAAU,EAAE,CAAC;YACb,OAAO;gBACL,SAAS;gBACT,WAAW;gBACX,UAAU,EAAE,MAAM,CAAC,eAAe;gBAClC,YAAY,EAAE,MAAM,CAAC,iBAAiB;aACvC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC"}

package/openclaw.plugin.json

@@ -1,6 +1,6 @@
 {
   "id": "openclaw-projects",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "name": "OpenClaw Projects Plugin",
   "description": "Memory provider with projects, todos, and contacts integration",
   "kind": "memory",
@@ -74,7 +74,7 @@
       },
       "postmarkFromEmail": {
         "type": "string",
-        "format": "email",
+        "pattern": "^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$",
         "description": "Postmark From Email address (direct value)"
       },
       "postmarkFromEmailFile": {
@@ -143,7 +143,7 @@
       },
       "baseUrl": {
         "type": "string",
-        "format": "uri",
+        "pattern": "^https?://",
         "description": "Base URL for web app (used for generating note/notebook URLs)"
       }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@troykelly/openclaw-projects",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "OpenClaw memory plugin with projects, todos, and contacts integration",
   "type": "module",
   "main": "dist/index.js",